token-io Transfers - for Payments v1 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 Transfers - for Payments v1. 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
3 operations
across 2 paths,
and defines 96 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.
EUIbanAccount
object
Account details where the iban is required and the bic is optional.
2 properties
1 required
TransferDestinationRequest
object
The beneficiary account specifying the transfer destination, i.e. TPP/merchant/creditor bank.
2 properties
10 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…
FasterPaymentsAccount
object
A UK or Irish account where the sort code and account number are required.
2 properties
2 required
StetAccountIdentification
object
Bank-defined account identifiers.
2 properties
CustomerDataDebtorResponse
object
Specifies the legal identity information for the payer/customer.
2 properties
TransferDestinationToken
object
The primary account number. The cCard identifier found on payment cards, such as credit and debit cards, as well as stored-value cards, gift cards and other si…
2 properties
inline_response_429
object
1 property
1 required
Signature
object
Contains information about the signing party. This is only present if a tokenId is present. It can be used to validate that the provided tokenId corresponds to…
3 properties
AccountIdentifierPlusgiro
object
The domestic transaction clearing system in Sweden. The credit transfer function, which is part of Nordea , and used for mediating payments between accounts he…
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
MoneyRequest
object
The balance currency and value.
2 properties
TransferDebtorEndpointResponse
object
Contains information about the payer account.
4 properties
1 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
TransactionStatus
string
Filters by transaction status. PROCESSING – This status indicates that the transaction is in process and that the final status has not been received from the b…
SENoBankIdAccount
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
RefundInfo
object
Contains information about each refund initiation record in the list.
2 properties
AccountIdentifierBban
object
2 properties
StetRegulatoryReportingCodes
object
Contains the list of needed regulatory reporting codes for international payments.
1 property
Cma9Risk
object
This object specifies additional details for risk scoring of payments.
7 properties
AccountIdentifierMsisdn
object
The Mobile Station International Subscriber Director Number (MSISDN) is the user's mobile phone number, used as a unique identifier to enable routing of voice…
1 property
CreateTransferRequest
object
1 property
1 required
inline_response_504
object
1 property
1 required
TransferDestinationType
string
Specifies the type of transfer destination.
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 -…
NotImplementedError
object
The operation was not implemented, supported or enabled by the bank.
2 properties
1 required
CustomerData
object
Specifies the legal identity information for the account. This information is not required for settlement accounts.
2 properties
inline_response_400
object
1 property
AccountIdentifier
object
Account numbers and other strings that identify this as a unique bank account.
8 required
StetGenericIdentification
object
Bank-defined account information.
3 properties
TransferDestinationFasterPayments
TransferDestinationVirtualAccount
object
The details of the transfer destination for the settlement account. This destination is mandatory for unregulated TPPs.
2 properties
2 required
TransferDestinationEuDomesticNonEuroInstant
The instant payment system within a country using that country's non-Euro domestic currency. An IBAN account will require an iban and an optional bic, a BBAN a…
ProviderTransferMetadata
object
The transfer metadata required under the Open Banking API standard adopted by the bank.
Transfer
object
Information about each respective transfer record requested.
14 properties
ServiceUnavailableError
object
Service is unavailable, likely due to a transient condition; this is usually corrected with a retry.
2 properties
1 required
StetFinancialInstitutionIdentification
object
The unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
4 properties
ActingAs
object
Specifies another party for whom the token was created 'on behalf of'.
3 properties
StetPaymentTypeInformation
object
A set of elements used to further specify the type of transaction.
4 properties
Cma9BeneficiaryAccountType
string
To be provided if the AccountType is known.
StetClearingSystemMemberIdentification
object
Identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank.
2 properties
ExternalAuthorizationDetails
object
Contains the external authorization details provided by the bank.
1 property
TransferDestination
object
The beneficiary account specifying the transfer destination, i.e. TPP/merchant/creditor bank.
2 properties
10 required
instructionIdentification
string
The TPP-generated, unique transaction id passed to the bank (mandatory) but does not have to go any further in the payment flow. The expectation is that this i…
StetTransferMetadata
object
Transfer metadata required under the French PSD2 API standard .
6 properties
TransferPayload
object
Contains the financial details of the transfer.
7 properties
3 required
StetPostalAddressCreditor
object
Contains the mailing address of the creditor.
2 properties
AccountIdentifierIban
object
The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders.
1 property
inline_response_401
object
1 property
GetTransfersResponse
object
2 properties
StetPartyIdentification
object
The ISO 20022 information about the party; this can be either a person or an organisation.
4 properties
PaymentNotFoundError
object
The error object returned when given payment cannot be found: ResourceNotFound.
2 properties
1 required
TransferRefund
object
Contains details of the refunded amount settled, the transfer balance remaining, and whether initiated.
3 properties
AccountIdentifierToken
object
The primary account number; the card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and oth…
2 properties
AccountIdentifierBankgiro
object
The identifier for domestic bank accounts in Sweden.
1 property
DeliveryAddress
object
Specifies the recipient's delivery address details.
10 properties
TransferRefundStatus
string
Indicates the status of the initiated refund payout.
BankGiroAccount
object
Account details where the bankgiroNumber is required and the bic is optional.
2 properties
1 required
TransferPayloadRequest
object
Contains the financial details of the transfer.
7 properties
1 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
TransferDestinationSepaInstant
inline_response_500
object
1 property
TransferDestinationBankgiro
PlusGiroAccount
object
Account details where the plusgiroNumber is required and the bic is optional.
2 properties
1 required
ClearingNumberAccount
object
Account details where the bban is required and the clearing number is optional.
2 properties
1 required
NextGenPsd2TransferMetadata
object
The transfer metadata required under the NextGenPSD2 standard .
4 properties
AddressInfo
object
The complete postal address of a party.
16 properties
AccountIdentifierGbDomestic
object
A domestic bank account in the UK.
2 properties
TransferDestinationEuDomesticNonEuro
The payment system within a country using that country's non-Euro domestic currency. An IBAN account will require an iban and an optional bic, a BBAN account w…
ResourceExhaustedError
object
Resource exhausted. Too many requests.
2 properties
1 required
Error
object
The request does not have valid authentication credentials needed to perform the operation.
2 properties
CreateTransferResponse
object
2 properties
StetBeneficiary
object
The creditor or payee receiving the transfer.
4 properties
PolishApiDeliveryMode
string
The urgency classification for delivery.
inline_response_404
object
1 property
1 required
ProviderTransferDetails
object
Information about the transfer.
2 properties
GetTransferResponse
object
1 property
TransferDestinationElixir
object
The interbank payment system in Poland.
1 property
1 required
PolishApiTransferMetadata
object
Transfer metadata required under the Polish API standard .
2 properties
Metadata
object
Information governing or otherwise related to the transfer instructions.
5 properties
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…
Money
object
The balance currency and value.
2 properties
2 required
CustomerDataCreditor
object
Specifies the legal identity information for the payee. This information is not required for settlement accounts.
2 properties
1 required
Cma9TransferMetadata
object
Transfer metadata required under the CMA9 API standard .
3 properties
AccountIdentifierPan
object
The Primary Account Number (PAN). The card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards a…
1 property
SepaAccount
object
SEPA account details where the iban is required and the bic is optional.
2 properties
1 required
TransferDestinationPlusgiro
StetPostalAddress
object
Contains the mailing address of the creditor.
2 properties
inline_response_501
object
1 property
1 required
BbanAccount
object
Account details where the bban is required and the bic is optional.
2 properties
1 required
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.…
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Token.io publishes across the network.
