token-io Payments v2 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 Payments v2. 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 4 paths,
and defines 73 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.
The identity and technical contract details declared by the specification.
errorInfo
object
This field will be populated if the status is final and the payment is not successful, or there has been an error that caused payment rejection, or the bank co…
4 properties
1 required
ChargeBearer
string
The bearer of the charge, if any, for international transfers. CRED - all charges are borne by the creditor. DEBT - all charges are borne by the debtor. SHAR -…
EmbeddedAuth
object
Information and fields presented to the user in order to collect the requested data. This should be populated if the payment status is INITIATIONPENDINGEMBEDDE…
5 properties
1 required
PaymentInitiation
object
The initiation payload for the payment. All standard flow types — amount and remittanceInformationPrimary are required.
21 properties
7 required
EUIbanAccount
object
Account details where the iban is required and the bic is optional.
2 properties
1 required
FieldError
object
An error object providing details about an error caused by a particular field or fields in the request. Possible error code values include: Field.NotUnique - T…
1 property
1 required
remittanceInformationPrimary
string
The primary field for remittance information. This should contain a reference, as assigned by the creditor, to unambiguously refer to the payment transactions…
PaymentContextCode
string
This field describes the context of the payment context. This field is an OBIE standard and also maps to NextGenPsd2 's purposeCode and categoryPurposeCode fie…
PLIbanAccount
object
Polish account details where the iban is required and the bic is optional.
2 properties
1 required
PaymentFlowType
string
The integration option requested by the TPP. APIONLY - This is the default. The TPP owns the user experience including bank selection logic, collection of mand…
inline_response_400
object
1 property
PanDetectedError
object
Error object retured when PAN is detected in the submitted initiation payload. The error code value is PanDetected.
1 property
paymentIdEmbeddedAuthBody
object
1 property
EmbeddedAuthFields
object
This field provides a map of all fields requested for embedded authentication, with their values. The key is the id of the field from the authentication payloa…
EUDomesticNonEuroAccountDebtor
The payment system within a European country using that country's non-Euro domestic currency. An IBAN account will require an iban and an optional bic, a BBAN…
RefundDetails
object
The refund-related information for this payment. This field requires specific permission and is only available if paymentInitiation.returnRefundAccount is set…
4 properties
1 required
BankGiroAccount
object
Account details where the bankgiroNumber is required and the bic is optional.
2 properties
1 required
inline_response_400_2
object
1 property
1 required
pispConsentAccepted
boolean
This flag indicates whether the user has granted consent for the payment in the TPP's user interface.
FasterPaymentsAccount
object
A UK or Irish account where the sort code and account number are required.
2 properties
2 required
refId
string
The TPP-generated reference identifier for the token. This is not to be confused with the requestId. The refId maps to the tppRefId in the bank's consentReques…
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
RedirectUrl
object
1 property
1 required
ElixirAccountDebtor
The Elixir debtor account details.
ElixirAccountCreditor
The Elixir creditor account details.
inline_response_500
object
1 property
PlusGiroAccount
object
Account details where the plusgiroNumber is required and the bic is optional.
2 properties
1 required
PaymentLinkStatus
string
If the payment was initiated using a Pay by Link flow type, this shows the status of the payment link. For all other flows, this field is empty. LINKACTIVE – T…
inline_response_400_4
object
1 property
1 required
RequiredField
object
Contains information used in embedded authentication flows. These are optional credential request fields.
5 properties
3 required
SepaAccount
object
SEPA account details where the iban is required and the bic is optional.
2 properties
1 required
EUDomesticNonEuroAccountCreditor
The payment system within a European country using that country's non-Euro domestic currency. An IBAN account will require an iban and an optional bic, a BBAN…
ClearingNumberAccount
object
Account details where the bban is required and the clearing number is optional.
2 properties
1 required
PaymentsResponse
object
2 properties
2 required
inline_response_403
object
1 property
1 required
callbackStatev2
string
The uniquely-generated string included as part of the URL when communicating with the bank. It is sent to the bank during payment initiation and is also return…
PaymentStatus
string
The Token.io Payment Status: INITIATIONPENDING - Token.io has received the payment initiation and the initiation has passed Token.io's validation. No action is…
RefundAccount
The account to which the refund should be sent.
TokenBankError
object
Error object providing details about an error related to the debtor bank. Possible error code values include: - Bank.RegistrationNotFound - unable to find regi…
2 properties
EUDomesticNonEuroInstantAccountCreditor
The instant payment system within a European country using that country's non-Euro domestic currency. An IBAN account will require an iban and an optional bic,…
SENoBankIdCreditorAccount
object
Account details where the iban and bban are required and the bic and clearing number are optional. This is ONLY allowed for an HP flow if there is no bankId pr…
4 properties
2 required
remittanceInformationSecondary
string
The secondary field for remittance information. The information supplied should enable the reconciliation of an entry in an unstructured form. Depending on the…
Payment
object
The payment object.
17 properties
6 required
v2_payments_body
object
3 properties
1 required
PageInfo
object
The information about the current page, which also indicates whether the next page exists.
4 properties
1 required
VirtualAccountCreditor
object
The creditor settlement account details.
1 property
1 required
Address
object
Address
8 properties
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
RawDebtorInformation
Raw debtor information. The account information (one of) is required.
PLAccount
object
Polish account details where the account number is required and the bic is optional.
2 properties
1 required
Amount
object
The transaction amount and currency.
2 properties
2 required
CreditorInformation
The creditor information. The account information (one of) is required.
TokenizedAccountIdentifier
object
1 property
1 required
EUDomesticNonEuroInstantAccountDebtor
The instant payment system within a European country using that country's non-Euro domestic currency. An IBAN account will require an iban and an optional bic,…
memberId
string
The Token.io-assigned member id of the TPP.
ExternalPsuReference
string
An external reference provided by the TPP (Third Party Provider) to uniquely identify the PSU (Payment Service User).
LocalInstrument
string
The bank's payment service used to make the payment. Depending on which local instrument you select, you will require different account identifiers in the debt…
callbackUrl
string
The TPP's url that Token.io calls back to. This url should not be under the token.io domain and must be https/SSL secure.
inline_response_401
object
1 property
Error
object
The request does not have valid authentication credentials needed to perform the operation.
2 properties
BbanAccount
object
Account details where the bban is required and the bic is optional.
2 properties
1 required
Risk
object
This field is used to specify additional details for the risk scoring of payments.
8 properties
bankId
string
The Token.io id of the bank where the consent is created. This field is required if the customer is not using Token.io's Hosted Pages for bank selection, i.e.…
AccountVerificationId
string
The Id returned from the /account-verifications endpoint and used to identify the account verification relating to the beneficiary of the payment. Only require…
PaymentNotFoundError
object
The error object returned when given payment cannot be found: ResourceNotFound.
2 properties
1 required
DebtorInformation
Debtor information. Provide either an Account on File OR full Debtor Account details. These two modes are mutually exclusive.
ErrorWithCode
object
Error object providing details about the error.
2 properties
2 required
SepaInstantAccount
object
SEPA Instant account details where the iban is required and the bic is optional.
2 properties
1 required
PaymentRefundStatus
string
The refund status for this payment.
inline_response_404
object
1 property
1 required
Authenticationv2
object
The authentication operation required to proceed with payment creation. This is present when additional steps are required to authorize the payment.
PaymentResponse
object
1 property
DeliveryAddress
object
Specifies the recipient's delivery address details.
10 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Token.io publishes across the network.
