Transfer funds

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 category of the transfer.

Possible values:

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

• card: A transfer involving a third-party card.

• 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.

• topUp: An incoming transfer initiated by your user to top up their balance account.

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 within the United States and in SEPA locations.

• 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).

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 unique identifier of the source balance account.

The category of the transfer.

Possible values:

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

• card: A transfer involving a third-party card.

• interest: A transfer that settles accrued interest on a business 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.

• topUp: An incoming transfer initiated by your user to top up their balance account.

The date and time when the transfer was created, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.

The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.

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 direction of the transfer.

Possible values: incoming, outgoing.

The ID of the resource.

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

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 within the United States and in SEPA locations.

• 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). This will be removed in v4 and replaced with a new field.

Additional information about the status of the transfer.

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

The result of the transfer.

For example:

• received: an outgoing transfer request is created.
• refused: the transfer request is rejected by Adyen for one of the following reasons:
  • Transfer limit exceeded.
  • Transaction rule requirements violated.
• authorised: the transfer request is authorized and the funds are reserved.
• booked: the funds are deducted from your user's balance account.
• failed: the transfer is rejected by the counterparty's bank.
• returned: the transfer is returned by the counterparty's bank.

The type of transfer or transaction. For example, refund, payment, internalTransfer, bankTransfer.