Retrieve comprehensive bank lists for NGN, USD, and BRL currencies. Essential for offramp integrations and local bank transfers.
Overview
The Get Payment Banks endpoint allows you to retrieve a comprehensive list of available banks for supported currencies. This endpoint is essential for developers implementing offramp functionality, as it provides the bank names and codes required for processing withdrawals to local bank accounts.
NGN Banks
Nigerian banks for local transfers and withdrawals
USD Banks
US banks for domestic and international transfers
BRL Banks
Brazilian banks for PIX and local transfers
Supported Currencies
This endpoint supports three major currencies:
NGN - Nigerian Naira
Returns a list of Nigerian banks that support local transfers. Use these bank details when your users want to receive funds in their Nigerian bank accounts.
Use case: Offramp transactions where users want to convert USDC/USDT to NGN and receive funds in their local Nigerian bank account.
USD - US Dollar
Returns a list of US banks that support domestic transfers via ACH, Fedwire, and international SWIFT transfers.
Use case: Offramp transactions where users want to convert USDC/USDT to USD and receive funds in their US bank account.
BRL - Brazilian Real
Returns a list of Brazilian banks that support local transfers and PIX payments.
Use case: Offramp transactions where users want to convert USDC/USDT to BRL and receive funds in their Brazilian bank account or via PIX.
How It Works
For Developers
- Call the endpoint with your desired currency parameter
- Receive bank list with names and codes
- Use bank data to populate dropdowns in your UI
- Reference bank codes when initiating offramp transactions
Integration Example
// Fetch Nigerian banks
const response = await fetch('/payment_banks?currency=NGN', {
headers: {
'ngnc-sec-key': 'your-api-key'
}
});
const banks = await response.json();Response Format
The endpoint returns a standardized response containing:
- status: Success/error status
- message: Descriptive message about the operation
- BankList: Array of available banks with their details
Each bank object typically includes:
- Bank name (for display purposes)
- Bank code (for transaction processing)
- Additional metadata specific to the currency/region
Developer Notes
Rate Limiting
This endpoint is optimized for frequent calls. Cache results locally to improve performance.
Data Freshness
Bank lists are updated regularly. Re-fetch periodically to ensure current data.
Important: Always validate bank codes before using them in offramp transactions. The codes returned by this endpoint are the exact values required for the offramp API calls.
Next Steps
After retrieving the bank list:
- Store the bank data in your application
- Present banks to users in a user-friendly format
- Use the bank name when calling the offramp endpoint
- For account verification, use the verify account number endpoint