Calculate transfer routes

post /transferRoutes/calculate

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.

Endpoint destination URL
Click to copy

Request parameters

balanceAccountId string

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

balancePlatform string Required

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

category string Required

The type of transfer. Possible values:

counterparty object

The recipient of the funds transfer. A bank account or a transfer instrument.

country string

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.

currency string Required

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

priorities array [string]

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

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

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy