Sign in

v1

latestOpenAPI 3.1.02026-07-2051132407.2 KB
Transfer routes

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.

post/transferRoutes/calculate

Request body

balanceAccountIdstring

The unique identifier of the source balance account. Required if counterparty is transferInstrumentId.

balancePlatformstring required

The unique identifier assigned to the balance platform associated with the account holder.

category'bank' required

The type of transfer. Possible values:

countrystring

The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, US or NL.

Either counterparty or country field must be provided in a transfer route request.

currencystring required

The three-character ISO currency code of transfer. For example, USD or EUR.

prioritiesstring[]

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

Response

OK - the request has succeeded.