Token.io

token-io Settlement Accounts API

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.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /virtual-accounts Open a settlement account · Create a settlement account #
Ask an LLM
“How do I open a new settlement account to collect payments?”
“Which currency and country must I pick for a settlement account?”
Tell an agent
Create a settlement account in {currency} for country {country}.
Open a {currency} settlement account in {country} nicknamed {nickname}.
GET /virtual-accounts List settlement accounts · Get settlement accounts #
Ask an LLM
“Which settlement accounts do I hold, and in which currencies?”
“Can I filter settlement accounts by country or nickname?”
Tell an agent
List my settlement accounts in currency {currency}.
Show settlement accounts in {country} nicknamed {nickname}.
GET /virtual-accounts/{accountId} Get a settlement account · Get a settlement account #
Ask an LLM
“What are the details of one of my settlement accounts?”
“Can I look up a settlement account by its id?”
Tell an agent
Get settlement account {account_id}.
Show the details of settlement account {account_id}.
GET /virtual-accounts/{accountId}/transactions List settlement account transactions · Get settlement account transactions #
Ask an LLM
“Which payments landed in my settlement account this week?”
“Can I filter settlement transactions by amount or reference?”
Tell an agent
List transactions in settlement account {account_id} from {start_date} to {end_date}.
Find settlement account {account_id} transactions with reference {ref_id}.
GET /virtual-accounts/{accountId}/transactions/{providerPaymentId} Get one settlement account transaction · Get a settlement account transaction #
Ask an LLM
“Can I pull a single transaction from my settlement account?”
“What details come back for one settlement transaction by provider payment id?”
Tell an agent
Get transaction {provider_payment_id} in settlement account {account_id}.
Show settlement transaction {provider_payment_id} on account {account_id}.
POST /virtual-accounts/{accountId}/settlement-rule Create an automatic settlement rule · Create a settlement rule #
Ask an LLM
“Can I automatically sweep funds from a settlement account to my bank account on a schedule?”
“Can a settlement rule pay out a fixed amount or a percentage at intraday intervals?”
Tell an agent
Create a settlement rule on account {account_id} paying {amount_value} ({amount_type}) to {payee} every {interval}, every {hours} hours intraday.
Set up a sweep from settlement account {account_id} to {payee} starting {effective_from}.
GET /virtual-accounts/{accountId}/settlement-rules List settlement rules on an account · Get settlement rules #
Ask an LLM
“Which settlement rules are configured on my settlement account?”
“Can I list only active or only deleted settlement rules?”
Tell an agent
List settlement rules on account {account_id}.
Show settlement rules on account {account_id} with status {status}.
GET /virtual-accounts/{accountId}/settlement-rules/{settlementRuleId} Get one settlement rule · Get a settlement rule #
Ask an LLM
“What does a specific settlement rule do?”
“Can I look up one rule by its settlement rule id?”
Tell an agent
Get settlement rule {rule_id} on account {account_id}.
Show the schedule of settlement rule {rule_id} for account {account_id}.
DELETE /virtual-accounts/{accountId}/settlement-rules/{settlementRuleId} Delete a settlement rule · Delete a settlement rule #
Ask an LLM
“Can I stop an automatic sweep by deleting its settlement rule?”
“Which settlement rules can be deleted?”
Tell an agent destructive · confirm first
Delete settlement rule {rule_id} on account {account_id}.
Stop automatic settlement {rule_id} on account {account_id}.
GET /virtual-accounts/{accountId}/settlement-rule-payouts List payouts made by settlement rules · Get settlement account payouts #
Ask an LLM
“Which payouts did my settlement rules create?”
“Can I see the payouts from one particular settlement rule?”
Tell an agent
List settlement rule payouts for account {account_id}.
Show payouts created by rule {rule_id} on account {account_id}.

Documentation

📖
Documentation
https://docs.token.io/products/tpp/api/reference
📖
GettingStarted
https://docs.token.io/products/tpp

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/token-io/refs/heads/main/openapi/token-io-settlement-accounts-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/token-io/refs/heads/main/json-schema/token-io-payment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/token-io/refs/heads/main/json-schema/token-io-vrp-consent-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/token-io/refs/heads/main/json-schema/token-io-account-schema.json

Other Resources

🔗
Reference
https://reference.token.io/
🔗
OpenAPISource
https://docs.token.io/_bundle/products/tpp/api/reference/index.yaml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/token-io/refs/heads/main/json-ld/token-io-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/token-io:token-io-settlement-accounts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

token-io-settlement-accounts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Token.io's Open Banking API for TPPs Settlement Accounts API
  description: '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.'
  version: ''
servers:
- url: https://api.token.io
tags:


# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/token-io/refs/heads/main/openapi/token-io-settlement-accounts-api-openapi.yml