Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adyen transferInstruments API

The transferInstruments API from Adyen — 2 operation(s) for transferinstruments.

Adyen transferInstruments API is one of 202 APIs that Adyen publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include transferInstruments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 4 operations across 2 paths, and defines 29 schemas. It is described by OpenAPI 3.1.0, at version 6.

Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.

4 operations 2 paths 29 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Adyen transferInstruments API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 4

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

transferInstruments 4
POST
/transferInstruments
Adyen Create a Transfer Instrument
post-transferInstruments 1 param body → 200400401403422500
DELETE
/transferInstruments/{id}
Adyen Delete a Transfer Instrument
delete-transferInstruments-id 1 param → 204400401403422500
GET
/transferInstruments/{id}
Adyen Get a Transfer Instrument
get-transferInstruments-id 1 param → 200400401403422500
PATCH
/transferInstruments/{id}
Adyen Update a Transfer Instrument
patch-transferInstruments-id 2 params body → 200400401403422500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are TransferInstrument (7 properties), DocumentReference (7 properties), VerificationError (6 properties), BankAccountInfo (5 properties). Each schema is shown below with its type and property counts.

TransferInstrument
object
7 properties 4 required
CALocalAccountIdentification
object
5 properties 4 required
NOLocalAccountIdentification
object
2 properties 2 required
NZLocalAccountIdentification
object
2 properties 2 required
NumberAndBicAccountIdentification
object
4 properties 3 required
AdditionalBankIdentification
object
2 properties
CZLocalAccountIdentification
object
3 properties 3 required
CapabilityProblem
object
2 properties
CapabilityProblemEntity-recursive
object
3 properties
BankAccountInfo
object
5 properties
SGLocalAccountIdentification
object
3 properties 2 required
AULocalAccountIdentification
object
3 properties 3 required
DocumentReference
object
7 properties
SupportingEntityCapability
object
4 properties
DocumentPage
object
3 properties
IbanAccountIdentification
object
2 properties 2 required
PLLocalAccountIdentification
object
2 properties 2 required
ServiceError
object
5 properties
TransferInstrumentInfo
object
3 properties 3 required
DKLocalAccountIdentification
object
3 properties 3 required
VerificationError-recursive
object
5 properties
RemediatingAction
object
2 properties
CapabilityProblemEntity
object
4 properties
USLocalAccountIdentification
object
4 properties 3 required
UKLocalAccountIdentification
object
3 properties 3 required
SELocalAccountIdentification
object
3 properties 3 required
HKLocalAccountIdentification
object
3 properties 3 required
HULocalAccountIdentification
object
2 properties 2 required
VerificationError
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-transferinstruments-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolders API
Adyen accountHolderTransactionList API
Adyen Accounting Notifications API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen applePay API