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"
}
]
}Retrieve institution-related data for the authenticated service. When country is provided, returns institutions (e.g. banks) available for that market; otherwise returns service-level institution configuration.
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"
}
]
}Service key for API authentication
ISO 3166-1 alpha-2 country code. When set, filters institutions to that country.
ISO 4217 currency code (optional filter alongside country).
Transfer channel (optional filter).
BANK, BLOCKCHAIN, SWIFT, SEPA, SEPA_EUR, WIRE, ACH, DOMESTIC_GBP, MOBILEMONEY, ALIPAY, WECHATPAY