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

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.

Changes

Changed in 11 of the 39 revisions of this API.562435

Oct 30, 2024v1e9e1cc8dbd971See the full diff
- ○
  added the new optional header request parameter Idempotency-Key
  new-optional-request-parameter
Jun 5, 2024v1ffa62583a3ce3See the full diff
- ○
  added the optional property routingDetails to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property routingDetails to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property routingDetails to the response with the 500 status
  response-optional-property-added
Dec 20, 2023v1b6626bee4e9b1See the full diff
- ○
  the endpoint scheme security clientKey was added to the API
  api-security-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 27, 2023v16a461735ce656See the full diff
- ●
  removed the optional property response/paths from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property response/paths from the response with the 422 status
  response-optional-property-removed
- ●
  removed the optional property response/paths from the response with the 500 status
  response-optional-property-removed
- ●
  removed the optional property response/rootPath from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property response/rootPath from the response with the 422 status
  response-optional-property-removed
- ●
  removed the optional property response/rootPath from the response with the 500 status
  response-optional-property-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 27, 2023v1e8d0f4dc4d40544See the full diff
- ▲
  the response property errorCode became optional for the status 401
  response-property-became-optional
- ▲
  the response property status became optional for the status 401
  response-property-became-optional
- ▲
  removed the required property detail from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property title from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property type from the response with the 401 status
  response-required-property-removed
- ●
  removed the optional property instance from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property invalidFields from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property requestId from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property response from the response with the 401 status
  response-optional-property-removed
- ○
  added the new optional header request parameter WWW-Authenticate
  new-optional-request-parameter
- ○
  added the optional property errorType to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property pspReference to the response with the 401 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 20, 2023v127fc86f6c3501See the full diff
- ○
  the endpoint scheme security BasicAuth was added to the API
  api-security-added
Feb 21, 2023v1a241130043aa28See the full diff
- ▲
  the request's body type/format changed from / to object/
  request-body-type-changed
- ▲
  the amount request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the destination request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the source request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 403
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 422
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ▲
  the amount response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the destination response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the invalidFields/items/ response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the invalidFields/items/ response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ▲
  the invalidFields/items/ response's property type/format changed from / to object/ for status 422
  response-property-type-changed
- ▲
  the invalidFields/items/ response's property type/format changed from / to object/ for status 500
  response-property-type-changed
- ▲
  the response response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the response response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ▲
  the response response's property type/format changed from / to object/ for status 422
  response-property-type-changed
- ▲
  the response response's property type/format changed from / to object/ for status 500
  response-property-type-changed
- ▲
  the response/paths/items/ response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the response/paths/items/ response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ▲
  the response/paths/items/ response's property type/format changed from / to object/ for status 422
  response-property-type-changed
- ▲
  the response/paths/items/ response's property type/format changed from / to object/ for status 500
  response-property-type-changed
- ▲
  the response/rootPath response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the response/rootPath response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ▲
  the response/rootPath response's property type/format changed from / to object/ for status 422
  response-property-type-changed
- ▲
  the response/rootPath response's property type/format changed from / to object/ for status 500
  response-property-type-changed
- ▲
  the source response's property type/format changed from / to object/ for status 200
  response-property-type-changed
Sep 2, 2022v1a6fcc469131a44See the full diff
- ▲
  removed the required property errorType from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property errorType from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property errorType from the response with the 422 status
  response-required-property-removed
- ▲
  removed the required property errorType from the response with the 500 status
  response-required-property-removed
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 403 status
  response-required-property-added
- ○
  added the required property type to the response with the 422 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 2, 2022v1140c9570ac9c2See the full diff
- ○
  api tag Transfers added
  api-tag-added
- ○
  api tag General removed
  api-tag-removed
Feb 15, 2022v1247843f3d3dc14See the full diff
- ●
  the reference request property's maxLength was set to 80
  request-property-max-length-set
- ○
  added the optional property response to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property response to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property response to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property response to the response with the 500 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (11 revisions)