Countries

Countries

Retrieve All Countries in Nexus

get

Returns all countries available on the Nexus network, along with key reference data for sending payments to those countries, such as maximum transaction amounts and requirements for category purpose codes.

Responses

200

A list of countries with payment details.

application/json

get

HTTPcURLJavaScriptPython

GET /countries HTTP/1.1
Host: localhost:3000
Accept: */*

200

A list of countries with payment details.

{
  "countries": [
    {
      "countryId": 344,
      "countryCode": "HK",
      "name": "Hong Kong",
      "currencies": [
        {
          "currencyCode": "HKD",
          "maxAmount": "10000"
        },
        {
          "currencyCode": "CNY",
          "maxAmount": "20000"
        }
      ],
      "requiredMessageElements": {
        "pacs008": [
          "purposeCode"
        ]
      }
    },
    {
      "countryId": 360,
      "countryCode": "ID",
      "name": "Indonesia",
      "currencies": [
        {
          "currencyCode": "IDR",
          "maxAmount": "15000000"
        }
      ],
      "requiredMessageElements": {
        "pacs008": [
          "categoryPurposeCode"
        ]
      }
    },
    {
      "countryId": 458,
      "countryCode": "MY",
      "name": "Malaysia",
      "currencies": [
        {
          "currencyCode": "MYR",
          "maxAmount": "10000000.00"
        }
      ],
      "requiredMessageElements": {
        "pacs008": [
          "purposeCode"
        ]
      }
    },
    {
      "countryId": 702,
      "countryCode": "SG",
      "name": "Singapore",
      "currencies": [
        {
          "currencyCode": "SGD",
          "maxAmount": "200000"
        }
      ],
      "requiredMessageElements": {
        "pacs008": [
          "purposeCode"
        ]
      }
    },
    {
      "countryId": 608,
      "countryCode": "PH",
      "name": "Philippines",
      "currencies": [
        {
          "currencyCode": "PHP",
          "maxAmount": "50000"
        }
      ],
      "requiredMessageElements": {
        "pacs008": [
          "categoryPurposeCode"
        ]
      }
    },
    {
      "countryId": 764,
      "countryCode": "TH",
      "name": "Thailand",
      "currencies": [
        {
          "currencyCode": "THB",
          "maxAmount": "2000000"
        }
      ],
      "requiredMessageElements": {
        "pacs008": [
          "categoryPurposeCode"
        ]
      }
    }
  ]
}

Retrieve a Single Country

get

Returns a specified country based on the 2-letter countryCode provided, along with key reference data for sending payments to that country, such as maximum transaction amounts and requirements for category purpose codes.

Path parameters

countryCodestringRequired

The ISO 3166 alpha-2 country code

Example: ID

Responses

200

Country information.

application/json

get

HTTPcURLJavaScriptPython

GET /countries/{countryCode} HTTP/1.1
Host: localhost:3000
Accept: */*

200

Country information.

{
  "id": 360,
  "countryCode": "ID",
  "name": "Indonesia",
  "currencies": [
    {
      "currencyCode": "IDR",
      "maxAmount": "15000000"
    }
  ],
  "requiredMessageElements": {
    "pacs008": [
      "categoryPurposeCode"
    ]
  }
}