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

Tokenized Account

These endpoints enable you to generate tokenized account id from the provided account details.

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

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

Verification

Operations

Initiate an account verification check

Request

This endpoint allows clients to verify whether the provided account details (such as sort code and account number or IBAN) match the name of the intended account holder, whether an individual or a business

Security

Bearer or BasicAuth

Bodyapplication/json

accountobjectrequired

Account information for account verification

account.namestringrequired

Name of account holder

account.currencystringrequired

Specifies the currency of the account being verified, represented in ISO 4217 three-letter format (e.g., GBP, EUR). This ensures accurate matching where account validation rules or naming conventions may vary by currency.

Enum"GBP""EUR"

account.accountTypestring

Specify if the account is Personal or Business. This is only required for GBP accounts.

Enum"PERSONAL""BUSINESS"

account.accountNumberstring

The account number for a UK based account

account.sortCodestring

The sort code for a UK based account

account.ibanstring

The International Bank Account Number (IBAN) which identifies a bank account across borders

virtualAccountIdstring

The Token settlement account from which the subsequent payout or refund will be executed.

Conditional - If this verification check is independent of a Token provided settlement account, this should NOT be provided.

curl -i -X POST \
  https://api.token.io/account-verifications \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "name": "John Doe",
      "accountNumber": "12345678",
      "sortCode": "123456",
      "currency": "GBP",
      "accountType": "PERSONAL"
    },
    "virtualAccountId": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV"
  }'

Responses

Bodyapplication/json

idstringrequired

Example: "01K4SMENHFT2MK5DKVDYWP6M7B"

resultobjectrequired

result.statusstringrequired

The outcome of the verification

Enum"MATCH""NO_MATCH""CLOSE_MATCH""VERIFICATION_NOT_POSSIBLE"

result.reasonsArray of stringsrequired

A more granular reason as to why there was not a full match

Items Enum"UNKNOWN""EXACT_MATCH""NAME_MISMATCH""ACCOUNT_MISMATCH""ACCOUNT_TYPE_MISMATCH"

result.detailsstringrequired

A human readable explanation for the outcome of the verification check

result.matchedobject

Further details on the attributes that would result in a full match

Response

application/json

{
  "id": "avr-01K8R977E2Y0XE5CYQE1608N06",
  "result": {
    "status": "MATCH",
    "reasons": [ … ],
    "details": "The account details match."
  }
}

Token.io's Open Banking API for TPPs

Payments v2

Tokenized Account

Requests - for Payments v1 or AIS

Transfers - for Payments v1

Variable Recurring Payments

Refunds

Payouts

Settlement Accounts

Accounts

Tokens

Banks v1

Banks v2

Sub-TPPs

Authentication keys

Reports

Webhooks

Verification

Initiate an account verification check

RequestExpand all

Responses

Request