Bank List

The bank list endpoint helps merchants retrieve the list of banks for countries or mobile money telcos supported for transfer across all currencies.

Authentication

Header	Value
Authorization	Bearer SECRET_KEY
Content-Type	application/json

The secret key can be gotten from the 'Settings' page on your Startbutton dashboard.

See Authentication.

Endpoint

GET {{baseurl}}/bank/list/:currency?type=:type&countryCode=:countryCode

Here are sample requests below.

Param	Param Type	Required	Description
currency	URL	Yes	Allowed values NGN, GHS, ZAR, KES, UGX, RWF, TZS, and ZMW
type	Query	No	Allowed values bank and mobile_money defaults to bank
countryCode	Query	Yes (Only for XOF)	Used to get the banklist for other XOF countries aside from Côte d'Ivoire (which is the default) Allowed values: BJ for Benin, CI for Cote d’Ivoire, TG for Togo, SN for Senegal, ML for Mali, BF for Burkina Faso, CM for Cameroon

To see supported payment channel for these currencies check Available Currencies.

Here is a sample response:

{
    "success": true,
    "message": "Bank list retrieved",
    "data": [
        {
            "name": "9mobile 9Payment Service Bank",
            "code": "120001",
            "id": 302
        },
        {
            "name": "Abbey Mortgage Bank",
            "code": "404",
            "id": 174
        },
       ...
   ]
}