Skip to main content
GET
/
institution
Get institution
curl --request GET \
  --url https://api.onswitch.xyz/institution \
  --header 'x-service-key: <api-key>'
{
  "success": true,
  "message": "Institutions fetched successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "code": "058",
      "name": "Guaranty Trust Bank",
      "country": "NG"
    },
    {
      "code": "011",
      "name": "First Bank of Nigeria",
      "country": "NG"
    }
  ]
}

Authorizations

x-service-key
string
header
required

Service key for API authentication

Query Parameters

country
string

ISO 3166-1 alpha-2 country code. When set, filters institutions to that country.

currency
string

ISO 4217 currency code (optional filter alongside country).

channel
enum<string>

Transfer channel (optional filter).

Available options:
BANK,
BLOCKCHAIN,
SWIFT,
SEPA,
SEPA_EUR,
WIRE,
ACH,
DOMESTIC_GBP,
MOBILEMONEY,
ALIPAY,
WECHATPAY

Response

Successfully retrieved institution data

success
boolean
required
message
string
required
timestamp
string<date-time>
required
data
any | null
required

Institution list or configuration payload (shape varies by query parameters)