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

A list of countries with payment details.

Body

countriesarray of object

countryIdinteger

Example: 344

countryCodestring

Example: "HK"

namestring

Example: "Hong Kong"

currenciesarray of object

currencyCodestring

Example: "HKD"

maxAmountstring

Example: "10000"

requiredMessageElementsobject

pacs008array of string

itemsstring

Example: "purposeCode"

Request

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

Response

{
  "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

Country information.

Body

idinteger

Example: 360

countryCodestring

Example: "ID"

namestring

Example: "Indonesia"

currenciesarray of object

currencyCodestring

Example: "IDR"

maxAmountstring

Example: "15000000"

requiredMessageElementsobject

pacs008array of string

itemsstring

Example: "categoryPurposeCode"

Request

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

Response

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

Retrieve All Countries in Nexus

GEThttp://localhost:3000/countries

Response

A list of countries with payment details.

Body

countriesarray of object

countryIdinteger

Example: 344

countryCodestring

Example: "HK"

namestring

Example: "Hong Kong"

currenciesarray of object

currencyCodestring

Example: "HKD"

maxAmountstring

Example: "10000"

requiredMessageElementsobject

pacs008array of string

itemsstring

Example: "purposeCode"

Request

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

Response

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

Retrieve a Single Country

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

Path parameters

countryCode*string

The ISO 3166 alpha-2 country code

Example: "ID"

Response

Country information.

Body

idinteger

Example: 360

countryCodestring

Example: "ID"

namestring

Example: "Indonesia"

currenciesarray of object

currencyCodestring

Example: "IDR"

maxAmountstring

Example: "15000000"

requiredMessageElementsobject

pacs008array of string

itemsstring

Example: "categoryPurposeCode"

Request

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

Response

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