Calculate transfer routes
Returns available transfer routes based on a combination of transfer country
, currency
, counterparty
, and priorities
. Use this endpoint to find optimal transfer priorities and associated requirements before you make a transfer.
Request Parameters
The unique identifier of the source balance account.
Required if counterparty
is transferInstrumentId.
The unique identifier assigned to the balance platform associated with the account holder.
The type of transfer. Possible values:
- bank: Transfer to a transfer instrument or a bank account.
The recipient of the funds transfer. A bank account or a transfer instrument.
The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, US or NL.
Either
counterparty
orcountry
field must be provided in a transfer route request.
The three-character ISO currency code of transfer. For example, USD or EUR.
The list of priorities for the bank transfer. Priorities set the speed at which the transfer is sent and the fees that you have to pay. Multiple values can be provided. 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).
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.