Coverage

Get coverage information

get

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

Authorizations

ServiceKey

X-Service-KeystringRequired

Your Switch API service key. Contact us at [e-mail] to obtain your service key.

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 - validation error or invalid parameters

application/json

get

/coverage

HTTPcURLJavaScriptPython

GET /coverage?direction=OFFRAMP HTTP/1.1
Host: api.onswitch.xyz
X-Service-Key: YOUR_API_KEY
Accept: */*

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