How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

token-io Sub-TPPs API

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

token-io Sub-TPPs API is one of 29 APIs that Token.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Sub-TPPs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a JSON-LD context, and 3 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.token.io.

5 operations 3 paths 53 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.token.io
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

token-io Sub-TPPs API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). An API key is passed in the header as Authorization (BasicAuth).

  • Bearer — For Production and Sandbox environments. When using curl samples the authorization header is given as -H 'Authorization: Bearer + JWT' Please substitute your B…
  • BasicAuth — For Sandbox environment only. When using curl samples the authorization header is given as -H 'Authorization: YOURAPIKEYHERE' Please substitute your Basic key…

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sub-TPPs 5

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

POST
/member/sub-tpps
Create a sub-TPP
GatewayService.CreateSubTpp body → 200400401403404429500501
GET
/member/sub-tpps
Get sub-TPPs
GatewayService.RetrieveSubTpps 4 params → 200400401403404429500501
GET
/member/sub-tpps/{subTppId}
Get sub-TPP information
GatewayService.RetrieveSubTpp 1 param → 200400401403404429500501
DELETE
/member/sub-tpps/{subTppId}
Delete a sub-TPP
GatewayService.DeleteSubTpp 1 param → 200400401403404429500501
GET
/member/sub-tpps/{subTppId}/children
Get sub-TPP children
GatewayService.RetrieveSubTppChildren 1 param → 200400401403404429500501

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are member.SubTpp (14 properties), member.TokenLicensedNonSoleTraderPrivateMerchant (11 properties), member.TokenLicensedNonSoleTraderPrivateMerchantGB (10 properties), member.TokenLicensedNonSoleTraderPublicMerchant (9 properties). Each schema is shown below with its type and property counts.

member.TokenLicensedNonSoleTraderPrivateMerchant
object
Contains information about the merchant member.
11 properties 8 required
member.SubTpp
object
Contains the sub-TPP details.
14 properties
NotImplementedError
object
The operation was not implemented, supported or enabled by the bank.
2 properties 1 required
member.SubTpp.Status
string
The status of the sub-TPP.
member.LicensedTppSoleTraderMerchantGB
object
Contains information about the merchant member.
8 properties 6 required
inline_response_400
object
1 property
member.LicensedTppNonSoleTraderMerchant
object
Contains information about the merchant member.
8 properties 5 required
TokenLicensedNonSoleTraderPublicGB
object
7 properties 3 required
member.Merchant
object
Contains information about the merchant member.
6 properties 6 required
member.PersonDetail
object
Contains personal details of a Sole Trader, Ubos, Directors, or Signatories.
3 properties
ServerError
object
This could refer to either an error by the payment service provider or the bank. When the bank reports a 5xx error, "token-external-error": "true" is set as a…
2 properties
TokenLicensedNonSoleTraderPrivate
object
7 properties 3 required
inline_response_500
object
1 property
ServiceUnavailableError
object
Service is unavailable, likely due to a transient condition; this is usually corrected with a retry.
2 properties 1 required
inline_response_429
object
1 property 1 required
TokenLicensedSoleTrader
object
7 properties 3 required
LicensedTppNonSoleTraderGB
object
7 properties 3 required
member.TokenLicensedNonSoleTraderPublicMerchant
object
Contains information about the merchant member.
9 properties 6 required
OldMerchantOnboardingGB
object
7 properties 3 required
member.LicensedTppSoleTraderMerchant
object
Contains information about the merchant member.
8 properties 5 required
member.TokenLicensedNonSoleTraderPrivateMerchantGB
object
Contains information about the merchant member.
10 properties 8 required
member.TokenLicensedSoleTraderMerchant
object
9 properties 5 required
member.TokenLicensedSoleTraderMerchantGB
object
9 properties 6 required
CreateSubTppResponse
object
1 property
GatewayTimeoutError
object
The deadline expired before the operation could complete.
2 properties 1 required
inline_response_403
object
1 property 1 required
inline_response_503
object
1 property 1 required
LicensedTppSoleTrader
object
7 properties 3 required
TokenLicensedSoleTraderGB
object
7 properties 3 required
DeleteSubTppResponse
object
No data returned in the successful response.
RetrieveSubTppResponse
object
1 property
TokenLicensedNonSoleTraderPublic
object
7 properties 3 required
subTppId
string
The Token.io-generated identifier for the sub-TPP used by the reseller as the actingAs.refId in token requests.
member.LicensedTppNonSoleTraderMerchantGB
object
Contains information about the merchant member.
8 properties 6 required
OldMerchantOnboarding
object
7 properties 3 required
PermissionDeniedError
object
The error returned when the member is not authorized to perform the given operation: PermissionDenied. This error message will be accompanied by the reason fro…
1 property
ResourceExhaustedError
object
Resource exhausted. Too many requests.
2 properties 1 required
member.TokenLicensedNonSoleTraderPublicMerchantGB
object
Contains information about the merchant member.
8 properties 5 required
parentSubTppId
string
The Token.io-generated identifier for the parent sub-TPP.
LicensedTppSoleTraderGB
object
7 properties 3 required
inline_response_501
object
1 property 1 required
inline_response_401
object
1 property
CreateSubTppRequest
object
Error
object
The request does not have valid authentication credentials needed to perform the operation.
2 properties
TokenLicensedNonSoleTraderPrivateGB
object
7 properties 3 required
RetrieveSubTppsResponse
object
2 properties
inline_response_504
object
1 property 1 required
PaymentNotFoundError
object
The error object returned when given payment cannot be found: ResourceNotFound.
2 properties 1 required
LicensedTppNonSoleTrader
object
7 properties 3 required
ErrorWithCode
object
Error object providing details about the error.
2 properties 2 required
member.MerchantGB
object
Contains information about the merchant member.
6 properties 7 required
inline_response_404
object
1 property 1 required
RetrieveSubTppChildrenResponse
object
Contains each sub-TPP member onboarded by the reseller.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

token-io-sub-tpps-api-openapi.yml Raw ↑

Other APIs Token.io publishes across the network.

Token.io JavaScript SDK
Token.io PHP SDK
Token.io C# SDK
Token.io Objective-C SDK
Token.io iOS Webview SDK
Token.io Android Webview SDK
Merchant Sample (Java)
Merchant Sample (JavaScript)
Bank Sample (Java)
Personal Finance Management Sample (Java)
Merchant Integration Workshop
token-io Account on File API
Where this information came from

This is an independent, third-party profile of token-io Sub-TPPs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.