Countries

Countries

Retrieve All Countries in Nexus

get

http://localhost:8080https://nexus-ai-simulator-683365449922.asia-southeast1.run.app

/v1/countries

Returns all countries available on the Nexus network, along with key reference data for sending payments to those countries, such as minimum and maximum transaction amounts per currency, currency names and decimal places, requirements for message elements, the country level SLA with maximum execution timeouts as ISO 8601 durations, and the supported instruction priorities. Where a country has more than one IPS, the sla carries the most relaxed timeout across those IPSs and supportedInstructionPriorities carries the union of priorities across those IPSs. Used by: Payment Service Providers (PSPs)

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

A list of countries with payment details.

application/json

400

Invalid request. Reason code TE001 INVALID_REQUEST.

application/json

401

Authentication failed. Applicable reason codes: AE001 AUTH_TOKEN_MISSING, AE002 AUTH_TOKEN_INVALID.

application/json

403

Authorization failed. The token is valid but its OAuth2 scopes do not grant access to this endpoint or corridor. Reason code AE004 ACCESS_DENIED.

application/json

429

Rate limit exceeded. Returned by the API gateway and carries no structured Nexus body. The Retry-After response header indicates when to retry.

500

An unhandled exception or infrastructure failure occurred. Reason code TE099 INTERNAL_ERROR. The caller may retry with exponential backoff.

application/json

get/v1/countries

HTTPcURLJavaScriptPython

GET /v1/countries HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "countries": [
    {
      "countryId": 344,
      "countryCode": "HK",
      "name": "Hong Kong",
      "currencies": [
        {
          "currencyCode": "HKD",
          "currencyName": "Hong Kong Dollar",
          "decimalPlaces": 2,
          "minAmount": "100",
          "maxAmount": "10000"
        },
        {
          "currencyCode": "CNY",
          "currencyName": "Chinese Yuan",
          "decimalPlaces": 2,
          "minAmount": "100",
          "maxAmount": "20000"
        }
      ],
      "requiredMessageElements": {
        "getQuotes": [
          "destinationPsp"
        ],
        "pacs008": [
          "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Purp/Cd"
        ]
      },
      "sla": {
        "normalPaymentMaxExecutionTimeout": "PT60S",
        "highPaymentMaxExecutionTimeout": "PT60S"
      },
      "supportedInstructionPriorities": [
        "NORM",
        "HIGH"
      ]
    },
    {
      "countryId": 276,
      "countryCode": "DE",
      "name": "Germany",
      "currencies": [
        {
          "currencyCode": "EUR",
          "currencyName": "Euro",
          "decimalPlaces": 2,
          "maxAmount": "1000000"
        }
      ],
      "requiredMessageElements": {
        "getQuotes": [
          "destinationPsp"
        ],
        "pacs008": [
          "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Purp/Cd"
        ]
      },
      "sla": {
        "normalPaymentMaxExecutionTimeout": "PT60S"
      },
      "supportedInstructionPriorities": [
        "NORM"
      ]
    },
    {
      "countryId": 360,
      "countryCode": "ID",
      "name": "Indonesia",
      "currencies": [
        {
          "currencyCode": "IDR",
          "currencyName": "Indonesian Rupiah",
          "decimalPlaces": 2,
          "maxAmount": "15000000"
        }
      ],
      "requiredMessageElements": {
        "getQuotes": [
          "destinationPsp"
        ],
        "pacs008": [
          "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Purp/Prtry"
        ]
      },
      "sla": {
        "normalPaymentMaxExecutionTimeout": "PT120S"
      },
      "supportedInstructionPriorities": [
        "NORM"
      ]
    },
    {
      "countryId": 458,
      "countryCode": "MY",
      "name": "Malaysia",
      "currencies": [
        {
          "currencyCode": "MYR",
          "currencyName": "Malaysian Ringgit",
          "decimalPlaces": 2,
          "maxAmount": "10000000"
        }
      ],
      "requiredMessageElements": {
        "getQuotes": [
          "destinationPsp"
        ],
        "pacs008": [
          "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Purp/Cd"
        ]
      },
      "sla": {
        "normalPaymentMaxExecutionTimeout": "PT40S"
      },
      "supportedInstructionPriorities": [
        "NORM"
      ]
    },
    {
      "countryId": 608,
      "countryCode": "PH",
      "name": "Philippines",
      "currencies": [
        {
          "currencyCode": "PHP",
          "currencyName": "Philippine Peso",
          "decimalPlaces": 2,
          "maxAmount": "50000"
        }
      ],
      "requiredMessageElements": {
        "getQuotes": [
          "destinationPsp"
        ],
        "pacs008": [
          "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Purp/Prtry"
        ]
      },
      "sla": {
        "normalPaymentMaxExecutionTimeout": "PT60S"
      },
      "supportedInstructionPriorities": [
        "NORM"
      ]
    },
    {
      "countryId": 702,
      "countryCode": "SG",
      "name": "Singapore",
      "currencies": [
        {
          "currencyCode": "SGD",
          "currencyName": "Singapore Dollar",
          "decimalPlaces": 2,
          "maxAmount": "200000"
        }
      ],
      "requiredMessageElements": {
        "getQuotes": [
          "destinationPsp"
        ],
        "pacs008": [
          "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Purp/Cd"
        ]
      },
      "sla": {
        "normalPaymentMaxExecutionTimeout": "PT100S"
      },
      "supportedInstructionPriorities": [
        "NORM"
      ]
    },
    {
      "countryId": 764,
      "countryCode": "TH",
      "name": "Thailand",
      "currencies": [
        {
          "currencyCode": "THB",
          "currencyName": "Thai Baht",
          "decimalPlaces": 2,
          "maxAmount": "2000000"
        }
      ],
      "requiredMessageElements": {
        "getQuotes": [
          "destinationPsp"
        ],
        "pacs008": [
          "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Purp/Prtry"
        ]
      },
      "sla": {
        "normalPaymentMaxExecutionTimeout": "PT60S"
      },
      "supportedInstructionPriorities": [
        "NORM"
      ]
    }
  ]
}

Retrieve a Single Country

get

http://localhost:8080https://nexus-ai-simulator-683365449922.asia-southeast1.run.app

/v1/countries/{countryCode}

Returns a specified country based on the 2 letter countryCode provided, along with key reference data for sending payments to that country, such as minimum and maximum transaction amounts per currency, currency names and decimal places, requirements for message elements, the country level SLA with maximum execution timeouts as ISO 8601 durations, and the supported instruction priorities. Used by: Payment Service Providers (PSPs)

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

countryCodestringRequired

The ISO 3166 alpha-2 country code

Example: ID

Responses

200

Country information.

application/json

Reference data for a country on the Nexus network, including per currency limits, required message elements, the country level SLA and supported instruction priorities.

countryIdintegerRequired

ISO 3166 numeric country code.

Example: 344

countryCodestringRequired

ISO 3166 alpha 2 country code.

Example: HK

namestringRequiredExample: Hong Kong

400

Invalid country code. Reason code BE001 COUNTRY_CODE_INVALID.

application/json

401

Authentication failed. Applicable reason codes: AE001 AUTH_TOKEN_MISSING, AE002 AUTH_TOKEN_INVALID.

application/json

403

Authorization failed. The token is valid but its OAuth2 scopes do not grant access to this endpoint or corridor. Reason code AE004 ACCESS_DENIED.

application/json

404

Country not found. Reason code BE002 COUNTRY_NOT_FOUND.

application/json

429

Rate limit exceeded. Returned by the API gateway and carries no structured Nexus body. The Retry-After response header indicates when to retry.

500

An unhandled exception or infrastructure failure occurred. Reason code TE099 INTERNAL_ERROR. The caller may retry with exponential backoff.

application/json

get/v1/countries/{countryCode}

HTTPcURLJavaScriptPython

GET /v1/countries/{countryCode} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "countryId": 344,
  "countryCode": "HK",
  "name": "Hong Kong",
  "currencies": [
    {
      "currencyCode": "HKD",
      "currencyName": "Hong Kong Dollar",
      "decimalPlaces": 2,
      "minAmount": "100",
      "maxAmount": "10000"
    },
    {
      "currencyCode": "CNY",
      "currencyName": "Chinese Yuan",
      "decimalPlaces": 2,
      "minAmount": "100",
      "maxAmount": "20000"
    }
  ],
  "requiredMessageElements": {
    "getQuotes": [
      "destinationPsp"
    ],
    "pacs008": [
      "/Document/FIToFICstmrCdtTrf/CdtTrfTxInf/Purp/Cd"
    ]
  },
  "sla": {
    "normalPaymentMaxExecutionTimeout": "PT60S",
    "highPaymentMaxExecutionTimeout": "PT60S"
  },
  "supportedInstructionPriorities": [
    "NORM",
    "HIGH"
  ]
}