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 Refunds API

These endpoints allow you to handle registration, posting, and retrieval of refunds associated with original transaction account information.

token-io Refunds 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 Refunds. 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 3 paths, and defines 50 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.

4 operations 3 paths 50 schemas 3 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 Refunds 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 4

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

Refunds 4

These endpoints allow you to handle registration, posting, and retrieval of refunds associated with original transaction account information.

POST
/refunds
Initiate a refund
InitiateRefund body → 200400401403404429500501
GET
/refunds
Get refunds
GetRefunds 11 params → 200400401403404429500501
GET
/refunds/{id}
Get a refund
GetRefund 1 param → 200400401403404429500501
GET
/transfers/{id}/refunds
Get all refunds by transfer
GetTransferRefunds 3 params → 200400401403404429500501

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are RefundInitiation (9 properties), Refund (9 properties), ResolvedRefundInitiation (8 properties), Address (8 properties). Each schema is shown below with its type and property counts.

NotImplementedError
object
The operation was not implemented, supported or enabled by the bank.
2 properties 1 required
EUIbanAccount
object
Account details where the iban is required and the bic is optional.
2 properties 1 required
inline_response_400
object
1 property
PLIbanAccount
object
Polish account details where the iban is required and the bic is optional.
2 properties 1 required
RefundsResponse
object
2 properties
StatusRefund
string
The Token.io Refund Initiation Status. INITIATIONPENDING - Token.io has received the refund initiation and the initiation has passed Token.io's validation. INI…
BankGiroAccount
object
Account details where the bankgiroNumber is required and the bic is optional.
2 properties 1 required
ResolvedRefundInitiation
object
The Initiation payload for the refund.
8 properties 7 required
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
CorporateApiDebtorInformation
object
The debtor information.
1 property 1 required
Refund
object
The refund object.
9 properties 5 required
ElixirAccountCreditor
The Elixir creditor account details.
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
inline_response_500
object
1 property
PlusGiroAccount
object
Account details where the plusgiroNumber is required and the bic is optional.
2 properties 1 required
RefundInitiation
object
The Initiation payload for the refund.
9 properties 6 required
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
RefundDebtorInformation
The debtor information. Account information (one of) is required.
inline_response_403
object
1 property 1 required
inline_response_503
object
1 property 1 required
GatewayTimeoutError
object
The deadline expired before the operation could complete.
2 properties 1 required
RefundResponse
object
1 property
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
refunds_body
object
1 property 1 required
Address
object
Address
8 properties
VirtualAccountCreditor
object
The creditor settlement account details.
1 property 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
PLAccount
object
Polish account details where the account number is required and the bic is optional.
2 properties 1 required
originalPaymentId
string
The original payment id from Token.io payments/transfers. This is required to initiate a refund. Token.io will check the original payment for the refund valida…
Amount
object
The transaction amount and currency.
2 properties 2 required
PagingInfo
object
2 properties
CreditorInformation
The creditor information. The account information (one of) is required.
ResourceExhaustedError
object
Resource exhausted. Too many requests.
2 properties 1 required
memberId
string
The Token.io-assigned member id of the TPP.
inline_response_501
object
1 property 1 required
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
inline_response_504
object
1 property 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…
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
SepaInstantAccount
object
SEPA Instant account details where the iban is required and the bic is optional.
2 properties 1 required
inline_response_404
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

token-io-refunds-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 Refunds 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.