token-io Settlement Accounts 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 Settlement Accounts. 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
10 operations
across 8 paths,
and defines 76 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.
DeleteVirtualAccountSettlementRuleResponse
object
No data returned in the successful response.
EUIbanAccount
object
Account details where the iban is required and the bic is optional.
2 properties
1 required
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…
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…
CorporateApiDebtorInformation
object
The debtor information.
1 property
1 required
ElixirAccountDebtor
The Elixir debtor account details.
GetVirtualAccountSettlementRuleResponse
object
Contains the response of the get settlement rule request.
1 property
ElixirAccountCreditor
The Elixir creditor account details.
inline_response_429
object
1 property
1 required
GatewayTimeoutError
object
The deadline expired before the operation could complete.
2 properties
1 required
inline_response_503
object
1 property
1 required
inline_response_403
object
1 property
1 required
GetVirtualAccountTransactionResponse
object
1 property
PayoutStatus
string
The Token.io Payout Initiation Status. INITIATIONPENDING - Token.io has received the payout initiation and the initiation passed Token.io validation. INITIATIO…
RawDebtorInformation
Raw debtor information. The account information (one of) is 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
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,…
Creditor
object
7 properties
inline_response_504
object
1 property
1 required
VirtualAccount
object
16 properties
GetVirtualAccountTransactionsResponse
object
2 properties
CreditorInformationPayout
object
The payout creditor object.
8 properties
SettlementRulePayout
object
The payout object.
12 properties
GetVirtualAccountByIdResponse
object
Contains the response to the create settlement account request.
1 property
NotImplementedError
object
The operation was not implemented, supported or enabled by the bank.
2 properties
1 required
inline_response_400
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
GetVirtualAccountsResponse
object
Contains the response to the get settlement accounts request.
2 properties
CreateVirtualAccountSettlementRuleResponse
object
Contains the response of the create a settlement rule request.
1 property
VirtualAccount.Status
string
CreditorInformation
The creditor information. The account information (one of) is required.
SettlementRuleStatus
string
The status of the settlement rule.
inline_response_401
object
1 property
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.
CreateVirtualAccountRequest
object
Contains the request payload to create a settlement account.
4 properties
2 required
CreateVirtualAccountResponse
object
Contains the response to the submitted request.
1 property
GetVirtualAccountSettlementPayoutsRequest
object
Contains the request payload to get settlement payouts.
11 properties
PLIbanAccount
object
Polish account details where the iban is required and the bic is optional.
2 properties
1 required
AmountType
string
The type of the amount.
CreateVirtualAccountSettlementRuleRequest
object
Contains the request payload to create a settlement rule.
10 properties
6 required
BankGiroAccount
object
Account details where the bankgiroNumber is required and the bic is optional.
2 properties
1 required
GetVirtualAccountSettlementRulesRequest
object
Contains the request payload to get settlement rules.
2 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
inline_response_500
object
1 property
PayoutInitiation
object
The initiation payload for the payout.
6 properties
6 required
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
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
VirtualAccountCreditor
object
The creditor settlement account details.
1 property
1 required
ResourceExhaustedError
object
Resource exhausted. Too many requests.
2 properties
1 required
memberId
string
The Token.io-assigned member id of the TPP.
SettlementRule
object
10 properties
Error
object
The request does not have valid authentication credentials needed to perform the operation.
2 properties
GetVirtualAccountSettlementPayoutsResponse
object
Contains the response of the get settlement payouts request.
2 properties
inline_response_404
object
1 property
1 required
Money
object
The balance currency and value.
2 properties
2 required
TimeInterval
string
The time interval.
VirtualAccountTransaction
object
Information about the requested transaction.
13 properties
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…
VirtualAccountTransactions
object
Information about the requested transaction.
9 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,…
PageInfo
object
The information about the current page, which also indicates whether the next page exists.
4 properties
1 required
Address
object
Address
8 properties
GetVirtualAccountSettlementRulesResponse
object
Contains the response of the get settlement rules request.
1 property
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
inline_response_501
object
1 property
1 required
TransactionType
string
Specifies the type of transaction.
BbanAccount
object
Account details where the bban is required and the bic is optional.
2 properties
1 required
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…
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.
