Sign in
latestOpenAPI 3.0.12026-08-1974476716.3 KB

08c7d0c9ce60

Banks v1

Get banks v1

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

get/banks

Query parameters

pageinteger

The index of the page currently being retrieved.

perPageinteger
Example:175

The number of records per page.

sortstring
Example:country

The key to sort the result. This can be name (<i>i.e.</i>, bank name), provider, or country.

memberIdstring

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

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.

[
  "goldbank",
  "opalbank",
  "platinumbank"
]
searchstring
Example:hsbc

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

tppIdstring

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

providersstring[]

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

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.

countriesstring[]

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

[
  "IT",
  "DE",
  "RO"
]
bank_features.supports_send_payment.valueboolean

Filters for banks that support payment initiation.

bank_features.supports_receive_payment.valueboolean

Filters for banks that support receiving payments.

bank_features.supports_balance.valueboolean

Filters for the banks that support retrieving balances.

bank_features.supports_scheduled_payment.valueboolean

Filters for banks that support future dated scheduled payments.

bank_features.supports_standing_order.valueboolean

Filters for banks that support recurring payments/standing orders.

bank_features.requires_one_step_payment.valueboolean

Filters for banks that only support immediate redemption of transfers.

bank_features.supports_funds_confirmation.valueboolean

Filters for the banks that support confirmation of available funds.

bank_features.supports_return_refund_account.valueboolean

Filters for the banks that support request of refund account.

bank_features.supports_transactions_date_filter.valueboolean

Filters for banks that support retrieving transactions by date filter.

bank_features.supports_account_information.valueboolean

Filters for banks that support retrieval of account information.

bank_features.supports_single_payment.valueboolean

Filters for banks that support single immediate payments.

bank_features.supports_variable_recurring_payment.valueboolean

Filters for banks that support variable recurring payments.

bicsstring[]

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

[
  "BKENGB2L, BNPAFRPH, NBAGDE3E"
]
supportedPaymentNetworksstring[]

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

bankGroupstring

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

bankSubGroupstring

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

Response

Successful response

GetBanksResponse required— unresolved $ref