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.

Servers

https://balanceplatform-api-test.adyen.com/bcl/v2

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`category`	String	Yes	The type of transfer. Possible values: bank: Transfer to a transfer instrument or a bank account. Possible values: `"bank"`
`balancePlatform`	String	Yes	The unique identifier assigned to the balance platform associated with the account holder.
`priorities[]`	Array	No	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).
`counterparty`	Object	No	The recipient of the funds transfer. A bank account or a transfer instrument.
`counterparty.transferInstrumentId`	String	No	The unique identifier of the transfer instrument.
`counterparty.bankAccount`	Object	No	Contains information about the bank account.
`counterparty.bankAccount.accountIdentification`	Object	Yes	Contains the bank account details. The fields required in this object depend on the country of the bank account and the currency of the transfer.
`country`	String	No	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.
`balanceAccountId`	String	No	The unique identifier of the source balance account. Required if `counterparty` is transferInstrumentId.
`currency`	String	Yes	The three-character ISO currency code of transfer. For example, USD or EUR.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.