Transfer funds

post/transfers

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

Starts a request to transfer funds to balance accounts, transfer instruments, or third-party bank accounts. 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.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/btl/v4/transfers

Header Parameters

Required

Optional

Header for authenticating through SCA

Request Parameters

Required

Optional

The amount of the transfer.

Show children

The unique identifier of the source balance account.

If you want to make a transfer using a virtual bankAccount assigned to the balance account, you must specify the payment instrument ID of the virtual bankAccount. If you only specify a balance account ID, Adyen uses the default physical bankAccount payment instrument assigned to the balance account.

The type of transfer.

Possible values:

bank: a transfer involving a transfer instrument or a bank account.
internal: a transfer between balance accounts within your platform.
issuedCard: a transfer initiated by a Adyen-issued card.
platformPayment: funds movements related to payments that are acquired for your users.

The other party involved in the funds transfer. A bank account, a balance account, or a transfer instrument is required.

Show children

The unique identifier of the balance account.

Contains information about the bank account.

Show children

Information about the owner of the bank account.

Show children

Contains the bank account details. The fields required in this object depend on the country of the bank account and the currency of the transfer.

The unique identifier of the transfer instrument.

Max length: 140

Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.

Supported characters: [a-z] [A-Z] [0-9] / - ? : ( ) . , ' + Space

Supported characters for regular and fast transfers to a US counterparty: [a-z] [A-Z] [0-9] & $ % # @ ~ = + - _ ' " ! ?

The unique identifier of the source payment instrument.

If you want to make a transfer using a virtual bankAccount, you must specify the payment instrument ID of the virtual bankAccount. If you only specify a balance account ID, Adyen uses the default physical bankAccount payment instrument assigned to the balance account.

The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with category bank.

Possible values:

regular: for normal, low-value transactions.
fast: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.
wire: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.
instant: for instant funds transfers in SEPA countries.
crossBorder: for high-value transfers to a recipient in a different country.
internal: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).

Max length: 80

Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.

A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement.

Supported characters: a-z, A-Z, 0-9. The maximum length depends on the category.

internal: 80 characters
bank: 35 characters when transferring to an IBAN, 15 characters for others.

The type of transfer.

Possible values:

bankTransfer: for push transfers to a transfer instrument or a bank account. The category must be bank.
internalTransfer: for push transfers between balance accounts. The category must be internal.
internalDirectDebit: for pull transfers (direct debits) between balance accounts. The category must be internal.

The ultimate sender of the funds of the transfer (ultimate debtor).

Show children

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

202 - Accepted
The request has been accepted for processing, but the processing has not been completed.
Show moreShow less
accountHolderobject
The account holder associated with the balance account involved in the transfer.
Show children Hide children
descriptionstring
The description of the resource.
idstring
The unique identifier of the resource.
referencestring
The reference for the resource.
amountobject
The amount of the transfer.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
balanceAccountobject
Contains information about the balance account involved in the transfer.
Show children Hide children
descriptionstring
The description of the resource.
idstring
The unique identifier of the resource.
referencestring
The reference for the resource.
categorystring
The category of the transfer.

Possible values:

bank: a transfer involving a transfer instrument or a bank account.

internal: a transfer between balance accounts within your platform.

issuedCard: a transfer initiated by an Adyen-issued card.

platformPayment: funds movements related to payments that are acquired for your users.

categoryData
The relevant data according to the transfer category.
counterpartyobject
The other party in the transfer.
Show children Hide children
balanceAccountIdstring
The unique identifier of the balance account.
bankAccountobject
Contains information about the bank account.
Show children Hide children
accountHolderobject
Information about the owner of the bank account.
Show children Hide children
addressobject
Address of the bank account owner.
Show children Hide children
citystring
Min length: 3
The name of the city.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
countrystring
The two-character ISO 3166-1 alpha-2 country code. For example, US, NL, or GB.
line1string
First line of the street address.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
line2string
Second line of the street address.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
postalCodestring
Min length: 3
The postal code. Maximum length:

5 digits for an address in the US.

10 characters for an address in all other countries.

Supported characters: [a-z] [A-Z] [0-9] and Space.

stateOrProvincestring
The two-letter ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

dateOfBirthstring
The date of birth of the individual in ISO-8601 format. For example, YYYY-MM-DD. Should not be before January 1, 1900.

Allowed only when type is individual.
firstNamestring
First name of the individual.

Allowed only when type is individual.

Supported characters: [a-z] [A-Z] - . / — and Space.

fullNamestring
The name of the entity.

Supported characters: [a-z] [A-Z] [0-9] , . ; : - — / \ + & ! ? @ ( ) " ' and Space.

lastNamestring
Last name of the individual.

Allowed only when type is individual.

Supported characters: [a-z] [A-Z] - . / — and Space.

referencestring
Max length: 150
A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID.
typestring
The type of entity that owns the bank account.

Possible values: individual, organization, or unknown.
accountIdentification
Contains the bank account details. The fields required in this object depend on the country of the bank account and the currency of the transfer.
merchantobject
Contains information about the merchant.
Show children Hide children
acquirerIdstring
The unique identifier of the merchant's acquirer.
mccstring
The merchant category code.
merchantIdstring
The merchant identifier.
nameLocationobject
Contains the merchant's name and location.
Show children Hide children
citystring
The city where the merchant is located.
countrystring
The country where the merchant is located in three-letter country code format.
countryOfOriginstring
The home country in three-digit country code format, used for government-controlled merchants such as embassies.
namestring
The name of the merchant's shop or service.
rawDatastring
The raw data.
statestring
The state where the merchant is located.
postalCodestring
The merchant postal code.
transferInstrumentIdstring
The unique identifier of the transfer instrument.
creationDatestring
The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
descriptionstring
Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.

Supported characters: [a-z] [A-Z] [0-9] / - ? : ( ) . , ' + Space

Supported characters for regular and fast transfers to a US counterparty: [a-z] [A-Z] [0-9] & $ % # @ ~ = + - _ ' " ! ?
directionstring
The direction of the transfer.

Possible values: incoming, outgoing.
idstring
The ID of the resource.
paymentInstrumentobject
Contains information about the payment instrument used in the transfer.
Show children Hide children
descriptionstring
The description of the resource.
idstring
The unique identifier of the resource.
referencestring
The reference for the resource.
tokenTypestring
The type of wallet that the network token is associated with.
reasonstring
Additional information about the status of the transfer.
referencestring
Max length: 80
Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.
referenceForBeneficiarystring
A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.

Supported characters: a-z, A-Z, 0-9.The maximum length depends on the category.

internal: 80 characters

bank: 35 characters when transferring to an IBAN, 15 characters for others.

statusstring
The result of the transfer.

For example, authorised, refused, or error.
typestring
The type of transfer or transaction. For example, refund, payment, internalTransfer, bankTransfer.
401 - Unauthorized
Authentication required.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
routingDetailsarray[object]
Detailed explanation of each attempt to route the transfer with the priorities from the request.
Show children Hide children
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
prioritystring
The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with category bank.

Possible values:

regular: for normal, low-value transactions.

fast: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.

wire: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.

instant: for instant funds transfers in SEPA countries.

crossBorder: for high-value transfers to a recipient in a different country.

internal: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).

titlestring
A short, human-readable summary of the problem type.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
routingDetailsarray[object]
Detailed explanation of each attempt to route the transfer with the priorities from the request.
Show children Hide children
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
prioritystring
The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with category bank.

Possible values:

regular: for normal, low-value transactions.

fast: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.

wire: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.

instant: for instant funds transfers in SEPA countries.

crossBorder: for high-value transfers to a recipient in a different country.

internal: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).

titlestring
A short, human-readable summary of the problem type.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
Show moreShow less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
routingDetailsarray[object]
Detailed explanation of each attempt to route the transfer with the priorities from the request.
Show children Hide children
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
prioritystring
The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with category bank.

Possible values:

regular: for normal, low-value transactions.

fast: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.

wire: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.

instant: for instant funds transfers in SEPA countries.

crossBorder: for high-value transfers to a recipient in a different country.

internal: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).

titlestring
A short, human-readable summary of the problem type.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Transfer funds

Header Parameters

Request Parameters

Response parameters

HTTP Responses

202 - Accepted

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error