Sign in
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 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.

post/transfers

Headers

WWW-Authenticatestring

Header for authenticating through SCA

Request body

balanceAccountIdstring

The unique identifier of the source balance account.

category'bank' | 'internal' | 'issuedCard' | 'platformPayment' | 'card' required

The type of transfer.

Possible values:

  • bank: Transfer to a transfer instrument or a bank account.

  • internal: Transfer to another balance account within your platform.

  • issuedCard: Transfer initiated by a Adyen-issued card.

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

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] & $ % # @ ~ = + - _ ' " ! ?

paymentInstrumentIdstring

The unique identifier of the source payment instrument.

priority'crossBorder' | 'fast' | 'instant' | 'internal' | 'regular' | 'wire'

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: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.

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

  • instant: Instant way to transfer funds in SEPA countries.

  • crossBorder: High-value transfer to a recipient in a different country.

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

referencestring

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.

Response

OK - the request has succeeded.

balanceAccountIdstring

The unique identifier of the source balance account.

category'bank' | 'internal' | 'issuedCard' | 'platformPayment' required

The category of transfer.

Possible values:

  • bank: Transfer to a transfer instrument or a bank account.

  • internal: Transfer to another balance account within your platform.

  • issuedCard: Transfer initiated by a Adyen-issued card.

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

creationDatestring date-time

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] & $ % # @ ~ = + - _ ' " ! ?

direction'incoming' | 'outgoing'

The direction of the transfer.

Possible values: incoming, outgoing.

idstring

The ID of the resource.

paymentInstrumentIdstring

The unique identifier of the payment instrument used in the transfer.

priority'crossBorder' | 'fast' | 'instant' | 'internal' | 'regular' | 'wire'

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: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.

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

  • instant: Instant way to transfer funds in SEPA countries.

  • crossBorder: High-value transfer to a recipient in a different country.

  • internal: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). This will be removed in v4 and replaced with a new field.

reason'amountLimitExceeded' | 'approved' | 'balanceAccountTemporarilyBlockedByTransactionRule' | 'counterpartyAccountBlocked' | 'counterpartyAccountClosed' | 'counterpartyAccountNotFound' | 'counterpartyAddressRequired' | 'counterpartyBankTimedOut' | 'counterpartyBankUnavailable' | 'declinedByTransactionRule' | 'error' | 'notEnoughBalance' | 'refusedByCounterpartyBank' | 'routeNotFound' | 'scaFailed' | 'unknown'

Additional information about the status of the transfer.

referencestring

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.

status'approvalPending' | 'atmWithdrawal' | 'atmWithdrawalReversalPending' | 'atmWithdrawalReversed' | 'authAdjustmentAuthorised' | 'authAdjustmentError' | 'authAdjustmentRefused' | 'authorised' | 'bankTransfer' | 'bankTransferPending' | 'booked' | 'bookingPending' | 'cancelled' | 'capturePending' | 'captureReversalPending' | 'captureReversed' | 'captured' | 'capturedExternally' | 'chargeback' | 'chargebackExternally' | 'chargebackPending' | 'chargebackReversalPending' | 'chargebackReversed' | 'credited' | 'depositCorrection' | 'depositCorrectionPending' | 'dispute' | 'disputeClosed' | 'disputeExpired' | 'disputeNeedsReview' | 'error' | 'expired' | 'failed' | 'fee' | 'feePending' | 'internalTransfer' | 'internalTransferPending' | 'invoiceDeduction' | 'invoiceDeductionPending' | 'manualCorrectionPending' | 'manuallyCorrected' | 'matchedStatement' | 'matchedStatementPending' | 'merchantPayin' | 'merchantPayinPending' | 'merchantPayinReversed' | 'merchantPayinReversedPending' | 'miscCost' | 'miscCostPending' | 'paymentCost' | 'paymentCostPending' | 'received' | 'refundPending' | 'refundReversalPending' | 'refundReversed' | 'refunded' | 'refundedExternally' | 'refused' | 'reserveAdjustment' | 'reserveAdjustmentPending' | 'returned' | 'secondChargeback' | 'secondChargebackPending' | 'undefined' required

The result of the transfer.

For example, authorised, refused, or error.

Changes