Bank Accounts

🚧

In development

A legacy version of the Merchant Boarding API is live currently, however a new enhanced version is in development. For new consumers, it is highly recommended to use the new version of the API expected in Q3 2022.

Please note the API specification may change while it's in development

Bank Accounts Resource

Bank Accounts are used in the Businesses and Stores resources. You can set a bank account at a business level and all stores connected will use that bank account. However, if you want one store to be different, you will have to add a bank account at every store level.

Mandatory Fields

AttributeTypeDescriptionExample / Enums
accountHolderNamestringThe account holder name for this bank account typeJohn Smith
bankAccountCurrencystringThe account currency for this bank account typeGBP

Conditional Fields

AttributeTypeDescriptionExample / Enums
accountNumberstringThe account number for this bank account type. Either Account Number & Sort Code, OR IBAN & swift/bic must be provided23454567
sortCodestringThe sort code for this bank account type. Either Account Number & Sort Code, OR IBAN & swift/bic must be provided123456
ibanstringThe IBAN for this bank account type. Either Account Number & Sort Code, OR IBAN & swift/bic must be providedDE75512108001245126199
swiftstringThe Swift/BIC for this bank account type. Either Account Number & Sort Code, OR IBAN & swift/bic must be providedAARBDE5WDOM
daysCreditintegerThe funding delay days for the credit account to be applied to the transaction within this bank account type1
daysDebitintegerThe funding delay days for the debit account to be applied to the transaction within this bank account type1
houseNamestringThe house name of the address for the contact. Either houseName or houseNumber must be sentHouse
houseNumberstringThe house number of the address for the contact. Either houseName or houseNumber must be sent10

Optional Fields

AttributeTypeDescriptionExample / Enums
bankNamestringThe name of the bank where the account is held for the details given for this bank account typeLloyds Bank
streetLine1stringThe first line of the street address for the contactSomething Street
streetLine2stringThe second line of the street address for the contactSomething Street
streetLine3stringThe third line of the street address for the contactSomething Street
citystringThe city of the address for the contact Sheffield
zipCodestringThe zip/postal code of the address for the contactTW2 7LD
countrystringThe country code of the address for the contactGBR ISO 3166 alpha-3 country code
creditorIdstringA Creditor Identifier is a unique reference for organisations collecting payments by SEPA Direct Debit. It must be included in each SEPA Direct Debit collection and allows the payer and the payer's bank to: verify each SEPA Direct Debit, request refunds or make complaints.DE02ZZZ00123456789

Examples

Example Request

{
     "accountHolderName": "John Smith",
     "bankAccountCurrency": "GBP",
     "accountNumber": "12341234",
     "sortCode": "00-00-00",
     "iban": "DE1150040000060005342",
     "swift": "BUKBGB22",
     "daysCredit": 0,
     "daysDebit": 0,
     "bankName": "Barclays",
     "creditorId": "DE02ZZZ00123456789",
     "bankAddress": {
          "buildingNumber": "10",
          "buildingName": "House",
          "line1": "Something Street",
          "line2": "Something Street",
          "line3": "Something Street",
          "city": "Sheffield",
          "postalCode": "TW2 7LD",
          "country": "GBR"
     }
}

Example Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountHolderName": "John Smith",
  "bankAccountCurrency": "GBP",
  "accountNumber": "12341234",
  "sortCode": "00-00-00",
  "iban": "DE1150040000060005342",
  "swift": "BUKBGB22",
  "daysCredit": 0,
  "daysDebit": 0,
  "bankName": "Barclays",
  "creditorId": "DE02ZZZ00123456789",
  "bankAddress": {
    "buildingNumber": "10",
    "buildingName": "House",
    "line1": "Something Street",
    "line2": "Something Street",
    "line3": "Something Street",
    "city": "Sheffield",
    "postalCode": "TW2 7LD",
    "country": "GBR"
  }
}

Did this page help you?