v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Banks v2

Get banks v2

The GET /v2/banks endpoint retrieves a list of connected banks matching the parameters specified.

get/v2/banks

Query parameters

pageinteger

The index of the page currently being retrieved.

perPageinteger

Example:10

The number of records per page.

sort'COUNTRY' | 'STANDARD' | 'RANK' | 'NAME'

Example:COUNTRY

The key to sort the result. This can be NAME (Bank's name), STANDARD (OpenBankingStandard), RANK, or COUNTRY.

memberIdstring

The Token.io-assigned member id of the TPP.

tppIdstring

Filters for banks for which the TPP represented by this tppId has access.

idsstring[]

Filters for banks with a bankId (case-insensitive) matching any of the ids listed, up to a maximum of 1000. Only exact (full string) matches are returned.

searchstring

Example:hsbc

Filters for banks with a name or identifiers containing this search string.

bankGroupstring

Filters for banks that are members of the bank group specified.

bankSubGroupstring

Filters for banks that are part of the bank sub-group specified.

bankCodestring

Filters for banks with a BIC (or BLZ, if German) that matches this bankCode. The BIC must have a string length of 8 or 11. The BLZ must have a string length of 8.

openBankingStandardsstring[]

Filters for banks that are accessed through any of the listed standards.

[
  "UK_Open_Banking_Standard"
]

countriesstring[]

Filters for banks that are located in the countries specified by this list of two-letter country code in upper case (ISO 3166-1 alpha-2).

bicsstring[]

Filters for banks whose BIC matches any of the listed BICs (case-insensitive), up to a maximum of 1000.

[
  "BKENGB2L"
]

supportedLocalInstrumentsstring[]

Filters for banks that support any of the listed payment networks.

supportsAccountListboolean

Filters for banks that support fetching accounts.

supportsAccountDetailsboolean

Filters for banks that support fetching account details.

supportsAccountBalanceboolean

Filters for banks that support fetching account balances.

supportsTransactionListboolean

Filters for banks that support fetching transactions.

supportsTransactionDetailsboolean

Filters for banks that support fetching transaction details.

supportsStandingOrderListboolean

Filters for banks that support the fetching standing orders.

supportsTransactionsDateFilterboolean

Filters for banks that support feting transactions using a date filter.

requiresOneStepPaymentboolean

Filters for banks that only support immediate redemption of transfers.

supportsSinglePaymentboolean

Example:true

Filters for banks that support single immediate payments.

supportsScheduledPaymentboolean

Filters for banks that support future dated scheduled payments.

supportsStandingOrderboolean

Filters for banks that support recurring payments/standing orders.

supportsReturnRefundAccountboolean

Filters for the banks that support request of refund account.

supportsReturnRefundAccountHolderNameboolean

Filters for banks that support returning the refund account holder name.

supportsFundsConfirmationboolean

Filters for the banks that support confirmation of available funds.

supportsVariableRecurringPaymentboolean

Filters for banks that support variable recurring payments.

Response

Successful response

rankinteger

Sorts banks by rank.

bankSubGroupstring

Filters for banks that are part of the bank sub-group specified.

Example response

{
  "banks": [
    {
      "id": "ob-modelo",
      "bic": "BOFIIE2D",
      "name": "GoldBank",
      "logoUri": "https://example.com/path/full.png",
      "bankGroup": "XYZ-Bank-Group",
      "bankSubGroup": "Sub-XYZ-Bank-Group",
      "countries": [
        "DE",
        "IT"
      ],
      "openBankingStandard": "UK_Open_Banking_Standard",
      "initialEmbeddedAuthFields": {
        "id": "67891234",
        "displayName": "Password:",
        "additionalInformation": "This field is required."
      },
      "mandatoryFields": [
        {
          "products": [
            "SIP"
          ],
          "fieldPaths": [
            "initiation.debtor"
          ],
          "paymentTypes": [
            "International"
          ],
          "localInstruments": [
            "SEPA"
          ]
        }
      ],
      "maintenanceWindow": [
        {
          "startTime": "2023-05-03T12:28:20.466Z",
          "endTime": "2023-05-03T12:40:25.47Z",
          "type": "OUTAGE",
          "productType": "SIP"
        }
      ],
      "scaMethods": [
        "REDIRECT"
      ],
      "fieldsFormatInformation": [
        {
          "constraint": "^[A-Za-z0-9?:()./,'+\\-\\s]*$",
          "v2Name": "description",
          "v2Path": "credentials.credentials1"
        }
      ],
      "supportedLocalInstruments": [
        "SEPA",
        "SEPA_INSTANT",
        "FASTER_PAYMENTS"
      ],
      "operationalTime": "MON to FRI, 00:00 to 24:00 GMT+1",
      "transactionHistoryLimit": 65,
      "supportsAccountList": true,
      "supportsAccountDetails": true,
      "supportsAccountBalance": true,
      "supportsTransactionList": true,
      "supportsTransactionDetails": true,
      "supportsStandingOrderList": true,
      "supportsTransactionsDateFilter": true,
      "requiresOneStepPayment": true,
      "supportsSinglePayment": true,
      "supportsScheduledPayment": true,
      "supportsStandingOrder": true,
      "supportsReturnRefundAccount": true,
      "supportsFundsConfirmation": true,
      "supportsVariableRecurringPayment": true
    }
  ],
  "paging": {
    "page": 15,
    "pageCount": 80,
    "perPage": 32,
    "totalCount": 2500
  }
}