Utilities

Get supported countries and subdivisions for a fiat rail code

Changed on

Returns valid country and subdivision codes for a specific fiat rail code.

get/api/utilities/countries/{fiatRailCode}

Request

Path parameters

fiatRailCode'usd' | 'cop' | 'cop-bre-b' | 'cop-cobre-balance' | 'ars' | 'eur' | 'mxn' | 'mxn-debit-card' | 'brl' | 'clp' | 'pen' | 'bob' | 'crc' | 'zar' | 'usd-peru' | 'usd-china' | 'usd-panama' | 'usd-hong-kong' | 'usd-el-salvador' required

Fiat rail code that identifies the currency and rail combination

Response

List of countries and subdivisions allowed for the specified fiat rail code

countnumber required

Total number of countries

Example response

{
  "count": 3,
  "countries": [
    {
      "alpha2Code": "US",
      "name": "United States",
      "subdivisions": [
        {
          "code": "NY",
          "name": "New York"
        }
      ]
    }
  ]
}

Changes

    • warning

      added the new SignedAgreementRequiredException enum value to the response property for the response status

    • info

      added the new enum value mxn-debit-card to the path request parameter fiatRailCode

    • info

      added the new enum value usd-el-salvador to the path request parameter fiatRailCode

    • info

      added the non-success response with the status