# Token.io's Open Banking API for TPPs API

> Token.io's Open Banking API for TPPs API on Apizie: 63 endpoints (Get information for all accounts, Get account information, Get account balances, Get an account balance, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:token/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:token`
- Category: Payments
- Status: byok
- Source: https://token.io
- Page: https://apizie.tech/api/payments/token
- OpenAPI: https://apizie.tech/api/payments/token/openapi.json

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…

## Endpoints

### Get information for all accounts
`GET https://apizie.tech/v1/payments:token/accounts-get-all-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| token-customer-ip-address | string | no | The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is… |

### Get account information
`GET https://apizie.tech/v1/payments:token/accounts-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The system-generated, unique bank account id, which specifies the account for which the information is requested. |
| token-customer-ip-address | string | no | The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is… |

### Get account balances
`GET https://apizie.tech/v1/payments:token/accounts-get-multiple-balances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| token-customer-ip-address | string | no | The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is… |
| accountId | array | no | A comma-separated list of account ids for which you wish to retrieve account balances. |

### Get an account balance
`GET https://apizie.tech/v1/payments:token/accounts-get-balance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The unique bank account id, which specifies the account for which the information is requested. |
| token-customer-ip-address | string | no | The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is… |

### Get information for all standing orders
`GET https://apizie.tech/v1/payments:token/accounts-get-standing-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The unique bank account id, which specifies the account for which the information is requested. |
| page.offset | string | no | The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no… |
| page.limit | integer | yes | The maximum number of records to return. This must be less than 200. |

### Get standing order information
`GET https://apizie.tech/v1/payments:token/accounts-get-standing-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The system-generated, unique bank account id, which specifies the account for which the information is requested. |
| standingOrderId | string | yes | The unique standing order identifier, which specifies the standing order requested. |

### Get account transactions
`GET https://apizie.tech/v1/payments:token/accounts-get-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The system-generated unique bank account id, which specifies the account for which the information is requested. |
| token-customer-ip-address | string | no | The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is… |
| page.offset | string | no | The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no… |
| page.limit | integer | yes | The maximum number of records to return. This must be less than 200. |
| startDate | string | no | The earliest transaction date requested, in ISO 8601 format. |
| endDate | string | no | The latest transaction date requested, in ISO 8601 format. |

### Get transaction information
`GET https://apizie.tech/v1/payments:token/accounts-get-transaction-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The unique bank account id, which specifies the account for which the information is requested. |
| transactionId | string | yes | The unique transaction identifier, which specifies the transaction requested. |
| token-customer-ip-address | string | no | The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is… |

### Confirm available funds
`POST https://apizie.tech/v1/payments:token/accounts-confirm-funds-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes | The system-generated, unique bank account id, which specifies the account for which the information is requested. |
| body | object | yes | JSON request body |

### Get banks v1
`GET https://apizie.tech/v1/payments:token/banks-v1-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | The index of the page currently being retrieved. |
| perPage | integer | no | The number of records per page. |
| sort | string | no | The key to sort the result. This can be `name` ( i.e. , bank name), `provider`, or `country`. |
| memberId | string | no | The Token.io-assigned member id of the TPP. |
| ids | array | no | Filters for banks with a `bankId` (case-insensitive) matching any of the ids listed, up to a maximum of 1000. Only exact (full string)… |
| search | string | no | Filters for banks with a name or identifiers containing this search string. |
| tppId | string | no | Filters for banks for which the TPP represented by this `tppId` has access. |
| providers | array | no | Filters for banks that are accessed through any of the listed providers. |
| bankCode | string | no | 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… |
| countries | array | no | Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes , in upper case. |
| bank_features.supports_send_payment.value | boolean | no | Filters for banks that support payment initiation. |
| bank_features.supports_receive_payment.value | boolean | no | Filters for banks that support receiving payments. |
| bank_features.supports_balance.value | boolean | no | Filters for the banks that support retrieving balances |
| bank_features.supports_scheduled_payment.value | boolean | no | Filters for banks that support future dated scheduled payments. |
| bank_features.supports_standing_order.value | boolean | no | Filters for banks that support recurring payments/standing orders. |
| bank_features.requires_one_step_payment.value | boolean | no | Filters for banks that only support immediate redemption of transfers. |
| bank_features.supports_funds_confirmation.value | boolean | no | Filters for the banks that support confirmation of available funds. |
| bank_features.supports_return_refund_account.value | boolean | no | Filters for the banks that support request of refund account. |
| bank_features.supports_transactions_date_filter.value | boolean | no | Filters for banks that support retrieving transactions by date filter. |
| bank_features.supports_account_information.value | boolean | no | Filters for banks that support retrieval of account information. |
| bank_features.supports_single_payment.value | boolean | no | Filters for banks that support single immediate payments. |
| bank_features.supports_variable_recurring_payment.value | boolean | no | Filters for banks that support variable recurring payments. |
| bics | array | no | Filters for banks whose BIC matches any of the listed BICs (case-insensitive), up to a maximum of 1000. |
| supportedPaymentNetworks | array | no | Filters for banks that support any of the listed payment networks. |
| bankGroup | string | no | Filters for banks that are part of the bank group specified. |
| bankSubGroup | string | no | Filters for banks that are part of the bank sub-group specified. |

### Get bank countries
`GET https://apizie.tech/v1/payments:token/banks-v1-get-bank-countries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | array | no | Filters for banks with bank ids that are represented in this list of ids (case-insensitive), up to a maximum of 1000. |
| search | string | no | Filters for banks with names or identifiers that contain this search string (case sensitive). |
| tppId | string | no | Filters for banks to which the TPP with this `tppId` has access. |
| bankCode | string | no | 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… |
| countries | array | no | Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes , in upper case. |
| providers | array | no | Filters for banks that are accessed through any of this list of providers. |
| bank_features.supports_send_payment.value | boolean | no | Filters for banks that support payment initiation. |
| bank_features.supports_receive_payment.value | boolean | no | Filters for banks that support the receipt of payments. |
| bank_features.supports_balance.value | boolean | no | Filters for the banks that support retrieving account balances. |
| bank_features.supports_scheduled_payment.value | boolean | no | Filters for banks that support future dated scheduled payments. |
| bank_features.supports_standing_order.value | boolean | no | Filters for banks that support standing orders/recurring payments. |
| bank_features.requires_one_step_payment.value | boolean | no | Filters for banks that only support immediate redemption of transfer tokens. |
| bank_features.supports_funds_confirmation.value | boolean | no | Filters for banks that support confirmation of available funds. |
| bank_features.supports_return_refund_account.value | boolean | no | Filters for banks that support the request of refund account. |
| bank_features.supports_transactions_date_filter.value | boolean | no | Filters for banks that support retrieving transactions by date filter. |
| bank_features.supports_account_information.value | boolean | no | Filters for banks that support retrieving account information using Account Information Services (AIS). |
| bank_features.supports_single_payment.value | boolean | no | Filters for banks that support single immediate payments. |
| bank_features.supports_variable_recurring_payment.value | boolean | no | Filters for banks that support variable recurring payments. |
| memberId | string | no | The Token.io-assigned member id of the TPP. |
| supportedPaymentNetworks | array | no | Filters for banks that support any of the listed payment networks. |

### Get sub-TPPs
`GET https://apizie.tech/v1/payments:token/sub-tp-ps-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page.offset | string | no | The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no… |
| page.limit | integer | yes | The maximum number of records to return. This must be less than 200. |
| filter.byCompanyNames | array | no | Filters the sub-TPPs by the list of company names submitted. |
| filter.byRegistrationDates | array | no | Filters the sub-TPPs by the list of registration dates submitted. |

### Create a sub-TPP
`POST https://apizie.tech/v1/payments:token/sub-tp-ps-create-sub-tpp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get sub-TPP information
`GET https://apizie.tech/v1/payments:token/sub-tp-ps-get-sub-tpp-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subTppId | string | yes | This id specifies the sub-TPP to be retrieved. |

### Delete a sub-TPP
`POST https://apizie.tech/v1/payments:token/sub-tp-ps-delete-sub-tpp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subTppId | string | yes | Specifies the sub-TPP to delete. |

### Get sub-TPP children
`GET https://apizie.tech/v1/payments:token/sub-tp-ps-get-children` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subTppId | string | yes | Specifies the sub-TPP for which the children are to be retrieved. |

### Get bank statuses
`GET https://apizie.tech/v1/payments:token/reports-get-bank-status` (byok)

### Get a bank status
`GET https://apizie.tech/v1/payments:token/reports-bank-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| bankId | string | yes | The Token.io bank identifier, identical to the `id` in the repsonse to `GET /banks`. |

### Initiate a token request
`POST https://apizie.tech/v1/payments:token/requests-initiate-token-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a token request
`GET https://apizie.tech/v1/payments:token/requests-check-token-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tokenRequestId | string | yes | The token request id received in response to the original token request. |

### Initiate a callback
`POST https://apizie.tech/v1/payments:token/tsp-process-bank-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get tokens
`GET https://apizie.tech/v1/payments:token/tokens-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | no | Specifies the type of token returned. |
| page.offset | string | no | The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no… |
| page.limit | integer | yes | The maximum number of records to return. This must be less than 200. |
| filter.sourceAccountId | string | no | Identifies the payer's account. |
| filter.destinationAccountId | string | no | Identifies the payee/beneficiary's account. |
| filter.startTimeMs | string | no | The filtered list start timestamp in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000. |
| filter.endTimeMs | string | no | The filtered list end timestamp in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000. |
| filter.role | string | no | Filters by `accountHolder` role. |
| filter.actingAsRefId | string | no | Filters the list by the sub-TPP identifier generated by Token.io once a merchant has been onboarded. |

### Get a token
`GET https://apizie.tech/v1/payments:token/tokens-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tokenId | string | yes | Identifies a unique authorization token for a transfer, standing order, or account information access. |

### Cancel a token
`POST https://apizie.tech/v1/payments:token/tokens-cancel-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| token-customer-ip-address | string | no | The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is… |
| customer-initiated | boolean | no | Informs the bank that the API call was explicitly initiated by the user. This is useful in circumnavigating bank restrictions that impose… |
| token-customer-device-id | string | no | Obtained by the TPP from details in the user agent information of the user. |
| tokenId | string | yes | Identifies a unique authorization token for a transfer, standing order, or account information access. |

### Get transfers
`GET https://apizie.tech/v1/payments:token/single-immediate-payments-v1-get-transfers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tokenId | string | no | Identifies the authorization token for the request. |
| page.offset | string | no | The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no… |
| page.limit | integer | yes | The maximum number of records to return. This must be less than 200. |
| filter.tokenId | string | no | Filters by the token id. |
| filter.startTimeMs | string | no | Filtered list start time boundary in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000. |
| filter.endTimeMs | string | no | Filtered list end time boundary in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000. |
| filter.transactionStatus | string | no | Filters by transaction status. PROCESSING – This status indicates that the transaction is in process and that the final status has not… |
| filter.role | string | no | Filters list by the account holder role. |
| filter.actingAsRefId | string | no | Filters the list by the sub-TPP identifier generated by Token.io once a merchant has been onboarded. |
| filter.refId | string | no | Filters list by `refID`. |
| filter.transferRefundStatus | string | no | Filters list by refund status. |

### Redeem a transfer token
`POST https://apizie.tech/v1/payments:token/single-immediate-payments-v1-create-transfer-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Initiate bank authorization
`POST https://apizie.tech/v1/payments:token/single-immediate-payments-v1-initiate-bank-authorization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tokenRequestId | string | yes | The token request id received in response to the original token request. |
| body | object | yes | JSON request body |

### Get a transfer
`GET https://apizie.tech/v1/payments:token/single-immediate-payments-v1-get-transfer-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transferId | string | yes | The unique id of the transfer sent in the `POST /transfers` response and/or included in a respective `GET /transfers` response. |
| skipTransferUpdate | boolean | no | If `skipTransferUpdate` is false, the request will call the bank for a status update. If set to true, the cached result will be returned… |

### Get webhook config
`GET https://apizie.tech/v1/payments:token/webhooks-get-config` (byok)

### Set webhook config
`POST https://apizie.tech/v1/payments:token/webhooks-set-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete webhook config
`POST https://apizie.tech/v1/payments:token/webhooks-delete-config` (byok)

### Get VRP consents
`GET https://apizie.tech/v1/payments:token/variable-recurring-payments-get-consents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | yes | The maximum number of records to return. |
| offset | string | no | The offset from the previous page. |

### Create a VRP consent
`POST https://apizie.tech/v1/payments:token/variable-recurring-payments-create-consent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a VRP consent
`GET https://apizie.tech/v1/payments:token/variable-recurring-payments-get-consent-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | VRP consent id |

### Revoke a VRP consent
`POST https://apizie.tech/v1/payments:token/variable-recurring-payments-revoke-consent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | VRP consent id |

### Get payments under a VRP consent
`GET https://apizie.tech/v1/payments:token/variable-recurring-payments-get-payments-under-consent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | VRP consent id |
| limit | integer | yes | The maximum number of records to return. |
| offset | string | no | The offset from the previous page. |

### Get VRP payments
`GET https://apizie.tech/v1/payments:token/variable-recurring-payments-list-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | yes | The maximum number of records to return. |
| offset | string | no | The offset from the previous page. |
| ids | array | no | Filters vrp payments by their ids - returns only payments with ids listed in this parameter. |
| invertIds | boolean | no | Invert ids query - returns only vrp payments with ids not listed in the ids parameter. |
| statuses | array | no | Filters vrp payments by their statuses - returns only payments with statuses listed in this parameter. |
| invertStatuses | boolean | no | Invert statuses query - returns only vrp payments with statuses not listed in the statuses parameter. |
| createdAfter | string | no | Returns only vrp payments created after this time (in ISO 8601 format). |
| createdBefore | string | no | Returns only vrp payments created before this time (in ISO 8601 format). |
| refIds | array | no | Filters vrp payments by their `refId` values - returns only payments with `refIds` listed in this parameter. |
| vrpConsentId | string | no | Filters vrp payments by their `VRP consent id` value - returns only payments with `vrpConsentId` listed in this parameter. |

### Initiate a VRP payment
`POST https://apizie.tech/v1/payments:token/variable-recurring-payments-initiate-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a VRP payment
`GET https://apizie.tech/v1/payments:token/variable-recurring-payments-get-payment-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | VRP id |

### Verify if funds are available or not
`GET https://apizie.tech/v1/payments:token/variable-recurring-payments-check-funds-availability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The VRP consent id. |
| amount | string | yes | The amount to confirm availability for. |

### Get refunds
`GET https://apizie.tech/v1/payments:token/refunds-beta-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | yes | The maximum number of records to return. |
| offset | string | no | The offset from the previous page. |
| startDate | string | no | Lower bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or after the… |
| endDate | string | no | Upper bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or before the… |
| ids | array | no | Filters refunds by their ids - returns only refunds with ids listed in this parameter. |
| invertIds | boolean | no | Invert ids query - returns only refunds with ids not listed in the ids parameter. |
| statuses | array | no | Filters refunds by their statuses - returns only refunds with statuses listed in this parameter. |
| invertStatuses | boolean | no | Invert statuses query - returns only refunds with statuses not listed in the statuses parameter. |
| refIds | array | no | Filters refunds by their `refId` values - returns only refunds with `refIds` listed in this parameter. |
| partial | boolean | no | Returns refunds in a partial format - with only id and status fields populated. |
| onBehalfOfIds | array | no | The result can be filtered on the basis of multiple OnBehalfOfIds. |

### Initiate a refund
`POST https://apizie.tech/v1/payments:token/refunds-beta-initiate-refund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a refund
`GET https://apizie.tech/v1/payments:token/refunds-beta-get-refund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The refund id. |

### Get all refunds by transfer
`GET https://apizie.tech/v1/payments:token/refunds-beta-get-all-refunds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | yes | The maximum number of records to return. |
| offset | string | no | The offset from the previous page. |
| id | string | yes | The transfer id. |

### Get payouts
`GET https://apizie.tech/v1/payments:token/payouts-beta-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | yes | The maximum number of records to return. |
| offset | string | no | The offset from the previous page. |
| startDate | string | no | Lower bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or after the… |
| endDate | string | no | Upper bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or before the… |
| ids | array | no | Filters payouts by their ids - returns only payouts with ids listed in this parameter. |
| invertIds | boolean | no | Invert ids query - returns only payouts with ids not listed in the ids parameter. |
| statuses | array | no | Filters payouts by their statuses - returns only payouts with statuses listed in this parameter. |
| invertStatuses | boolean | no | Invert statuses query - returns only payouts with statuses not listed in the statuses parameter. |
| refIds | array | no | Filters payouts by their `refId` values - returns only payouts with `refIds` listed in this parameter. |
| onBehalfOfId | string | no | Filters payouts by their `onBehalfOfId` value - returns only payouts with `onBehalfOfId` listed in this parameter. |

### Initiate a payout
`POST https://apizie.tech/v1/payments:token/payouts-beta-initialize-payout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a payout
`GET https://apizie.tech/v1/payments:token/payouts-beta-get-payout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The payout id. |

### Upload a private key and certificate
`POST https://apizie.tech/v1/payments:token/refunds-beta-upload-key-and-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get banks v2
`GET https://apizie.tech/v1/payments:token/banks-v2-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | The index of the page currently being retrieved. |
| perPage | integer | no | The number of records per page. |
| sort | string | no | The key to sort the result. This can be `NAME` (Bank's name), `STANDARD` (OpenBankingStandard), `RANK`, or `COUNTRY`. |
| memberId | string | no | The Token.io-assigned member id of the TPP. |
| tppId | string | no | Filters for banks for which the TPP represented by this `tppId` has access. |
| ids | array | no | Filters for banks with a `bankId` (case-insensitive) matching any of the ids listed, up to a maximum of 1000. Only exact (full string)… |
| search | string | no | Filters for banks with a name or identifiers containing this search string. |
| bankGroup | string | no | Filters for banks that are members of the bank group specified. |
| bankSubGroup | string | no | Filters for banks that are part of the bank sub-group specified. |
| bankCode | string | no | 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… |
| openBankingStandards | array | no | Filters for banks that are accessed through any of the listed standards. |
| countries | array | no | Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes , in upper case. |
| bics | array | no | Filters for banks whose BIC matches any of the listed BICs (case-insensitive), up to a maximum of 1000. |
| supportedLocalInstruments | array | no | Filters for banks that support any of the listed payment networks. |
| supportsAccountList | boolean | no | Filters for banks that support fetching accounts. |
| supportsAccountDetails | boolean | no | Filters for banks that support fetching account details. |
| supportsAccountBalance | boolean | no | Filters for banks that support fetching account balances. |
| supportsTransactionList | boolean | no | Filters for banks that support fetching transactions. |
| supportsTransactionDetails | boolean | no | Filters for banks that support fetching transaction details. |
| supportsStandingOrderList | boolean | no | Filters for banks that support the fetching standing orders. |
| supportsTransactionsDateFilter | boolean | no | Filters for banks that support feting transactions using a date filter. |
| requiresOneStepPayment | boolean | no | Filters for banks that only support immediate redemption of transfers. |
| supportsSinglePayment | boolean | no | Filters for banks that support single immediate payments. |
| supportsScheduledPayment | boolean | no | Filters for banks that support future dated scheduled payments. |
| supportsStandingOrder | boolean | no | Filters for banks that support recurring payments/standing orders. |
| supportsReturnRefundAccount | boolean | no | Filters for the banks that support request of refund account. |
| supportsReturnRefundAccountHolderName | boolean | no | Filters for banks that support returning the refund account holder name. |
| supportsFundsConfirmation | boolean | no | Filters for the banks that support confirmation of available funds. |
| supportsVariableRecurringPayment | boolean | no | Filters for banks that support variable recurring payments. |

### Get payments
`GET https://apizie.tech/v1/payments:token/single-immediate-payments-v2-list-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | yes | The maximum number of records to return. |
| offset | string | no | The offset from the previous page. |
| ids | array | no | Filters payments by their ids - returns only payments with ids listed in this parameter. |
| invertIds | boolean | no | Invert ids query - returns only payments with ids not listed in the ids parameter. |
| statuses | array | no | Filters payments by their statuses - returns only payments with statuses listed in this parameter. |
| invertStatuses | boolean | no | Invert statuses query - returns only payments with statuses not listed in the statuses parameter. |
| createdAfter | string | no | Returns only payments created after this time (in ISO 8601 format). |
| createdBefore | string | no | Returns only payments created before this time (in ISO 8601 format). |
| refIds | array | no | Filters payments by their `refId` values - returns only payments with `refIds` listed in this parameter. |
| onBehalfOfId | string | no | Filters payments by the `onBehalfOfId` value - returns only payments with `onBehalfOfId` specified in this parameter. |
| refundStatuses | array | no | Filters payments by their refund status values - returns only payments with refund statuses listed in this parameter. |
| partial | boolean | no | Returns payments in a partial format - with only id and status fields populated. |

### Initiate a payment
`POST https://apizie.tech/v1/payments:token/single-immediate-payments-v2-initiate-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| request-timeout | integer | no | Sets the number of elapsed seconds until the call is aborted with a `DEADLINE_EXCEEDED` exception due to no response received. |
| body | object | yes | JSON request body |

### Provide information for embedded authentication
`POST https://apizie.tech/v1/payments:token/single-immediate-payments-v2-provide-embedded-auth-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentId | string | yes |  |
| body | object | yes | JSON request body |

### Get a payment
`GET https://apizie.tech/v1/payments:token/single-immediate-payments-v2-get-payment-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentId | string | yes |  |

### Get virtual accounts
`GET https://apizie.tech/v1/payments:token/virtual-accounts-beta-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The maximum number of records to return. The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200. |
| offset | string | no | The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value… |
| currency | string | no | The ISO 4217 three letter currency code. |
| country | string | no | The ISO 3166-1 Alpha 2 country codes . |
| nickname | string | no | The alias name that identifies the virtual account. |
| onBehalfOfId | string | no | An id of the ultimate client on whose behalf the account is created. If the account is created on behalf of a sub-TPP, this field should… |

### Create a virtual account
`POST https://apizie.tech/v1/payments:token/virtual-accounts-beta-create-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a virtual account
`GET https://apizie.tech/v1/payments:token/virtual-accounts-beta-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes |  |

### Get virtual account transactions
`GET https://apizie.tech/v1/payments:token/virtual-accounts-beta-get-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes |  |
| limit | integer | no | The maximum number of records to return. The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200. |
| offset | string | no | The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value… |
| refId | string | no | Filters transactions by their `refId` value - returns only transactions with `refId` mentioned in the reference. |
| startDate | string | no | Returns transactions created on or after this date, inclusive (in ISO 8601 format). |
| endDate | string | no | Returns transactions created on or before this date, inclusive (in ISO 8601 format). |
| amount | string | no | Filters transactions by their transaction amount. |
| providerPaymentId | string | no | Filters transactions by the provider-payment-id. |
| transactionType | string | no | Filters transactions by type to include only CREDIT or DEBIT transactions. |

### Get a virtual account transaction
`GET https://apizie.tech/v1/payments:token/virtual-accounts-beta-get-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | string | yes |  |
| providerPaymentId | string | yes |  |

### Create a settlement rule
`POST https://apizie.tech/v1/payments:token/virtual-accounts-beta-create-settlement-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes |  |
| body | object | yes | JSON request body |

### Get a settlement rule
`GET https://apizie.tech/v1/payments:token/virtual-accounts-beta-get-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The id of the virtual account. |
| settlement_rule_id | string | yes | The id of the settlement rule. |

### Delete a settlement rule
`POST https://apizie.tech/v1/payments:token/virtual-accounts-beta-delete-settlement-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The id of the virtual account. |
| settlement_rule_id | string | yes | The id of the settlement rule. |

### Get settlement rules
`GET https://apizie.tech/v1/payments:token/virtual-accounts-beta-get-settlement-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The id of the virtual account. |

### Get virtual account settlement payouts
`GET https://apizie.tech/v1/payments:token/virtual-accounts-beta-get-settlement-payouts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The id of the virtual account. |

## Example
```
curl "https://apizie.tech/v1/payments:token/accounts-get-all-accounts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Token.io's Open Banking API for TPPs API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:token/accounts-get-all-accounts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Token.io's Open Banking API for TPPs API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Token.io's Open Banking API for TPPs itself also needs your own key from api.token.io.

### Can AI agents use the Token.io's Open Banking API for TPPs API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:token.

### What is the status of the Token.io's Open Banking API for TPPs API?
Needs your own provider key (bring your own key)