Sign in

v1

latestOpenAPI 3.1.02026-07-2032155.0 KB
Transfers

Transfer funds

Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version.

Starts a transfer request to move funds within your balance platform, or send funds to a transfer instrument. Adyen sends the outcome of the transfer request through webhooks.

To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.

post/transfers

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

WWW-Authenticatestring

Header for authenticating through SCA

Request body

descriptionstring

A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description will be truncated in the webhooks that you receive about the transfer.

referencestring

Your unique reference for the transfer. You can use alphanumeric characters and hyphens.

Response

OK - the request has succeeded.

descriptionstring

A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description will be truncated in the webhooks that you receive about the transfer.

idstring required

Unique identifier of the transfer.

referencestring

Your unique reference for the transfer. You can use alphanumeric characters and hyphens.

refusalReasonstring

Additional information about the result of the transfer request.

resultCodestring required

The result of the transfer request.

Possible values: Authorised, Refused.