Bank List

The bank list endpoint helps merchants retrieve the list of banks for countries supported for transfer (NGN, GHS, ZAR and KES).

Authentication

Authorization	Set to Bearer SECRET_KEY
Content-Type	Set value to application/json

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

Post a request to the URL below, where the base URL is determined by the environment you are in.

BaseUrls

PROD : https://api.startbutton.tech

DEV/ Staging: https://api-dev.startbutton.tech

Endpoint

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

Here are sample requests below.

Param	Param Type	Required	Description
currency	URL	Yes	Allowed values NGN, GHS, ZAR, KES, UGX, RWF, TZS, and ZMWF
type	Query	No	Allowed values bank and mobile_money defaults to bank
country	Query	No Can be used to get the banklist for other XOF countries aside from Côte d'Ivoire	Allowed values: Côte d’Ivoire, Benin, Togo, Senegal, Mali, Burkina Faso — defaults to Côte d’Ivoire

To see supported payment channel for these currencies check here.

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
        },
       ...
   ]
}

Account Name Verification

This endpoint enables merchant verify the identity of the receiver of the transfer, it's recommended that the account name of the recipient is verified before a transfer is done. This is currently available for NGN and GHS only.

Authorization	Set to Bearer SECRET_KEY
Content-Type	Set value to application/json

For MoMo pass the msisdn as accountNumber in your request.

Endpoint

GET {{baseUrl}}/bank/verify?bankCode=000&accountNumber=6170***&countryCode=GH

We don't support account validation for any other currency asides GHS and NGN.

countryCode for Ghana is GH and not GHS

countryCode for Nigera is NGN

Here is a sample response:

Successful

  {
    "success": true,
    "message": "successful",
    "data": {
        "account_number": "2009000000",
        "account_name": "JOHN DOE",
        "bank_id": 0
    }
}

Failed

{
    "success": false,
    "message": "Account not resolved"
}