Sign in
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.

Changes

Changed in 16 of the 51 revisions of this API.63929

  • v20ec7e1e654c72See the full diff
    • ○

      added discriminator to // request property

      request-property-discriminator-added

    • ○

      added discriminator to /// response property for the response status

      response-property-discriminator-added

  • v2a4fab1c7333b41See the full diff
    • ●

      added the new inLocal enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new jpLocal enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mxLocal enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new myLocal enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property ///////

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v2c6628742df821See the full diff
    • ○

      the /////// request property's maxLength was increased from 15 to 17

      request-property-max-length-increased

  • v217ba2ebaaab01See the full diff
    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

  • v29fede8325f6d1See the full diff
    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

  • v2e3e73751fdd52See the full diff
    • ○

      added the new auBsbCode enum value to the request property ////////

      request-property-enum-value-added

    • ○

      added the new caRoutingNumber enum value to the request property ////////

      request-property-enum-value-added

  • v254394ef9b9ec1See the full diff
    • ●

      added the new interest enum value to the // response property for the response status

      response-property-enum-value-added

  • v2e69e67d2e6921See the full diff
    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

  • v25c1b264dd7b81See the full diff
    • ▲

      added to the /// response property oneOf list for the response status

      response-property-one-of-added

  • v2e284ff9a82901See the full diff
    • ○

      added the new optional request property ///////

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog