Token.io's Open Banking API for TPPs

Token.io's Open Banking API

Token.io Support: support.token.io

The Token.io Open Banking API enables you to connect securely with banks for a range of services.

Using our API you can:

provide authorized access to an authenticated user's account information
get information on specific banks
initiate authorization with a user-selected bank
initate and track single immediate payments and future dated payments
use variable recurring payments (VRP) to grant long-held consents to Payment Initiation Service Providers (PISPs) to initiate series of payments from users' bank accounts
carry out settlements, payments and refunds using our settlement accounts

For more information see our developer documentation.

Download OpenAPI description

index.json

index.yaml

Servers

https://api.token.io/

Payments v2

These endpoints enable you to make v2 single immediate payments and future dated payments using the redirect, embedded and decoupled flows.

Operations

Requests - for Payments v1 or AIS

These endpoints allow you to initiate a Payments v1 request or an AIS request, and retrieve the status of the request.

Operations

Transfers - for Payments v1

These endpoints relate to transfers, which are requests to move money between accounts.

Operations

Variable Recurring Payments

These endpoints enable you to initiate Variable Recurring Payments (VRP).

Operations

Refunds

These endpoints allow you to handle registration, posting, and retrieval of refunds associated with original transaction account information.

Operations

Payouts

These endpoints allow you to make payouts.

Operations

Settlement Accounts

These endpoints provide authorized access to an authenticated user's settlement account information, enabling you to create settlement accounts, retrieve settlement account details, transactions and payouts, and manage settlement rules.

Operations

Accounts

These endpoints provide authorized access to an authenticated user's account information.

Operations

Tokens

These endpoints retrieve all tokens, a filtered list of tokens, or a specific token, as well as allowing you to cancel an existing token.

Operations

Banks v1

These endpoints filter and fetch the list of connected banks, get information on specific banks, and initiate authorization with user-selected banks using Payments v1.

Operations

Get banks v1

Request

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

Security

Bearer or BasicAuth

Query

pageinteger(int32)

The index of the page currently being retrieved.

Example: page=1

perPageinteger(int32)

The number of records per page.

Example: perPage=175

sortstring

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

Default "name"

Example: sort=country

memberIdstring

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

Example: memberId=m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq

idsArray of strings

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.

Example: ids=goldbank&ids=opalbank&ids=platinumbank

searchstring

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

Example: search=hsbc

tppIdstring

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

Example: tppId=4h27g823-g73s-07v3-l49s-prte94bf21v

providersArray of strings

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

Example: providers=Token.io

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.

Example: bankCode=NBAGDE3E

countriesArray of strings

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).

Example: countries=IT&countries=DE&countries=RO

bank_features.supports_send_payment.valueboolean(boolean)

Filters for banks that support payment initiation.

Default false

Example: bank_features.supports_send_payment.value=false

bank_features.supports_receive_payment.valueboolean(boolean)

Filters for banks that support receiving payments.

Default false

Example: bank_features.supports_receive_payment.value=false

bank_features.supports_balance.valueboolean(boolean)

Filters for the banks that support retrieving balances.

Default false

Example: bank_features.supports_balance.value=false

bank_features.supports_scheduled_payment.valueboolean(boolean)

Filters for banks that support future dated scheduled payments.

Default false

Example: bank_features.supports_scheduled_payment.value=false

bank_features.supports_standing_order.valueboolean(boolean)

Filters for banks that support recurring payments/standing orders.

Default false

Example: bank_features.supports_standing_order.value=false

bank_features.requires_one_step_payment.valueboolean(boolean)

Filters for banks that only support immediate redemption of transfers.

Default false

Example: bank_features.requires_one_step_payment.value=false

bank_features.supports_funds_confirmation.valueboolean(boolean)

Filters for the banks that support confirmation of available funds.

Default false

Example: bank_features.supports_funds_confirmation.value=false

bank_features.supports_return_refund_account.valueboolean(boolean)

Filters for the banks that support request of refund account.

Default false

Example: bank_features.supports_return_refund_account.value=false

bank_features.supports_transactions_date_filter.valueboolean(boolean)

Filters for banks that support retrieving transactions by date filter.

Default false

Example: bank_features.supports_transactions_date_filter.value=false

bank_features.supports_account_information.valueboolean(boolean)

Filters for banks that support retrieval of account information.

Default false

Example: bank_features.supports_account_information.value=false

bank_features.supports_single_payment.valueboolean(boolean)

Filters for banks that support single immediate payments.

Default false

Example: bank_features.supports_single_payment.value=false

bank_features.supports_variable_recurring_payment.valueboolean(boolean)

Filters for banks that support variable recurring payments.

Default false

Example: bank_features.supports_variable_recurring_payment.value=false

bicsArray of strings

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

Example: bics=BKENGB2L, BNPAFRPH, NBAGDE3E

supportedPaymentNetworksArray of strings

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

bankGroupstring

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

Example: bankGroup=HSBC&bankGroup=Coop

bankSubGroupstring

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

Example: bankSubGroup=CMM Grand&bankSubGroup=Banque Populaire&bankSubGroup=La Banque

curl -i -X GET \
  'https://api.token.io/banks?page=1&perPage=175&sort=country&memberId=m%3AnP4w3u5y8ddrxDJkjimgSX9e4fZ%3A5zKtXEAq&ids=goldbank%2Copalbank%2Cplatinumbank&search=hsbc&tppId=4h27g823-g73s-07v3-l49s-prte94bf21v&providers=Token.io&bankCode=NBAGDE3E&countries=IT%2CDE%2CRO&bank_features.supports_send_payment.value=false&bank_features.supports_receive_payment.value=false&bank_features.supports_balance.value=false&bank_features.supports_scheduled_payment.value=false&bank_features.supports_standing_order.value=false&bank_features.requires_one_step_payment.value=false&bank_features.supports_funds_confirmation.value=false&bank_features.supports_return_refund_account.value=false&bank_features.supports_transactions_date_filter.value=false&bank_features.supports_account_information.value=false&bank_features.supports_single_payment.value=false&bank_features.supports_variable_recurring_payment.value=false&bics=BKENGB2L%2C+BNPAFRPH%2C+NBAGDE3E&supportedPaymentNetworks=string&bankGroup=HSBC%2CCoop&bankSubGroup=CMM+Grand%2CBanque+Populaire%2CLa+Banque' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json

banksArray of objects(BankV1)

Contains information for each bank matching the request criteria.

pagingobject(Paging)

Contains the page information for response content.

rankinteger

Sort banks by the value of rank.

Example: [1,2,100]

bankSubGroupstring

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

Example: ["CMM Grand","Banque Populaire","La Banque"]

Response

application/json

{
  "banks": [
    { … }
  ],
  "paging": {
    "page": 15,
    "pageCount": 80,
    "perPage": 32,
    "totalCount": 2500
  },
  "rank": [
    1,
    2,
    100
  ],
  "bankSubGroup": [
    "CMM Grand",
    "Banque Populaire",
    "La Banque"
  ]
}

Get bank countries

Request

The GET /banks/countries endpoint retrieves the list of countries that have connected banks which match the parameters specified.

Security

Bearer or BasicAuth

Query

idsArray of strings

Filters for banks with bank ids that are represented in this list of ids (case-insensitive), up to a maximum of 1000.

Example: ids=goldbank&ids=opalbank&ids=platinumbank

searchstring

Filters for banks with names or identifiers that contain this search string (case sensitive).

Example: search=banca

tppIdstring

Filters for banks to which the TPP with this tppId has access.

Example: tppId=9fk3m361-f12r-04b9-p39f-rio2m3pw9v8s

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.

Example: bankCode=NBAGDE3E

countriesArray of strings

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).

Example: countries=GB, RO, AT

providersArray of strings

Filters for banks that are accessed through any of this list of providers.

Example: providers=Token.io

bank_features.supports_send_payment.valueboolean(boolean)

Filters for banks that support payment initiation.

Default false

Example: bank_features.supports_send_payment.value=false

bank_features.supports_receive_payment.valueboolean(boolean)

Filters for banks that support the receipt of payments.

Default false

Example: bank_features.supports_receive_payment.value=false

bank_features.supports_balance.valueboolean(boolean)

Filters for the banks that support retrieving account balances.

Default false

Example: bank_features.supports_balance.value=false

bank_features.supports_scheduled_payment.valueboolean(boolean)

Filters for banks that support future dated scheduled payments.

Default false

Example: bank_features.supports_scheduled_payment.value=false

bank_features.supports_standing_order.valueboolean(boolean)

Filters for banks that support standing orders/recurring payments.

Default false

Example: bank_features.supports_standing_order.value=false

bank_features.requires_one_step_payment.valueboolean(boolean)

Filters for banks that only support immediate redemption of transfer tokens.

Default false

Example: bank_features.requires_one_step_payment.value=false

bank_features.supports_funds_confirmation.valueboolean(boolean)

Filters for banks that support confirmation of available funds.

Default false

Example: bank_features.supports_funds_confirmation.value=false

bank_features.supports_return_refund_account.valueboolean(boolean)

Filters for banks that support the request of refund account.

Default false

Example: bank_features.supports_return_refund_account.value=false

bank_features.supports_transactions_date_filter.valueboolean(boolean)

Filters for banks that support retrieving transactions by date filter.

Default false

Example: bank_features.supports_transactions_date_filter.value=false

bank_features.supports_account_information.valueboolean(boolean)

Filters for banks that support retrieving account information using Account Information Services (AIS).

Default false

Example: bank_features.supports_account_information.value=false

bank_features.supports_single_payment.valueboolean(boolean)

Filters for banks that support single immediate payments.

Default false

Example: bank_features.supports_single_payment.value=false

bank_features.supports_variable_recurring_payment.valueboolean(boolean)

Filters for banks that support variable recurring payments.

Default false

Example: bank_features.supports_variable_recurring_payment.value=false

memberIdstring

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

Example: memberId=m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq

supportedPaymentNetworksArray of strings

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

Example: supportedPaymentNetworks=SEPA

curl -i -X GET \
  'https://api.token.io/bank/countries?ids=goldbank%2Copalbank%2Cplatinumbank&search=banca&tppId=9fk3m361-f12r-04b9-p39f-rio2m3pw9v8s&bankCode=NBAGDE3E&countries=GB%2C+RO%2C+AT&providers=Token.io&bank_features.supports_send_payment.value=false&bank_features.supports_receive_payment.value=false&bank_features.supports_balance.value=false&bank_features.supports_scheduled_payment.value=false&bank_features.supports_standing_order.value=false&bank_features.requires_one_step_payment.value=false&bank_features.supports_funds_confirmation.value=false&bank_features.supports_return_refund_account.value=false&bank_features.supports_transactions_date_filter.value=false&bank_features.supports_account_information.value=false&bank_features.supports_single_payment.value=false&bank_features.supports_variable_recurring_payment.value=false&memberId=m%3AnP4w3u5y8ddrxDJkjimgSX9e4fZ%3A5zKtXEAq&supportedPaymentNetworks=SEPA' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json

countriesArray of strings

Two-letter country codes in upper case (ISO 3166-1 alpha-2).

Example: ["RO, AT, DE, FR"]

Response

application/json

{
  "countries": [
    "RO, AT, DE, FR"
  ]
}

Banks v2

This endpoint filters and fetches the list of connected banks, gets information on specific banks, and initiates authorization with user-selected banks using Payments v2.

Operations

Sub-TPPs

These endpoints are for resellers using Token.io's licence to create, retrieve and delete sub-TPPs.

Operations

Authentication keys

These endpoints are for managing the public keys that are used for JWT authentication.

Operations

Reports

These endpoints retrieve the current AIS and PIS status of connected banks.

Operations

Webhooks

These endpoints configure, retrieve and remove webhooks. See Webhooks for more details.

Operations