Routes

Endpoints
GET/v1/routes
GET/v1/profiles/{{profileId}}/routes

The Routes resource

Fields
sourceCurrencies.currencyCodetext

Source currency code (ISO 4217 Alphabetic Code)

sourceCurrencies.popularityIndexinteger

Indicates a popular source currency. The most popular one has the index 0.

sourceCurrencies.recentUsageIndexinteger

Indicates a recently used source currency. The most recently used one has the index 0.

sourceCurrencies.totalTargetCurrenciesinteger

The number of allowed target currencies for this source currency.

targetCurrencies.currencyCodetext

Target currency code (ISO 4217 Alphabetic Code)

targetCurrencies.popularityIndexinteger

Indicates a popular target currency. The most popular one has the index 0.

targetCurrencies.recentUsageIndexinteger

Indicates a recently used target currency. The most recently used one has the index 0.

totalinteger

The number of allowed source currencies.

Currencies Object
{
  "sourceCurrencies": [
    {
      "currencyCode": "CAD",
      "targetCurrencies": [
        {
          "currencyCode": "AUD"
        },
        {
          "currencyCode": "CAD"
        },
        {
          "currencyCode": "EUR",
          "popularityIndex": 0,
          "recentUsageIndex": 0
        },
        ...
      ],
      "totalTargetCurrencies": 55,
      "recentUsageIndex": 0
    },
    {
      "currencyCode": "GBP",
      "targetCurrencies": [
        {
          "currencyCode": "AUD",
          "popularityIndex": 0
        },
        {
          "currencyCode": "EUR",
          "popularityIndex": 1,
          "recentUsageIndex": 0
        },
        {
          "currencyCode": "GBP",
          "recentUsageIndex": 1
        },
        ...
      ],
      "totalTargetCurrencies": 55,
      "popularityIndex": 0,
      "recentUsageIndex": 1
    },
    ...
  ],
  "total": 28
}

Get all routes allowed for transfers

GET /v1/routes

Get the list of allowed routes that you can use for transfers.

Request
payInCountrytext

(Optional) Payin country code (ISO 3166-1 Alpha-2 code)

payInMethodtext

(Optional) Payin method name

payOutMethodtext

(Optional) Payout method name

Response

Returns a routes object.

Example Request
curl -X GET https://api.sandbox.transferwise.tech/v1/routes
        ?payInCountry=GB
        &payInMethod=BANK_TRANSFER
        &payOutMethod=BANK_TRANSFER \
     -H 'Authorization: Bearer {{API token}}'

Get all routes allowed for transfers

GET /v1/profiles/{{profileId}}/routes

Get the list of allowed routes that you can use for transfers.

Request
payInMethodtext

(Optional) Payin method name

payOutMethodtext

(Optional) Payout method name

Response

Returns a routes object.

Example Request
curl -X GET https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/routes
        ?payInMethod=BANK_TRANSFER
        &payOutMethod=BANK_TRANSFER \
     -H 'Authorization: Bearer {{API token}}'