Coverage

Get coverage information

get

Retrieve information about supported countries, currencies, and payment rails.

Authorizations

ServiceKey

Query parameters

directionstring · enumRequired

Transaction direction

Example: OFFRAMPPossible values:

countrystring · enumOptional

Filter by specific country (optional)

Example: NGPossible values:

currencystring · enumOptional

Filter by specific currency (optional). If not specified, defaults to the country's local currency.

Example: NGNPossible values:

Responses

200

Successfully retrieved coverage

application/json

400

Bad request - Invalid input parameters or validation error

application/json

get

/coverage

HTTPcURLJavaScriptPython

GET /coverage?direction=OFFRAMP HTTP/1.1
Host: api.onswitch.xyz
Accept: */*

{
  "success": true,
  "message": "Coverage fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "country": "NG",
      "currency": "NGN",
      "rails": [
        "NIBSS",
        "CITAD"
      ]
    }
  ]
}

Get supported countries

get

Retrieve a list of all supported countries.

Authorizations

ServiceKey

Responses

200

Successfully retrieved countries

application/json

400

Bad request - Invalid input parameters or validation error

application/json

get

/country

HTTPcURLJavaScriptPython

GET /country HTTP/1.1
Host: api.onswitch.xyz
Accept: */*

{
  "success": true,
  "message": "Countries fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "code": "NG",
      "name": "Nigeria"
    },
    {
      "code": "US",
      "name": "United States"
    }
  ]
}

Get states for a country

get

Retrieve a list of states/provinces for a specific country.

Authorizations

ServiceKey

Query parameters

countrystringRequired

ISO 3166-1 alpha-2 country code

Example: NG

Responses

200

Successfully retrieved states

application/json

400

Bad request - Invalid input parameters or validation error

application/json

get

/state

HTTPcURLJavaScriptPython

GET /state?country=text HTTP/1.1
Host: api.onswitch.xyz
Accept: */*

{
  "success": true,
  "message": "States fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "code": "LAGOS",
      "name": "Lagos"
    },
    {
      "code": "ABUJA",
      "name": "Abuja"
    }
  ]
}