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
https://balanceplatform-api-test.adyen.com/bcl/v2/transferRoutes/calculate
Click to copy

Request Parameters

balanceAccountIdstring

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

balancePlatformstringRequired

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

categorystringRequired

The type of transfer. Possible values:

counterpartyobject

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

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.

currencystringRequired

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

prioritiesarray[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: 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.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less