List institutions

To pay a Nigerian bank account, you need the bank’s code, such as GTBINGLA or OPAYNGPC. This endpoint gives you every code, so you can fill a bank picker instead of guessing. You can’t work a code out from the bank’s name, and a wrong one stops the order from being created. NGN is the only currency with an institution list. KES, GHS, and UGX recipients are identified by method plus a phone number, till, or paybill, so there is nothing to look up. See recipients.

Endpoint

GET https://merchant.minisend.xyz/api/offramp/institutions

Authorization: Bearer ms_live_your_key_here

Requires the offramp scope.

Query parameters

string

default:"NGN"

Currency to list institutions for. NGN is the only supported value, and it is the default, so you can omit this entirely.

Example

curl https://merchant.minisend.xyz/api/offramp/institutions?currency=NGN \
  -H "Authorization: Bearer ms_live_your_key_here"

const res = await fetch(
  'https://merchant.minisend.xyz/api/offramp/institutions?currency=NGN',
  { headers: { 'Authorization': 'Bearer ms_live_your_key_here' } }
);

const { institutions } = await res.json();

// The `code` is what an order needs.
const opay = institutions.find((i) => i.name === 'OPay');
console.log(opay.code); // OPAYNGPC

Response (200)

{
  "currency": "NGN",
  "count": 171,
  "institutions": [
    { "code": "ABNGNGLA", "name": "Access Bank", "type": "bank" },
    { "code": "GTBINGLA", "name": "Guaranty Trust Bank", "type": "bank" },
    { "code": "OPAYNGPC", "name": "OPay", "type": "bank" },
    { "code": "PALMNGPC", "name": "PalmPay", "type": "bank" }
  ]
}

string

required

The currency the list applies to.

integer

required

Number of institutions returned.

array

required

Show institution

string

required

Pass this as recipient.institution when you create an order or validate an account.

string

required

Display name. Show this in your bank picker.

string

required

What kind of institution it is. Right now it’s bank for every entry, including app-based banks like OPay and PalmPay.

The list rarely changes, and we keep a copy for six hours, so it’s fine to call this every time you show a form. Keeping your own copy for a day is fine too. Just don’t type the codes into your code, because if a bank is added or renamed, your list will quietly go out of date.

Errors

Status	Meaning
`400`	Only `NGN` has a list of banks
`403`	Off-ramp isn’t switched on for your account yet
`502`	We couldn’t load the list just now. Try again shortly

Overview

Endpoints

Off-ramp endpoints

Onramp endpoints

Wallet API endpoints

List institutions

Endpoint

Query parameters

Example

Response (200)

Errors

​Endpoint

​Query parameters

​Example

​Response (200)

​Errors

Endpoint

Query parameters

Example

Response (200)

Errors