1curl -X GET 'https://api.budpay.com/api/v2/bank_list' \2 -H 'Authorization: Bearer YOUR_SECRET_KEY'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/:currencyFetch All Banks
Endpoint: GET https://api.budpay.com/api/v2/bank_list
Fetch Banks by Currency
Endpoint: GET https://api.budpay.com/api/v2/bank_list/NGN
1curl -X GET 'https://api.budpay.com/api/v2/bank_list/NGN' \2 -H 'Authorization: Bearer YOUR_SECRET_KEY'{ "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" } ]}Request Parameters
Header Parameters
| Field Name | Description | Required |
|---|---|---|
| Authorization | Bearer token with your secret key | Yes |
URL Parameters (Optional)
| Parameter | Type | Required | Description |
|---|---|---|---|
currency | String | No | Currency code to filter banks: NGN, USD, GHS, KES |
Response Fields
| Field | Type | Description |
|---|---|---|
success | Boolean | Indicates if the request was successful |
message | String | Response message |
currency | String | Currency code for the bank list |
data | Array | Array of bank objects |
Bank Object:
| Field | Type | Description |
|---|---|---|
bank_name | String | Name of the bank |
bank_code | String | Unique bank code identifier |
Supported Currencies
| Currency | Code | Description |
|---|---|---|
| Nigerian Naira | NGN | Nigerian banks |
| US Dollar | USD | International banks |
| Ghanaian Cedi | GHS | Ghanaian banks |
| Kenyan Shilling | KES | Kenyan 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.
- Cache Bank Lists: Store bank data locally and refresh periodically
- Filter by Currency: Use currency-specific endpoints for faster responses
- Display Names: Show user-friendly bank names in UI
- Search Functionality: Implement search for better user experience
- Handle Missing Data: Always validate bank codes before use
Next Steps
- Verify Bank Account - Verify account details
- Bank Transfer - Initiate bank transfer payment
- Transaction Verification - Verify payment status