Making Payment
Bank List

Bank List

Retrieve a list of supported banks for bank transfer payments. You can fetch all banks or filter by currency.


Endpoint

GET https://api.budpay.com/api/v2/bank_list
GET https://api.budpay.com/api/v2/bank_list/:currency

Fetch All Banks

curl https://api.budpay.com/api/v2/bank_list \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-X GET

Fetch Banks by Currency

curl https://api.budpay.com/api/v2/bank_list/NGN \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-X GET

Sample Response

{
    "success": true,
    "message": "Bank list retrieved",
    "currency": "NGN",
    "data": [
        {
            "bank_name": "9PAYMENT SERVICE BANK",
            "bank_code": "120001"
        },
        {
            "bank_name": "AB MICROFINANCE BANK",
            "bank_code": "090270"
        },
        {
            "bank_name": "ABBEY MORTGAGE BANK",
            "bank_code": "070010"
        },
        {
            "bank_name": "ABUCOOP MICROFINANCE BANK",
            "bank_code": "090424"
        },
        {
            "bank_name": "ACCESS BANK",
            "bank_code": "000014"
        },
        {
            "bank_name": "WEMA BANK",
            "bank_code": "000017"
        },
        {
            "bank_name": "ZENITH BANK",
            "bank_code": "000015"
        }
    ]
}

Try it out

Request Parameters

Header Parameters

Field NameDescriptionRequired
AuthorizationBearer token with your secret keyYes

URL Parameters (Optional)

ParameterTypeRequiredDescription
currencyStringNoCurrency code to filter banks: NGN, USD, GHS, KES

Response Fields

FieldTypeDescription
successBooleanIndicates if the request was successful
messageStringResponse message
currencyStringCurrency code for the bank list
dataArrayArray of bank objects

Bank Object:

FieldTypeDescription
bank_nameStringName of the bank
bank_codeStringUnique bank code identifier

Supported Currencies

CurrencyCodeDescription
Nigerian NairaNGNNigerian banks
US DollarUSDInternational banks
Ghanaian CediGHSGhanaian banks
Kenyan ShillingKESKenyan banks

Error Handling

401 Unauthorized

{
    "success": false,
    "message": "Authentication failed"
}

404 Not Found

{
    "success": false,
    "message": "Invalid currency code"
}

Best Practices

Tip: Cache bank lists to reduce API calls, as bank data doesn't change frequently.

  1. Cache Bank Lists: Store bank data locally and refresh periodically
  2. Filter by Currency: Use currency-specific endpoints for faster responses
  3. Display Names: Show user-friendly bank names in UI
  4. Search Functionality: Implement search for better user experience
  5. Handle Missing Data: Always validate bank codes before use

Next Steps