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

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

Get banks v2

Request

The GET /v2/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.

perPageinteger(int32)

The number of records per page.

Default 200

Example: perPage=10

sortstring

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

Default "NAME"

Enum"COUNTRY""STANDARD""RANK""NAME"

Example: sort=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.

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.

searchstring

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

Example: search=hsbc

bankGroupstring

Filters for banks that are members 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

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.

openBankingStandardsArray of strings

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

Items Enum"UK_Open_Banking_Standard""Starling_Bank_API""PolishAPI""STET_PSD2_API""Citi_Handlowy_PSD2_API""NextGenPSD2""Slovak_Banking_API_Standard""Czech_Open_Banking_Standard""American_Express_PSD2_API""Budapest_Bank_API"

Example: openBankingStandards=UK_Open_Banking_Standard

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

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

supportedLocalInstrumentsArray of strings

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

Example: supportedLocalInstruments=SEPA&supportedLocalInstruments=SEPA_INSTANT&supportedLocalInstruments=FASTER_PAYMENTS

supportsAccountListboolean(boolean)

Filters for banks that support fetching accounts.

supportsAccountDetailsboolean(boolean)

Filters for banks that support fetching account details.

supportsAccountBalanceboolean(boolean)

Filters for banks that support fetching account balances.

supportsTransactionListboolean(boolean)

Filters for banks that support fetching transactions.

supportsTransactionDetailsboolean(boolean)

Filters for banks that support fetching transaction details.

supportsStandingOrderListboolean(boolean)

Filters for banks that support the fetching standing orders.

supportsTransactionsDateFilterboolean(boolean)

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

requiresOneStepPaymentboolean(boolean)

Filters for banks that only support immediate redemption of transfers.

supportsSinglePaymentboolean(boolean)

Filters for banks that support single immediate payments.

Example: supportsSinglePayment=true

supportsScheduledPaymentboolean(boolean)

Filters for banks that support future dated scheduled payments.

supportsStandingOrderboolean(boolean)

Filters for banks that support recurring payments/standing orders.

supportsReturnRefundAccountboolean(boolean)

Filters for the banks that support request of refund account.

supportsReturnRefundAccountHolderNameboolean(boolean)

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

supportsFundsConfirmationboolean(boolean)

Filters for the banks that support confirmation of available funds.

supportsVariableRecurringPaymentboolean(boolean)

Filters for banks that support variable recurring payments.

curl -i -X GET \
  'https://api.token.io/v2/banks?page=0&perPage=10&sort=COUNTRY&memberId=string&tppId=string&ids=string&search=hsbc&bankGroup=HSBC%2CCoop&bankSubGroup=CMM+Grand%2CBanque+Populaire%2CLa+Banque&bankCode=string&openBankingStandards=UK_Open_Banking_Standard&countries=string&bics=BKENGB2L&supportedLocalInstruments=SEPA%2CSEPA_INSTANT%2CFASTER_PAYMENTS&supportsAccountList=true&supportsAccountDetails=true&supportsAccountBalance=true&supportsTransactionList=true&supportsTransactionDetails=true&supportsStandingOrderList=true&supportsTransactionsDateFilter=true&requiresOneStepPayment=true&supportsSinglePayment=true&supportsScheduledPayment=true&supportsStandingOrder=true&supportsReturnRefundAccount=true&supportsReturnRefundAccountHolderName=true&supportsFundsConfirmation=true&supportsVariableRecurringPayment=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json

banksArray of objects(BankV2)

This field contains information for each bank matching the request criteria.

pagingobject(Paging)

Contains the page information for response content.

rankinteger

Sorts banks by 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"
  ]
}

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