Countries

Countries

Retrieve All Countries in Nexus

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. Used by: Payment Service Providers (PSPs)

GEThttp://localhost:3000/countries

Response

200

A list of countries with payment details.

Body

application/json

countriesarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/countries', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "countries": [
    {
      "countryId": 344,
      "countryCode": "HK",
      "name": "Hong Kong",
      "currencies": [
        {
          "currencyCode": "HKD",
          "maxAmount": "10000"
        }
      ],
      "requiredMessageElements": {
        "pacs008": [
          "purposeCode"
        ]
      }
    }
  ]
}

Retrieve a Single Country

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. Used by: Payment Service Providers (PSPs)

GEThttp://localhost:3000/countries/{countryCode}

Path parameters

countryCode*string

The ISO 3166 alpha-2 country code

Example: "ID"

Response

200

Country information.

Body

application/json

idinteger

Example: 360

countryCodestring

Example: "ID"

namestring

Example: "Indonesia"

currenciesarray of object

requiredMessageElementsobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/countries/{countryCode}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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