token-io Pay by Link 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 Pay by Link. 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
4 operations
across 2 paths,
and defines 51 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.
LinkConfig
object
Link configuration with usage limits and expiration.
4 properties
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 -…
PaymentLinkResponse
object
Response containing a payment link.
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…
PaymentTemplate
object
The payment template containing payment details. The amount.currency is always required. For fixed amount payment links, both amount.currency and amount.value…
14 properties
3 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
EUIbanAccount
object
Account details where the iban is required and the bic is optional.
2 properties
1 required
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
CreatePaymentLinkRequest
object
Request payload to create a payment link.
2 properties
1 required
PanDetectedError
object
Error object retured when PAN is detected in the submitted initiation payload. The error code value is PanDetected.
1 property
PaymentLinksResponse
object
Response containing a list of payment links with pagination info.
2 properties
2 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
FasterPaymentsAccount
object
A UK or Irish account where the sort code and account number are required.
2 properties
2 required
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
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
PaymentLinkStatusFilter
string
Status of the payment link: LINKACTIVE - Link is active and can be used LINKEXPIRED - Link has expired LINKCANCELED - Link has been manually canceled USAGELIMI…
ClearingNumberAccount
object
Account details where the bban is required and the clearing number 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…
SepaAccount
object
SEPA account details where the iban is required and the bic is optional.
2 properties
1 required
inline_response_403
object
1 property
1 required
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
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
PLAccount
object
Polish account details where the account number is required and the bic is optional.
2 properties
1 required
CreditorInformation
The creditor information. The account information (one of) is required.
PaymentLink
object
The payment link object.
8 properties
7 required
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…
ExternalPsuReference
string
An external reference provided by the TPP (Third Party Provider) to uniquely identify the PSU (Payment Service User).
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
CurrentUsage
object
Current usage statistics for the payment link.
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
ErrorWithCode
object
Error object providing details about the error.
2 properties
2 required
OnBehalfOfId
string
The on-behalf-of ID is validated against the sub-TPP id of the member. This field is mandatory for unregulated TPPs.
SepaInstantAccount
object
SEPA Instant account details where the iban is required and the bic is optional.
2 properties
1 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…
inline_response_404
object
1 property
1 required
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.
