Institution

Get institutions for a country

get

Retrieve a list of supported institutions for a specific country.

Authorizations

ServiceKey

X-Service-KeystringRequired

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

Query parameters

countrystring · enumRequired

ISO 3166-1 alpha-2 country code (e.g., "NG" for Nigeria, "US" for United States)

Example: NGPossible values:

Responses

200

Successfully retrieved institutions

application/json

400

Bad request - validation error or invalid parameters

application/json

get

/institution

HTTPcURLJavaScriptPython

GET /institution?country=AD HTTP/1.1
Host: api.onswitch.xyz
X-Service-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "status": 200,
  "message": "Institutions fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "code": "058",
      "name": "Guaranty Trust Bank",
      "icon": "https://res.cloudinary.com/dyedbeksr/image/upload/v1763964534/Group_1000003624_nrunnu.png"
    },
    {
      "code": "011",
      "name": "First Bank of Nigeria",
      "icon": "https://res.cloudinary.com/dyedbeksr/image/upload/v1763964534/Group_1000003624_nrunnu.png"
    }
  ]
}

Lookup institution account

post

Lookup account name for a given institution account number or phone number.

Authorizations

ServiceKey

X-Service-KeystringRequired

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

Body

application/json

countrystring · enumRequiredPossible values:

Responses

200

Successfully looked up institution account

application/json

400

Bad request - validation error or invalid parameters

application/json

post

/institution/lookup

HTTPcURLJavaScriptPython

POST /institution/lookup HTTP/1.1
Host: api.onswitch.xyz
X-Service-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "country": "NG",
  "beneficiary": {
    "bank_code": "058",
    "account_number": "0123456789"
  }
}

{
  "success": true,
  "status": 200,
  "message": "Institution lookup successful",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "account_name": "John Doe"
  }
}