v1

latestOpenAPI 3.1.02026-07-26290133.2 KB

List Payment Accounts

Get a list of all payment accounts.

get/bank-accounts

Query parameters

internalAccountIdstring

internalAccountId of the payment account.<br>e.g. EUR1813871080347

internalAccountIdsstring[]

List of internalAccountId's of the payment accounts.

currencystring

Three-letter ISO 4217 currency code of the payment account. e.g. EUR

statusstring

PENDING, ON_HOLD, ACTIVE, FAILED, CLOSED

Response

200

currencystring

statusstring

internalAccountIdstring

bankCountrystring

bankAddressstring

ibanstring

bicstring

accountNumberstring

bankNamestring

bankAccountHolderNamestring

providerstring

{"stackTrail":"paths:/bank-accounts:get:responses:200:content:application/json:schema:items:properties:paymentType","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/bank-accounts:get:responses:200:content:application/json:schema:items:properties:domestic","oasType":"schema","type":"unknown"}

payInReferencestring

Example response

[
  {
    "currency": "GBP",
    "status": "ACTIVE",
    "internalAccountId": "GBP12790694918470",
    "bankCountry": "GB",
    "bankAddress": "133 Houndsditch, LONDON EC3A 7BX, UNITED KINGDOM",
    "iban": "GB59CLRB04051011326194",
    "bic": "CLRBGB22",
    "accountNumber": "11326194",
    "bankName": "Clear Bank",
    "bankAccountHolderName": "Company Name",
    "provider": "CLEARBANK",
    "routingCodeEntries": [
      {
        "routingCodeKey": "SORT_CODE",
        "routingCodeValue": "040510"
      }
    ],
    "payInReference": "A11638158-1PPWYKP020"
  }
]