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

The Transfers API from Adyen — 4 operation(s) for transfers.

Adyen Transfers 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 Transfers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 4 operations across 4 paths, and defines 54 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 4 paths 54 schemas 4 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 Transfers 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 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Transfers 4
POST
/balanceTransfer
Adyen Start a Balance Transfer
post-balanceTransfer body → 200
POST
/transferRoutes/calculate
Adyen Calculate Transfer Routes
post-transferRoutes-calculate body → 200401403422500
POST
/transfers
Adyen Transfer Funds
post-transfers 1 param body → 200202401403422500
POST
/transfers/{transferId}/returns
Adyen Return a Transfer
post-transfers-transferId-returns 1 param body → 200401403422500

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are Transfer (15 properties), TransferInfo (10 properties), BalanceTransferResponse (9 properties), RestServiceError (9 properties). Each schema is shown below with its type and property counts.

NameLocation
object
6 properties
CALocalAccountIdentification
object
5 properties 4 required
NOLocalAccountIdentification
object
2 properties 2 required
PlatformPayment
object
6 properties
BankAccountIdentificationTypeRequirement
object
3 properties 1 required
TransferRouteRequest
object
7 properties 3 required
BRLocalAccountIdentification
object
4 properties 4 required
JSONObject
object
MerchantData
object
5 properties
CounterpartyV3
object
4 properties
ReturnTransferRequest
object
2 properties 1 required
NZLocalAccountIdentification
object
2 properties 2 required
NumberAndBicAccountIdentification
object
4 properties 3 required
AdditionalBankIdentification
object
2 properties
TransferRouteResponse
object
1 property
CZLocalAccountIdentification
object
3 properties 3 required
AddressRequirement
object
3 properties 1 required
PaymentInstrument
object
4 properties
UltimatePartyIdentification
object
7 properties 1 required
SGLocalAccountIdentification
object
3 properties 2 required
PartyIdentification
object
7 properties 1 required
ResourceReference
object
3 properties
RestServiceError
object
9 properties 5 required
BankAccount
object
1 property 1 required
AULocalAccountIdentification
object
3 properties 3 required
IssuedCard
object
8 properties
Address
object
6 properties 1 required
BalanceTransferResponse
object
9 properties 7 required
CZLocalAccountIdentification_2
object
3 properties 3 required
RelayedAuthorisationData
object
2 properties
IbanAccountIdentification
object
2 properties 2 required
BankCategoryData
object
2 properties
PLLocalAccountIdentification
object
2 properties 2 required
ServiceError
object
5 properties
DKLocalAccountIdentification
object
3 properties 3 required
TransferInfo
object
10 properties 3 required
Counterparty
object
2 properties
InternalCategoryData
object
3 properties
BankAccountV3
object
2 properties 2 required
ReturnTransferResponse
object
4 properties
TransferRoute
object
5 properties
CounterpartyInfoV3
object
3 properties
Transfer
object
15 properties 4 required
Amount
object
2 properties 2 required
USLocalAccountIdentification
object
4 properties 3 required
UKLocalAccountIdentification
object
3 properties 3 required
PaymentInstrumentRequirement
object
5 properties 1 required
SELocalAccountIdentification
object
3 properties 3 required
HKLocalAccountIdentification
object
3 properties 3 required
AmountMinMaxRequirement
object
4 properties 1 required
HULocalAccountIdentification
object
2 properties 2 required
BalanceTransferRequest
object
6 properties 4 required
TransferNotificationValidationFact
object
2 properties
InvalidField
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-transfers-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