Direct Debits

POST /pay/v1/directdebits

Headers

Content-Type string
Content type.

Authorization string
Access token generated from create token request.

Attributes

payment_intent string
Payment intent token.

given_name string
User’s given name or first name.

family_name string
User’s family name or Surname.

company_name string (optional)
User’s company name. It’s required only if user’s given name and family name are not present.

email string
User’s email address.

country_code string
ISO country code. Default value GB.

customer_address string (optional)
User’s address details.

customer_postcode string (optional)
User’s postcode.

account_holder_name string
User’s bank account name.

branch_code string
User’s bank short code.

account_number integer
User’s bank account number.

merchant_data json (optional)
The merchant can add custom key value pairs in JSON format, for example:

{
  "my_order_id": 123,
  "fancy_note": "Order complete",
  "card_discount": false
}

Request

POST https://secure.blinkpayment.co.uk/api/pay/v1/directdebits HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "payment_intent": "pi_Swhc84aSLtUGppvPARX...",
    "given_name": "test",
    "family_name": "test",
    "email": "random@gmail...",
    "country_code": "GB"
    "customer_address": "12/B.....",
    "customer_postcode": "12....",
    "account_holder_name": "test.....",
    "branch_code": 20....,
    "account_number": "579....",
    "merchant_data": "{\"my_order_id\": \"dd-12345678\"}",
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "url": "https://api-demo-php.blinkpayment.co.uk/return?transaction_id=BL-002A12345&status=Pending%2BSubmission&note=Pending%2BSubmission&merchant_data=%257B%2522order_id%2522%253A%2522dd-12345678%2522%257D"
}