Fast-payout icon

Transfer routes

Learn how to get the optimal routes for external fund transfers.

Sending funds to transfer instruments can have additional requirements or limitations. For example, the counterparty bank that holds your user's transfer instrument may only support specific transfer priorities, or limit the amount of funds that you can send. These requirements or limitations are set by the counterparty bank or entities that regulate the counterparty bank.

If you make a transfer request that does not comply with these requirements or limitations, your transfer request fails. To prevent this problem, you can calculate the transfer route before you make a transfer request.

When you calculate a transfer route for a specific location or counterparty, you receive all supported combinations of:

  • Currencies
  • Priorities
  • Requirements

We recommend that you calculate transfer routes before sending funds to a location or counterparty for the first time. This reduces the risk of transfer failures.

Requirements

Before you begin, consider the following requirements:

Requirement Description
Integration type You must have an Adyen for Platforms integration.
API credential roles Your API credential for the Configuration API must have the following role:
  • Balance Platform BCL role

How it works

The process is as follows:

  1. You make a request for calculating transfer routes for the location or counterparty that you want to send funds to.
    This request returns all supported combinations of currencies, priorities, and requirements.
  2. You use the information from the transfer routes to make a transfer request.

Calculate transfer routes

You can make a request for calculating all available transfer routes for either a specific location or set of counterparty bank details. The following tabs explain both of these methods.

Next steps