Get Banks List

Get the list of supported banks/institutions.

Parameters

This endpoint does not require any parameters. It's a simple GET request that returns all available banks.

Response

Returns a JSON array containing:

• id: Institution ID (unique identifier)
• name: Institution name
• type: Type of institution (BANK, WALLET, etc.)
• account_length: Expected account number length
• regex: Regular expression for account validation
• logo: URL to the institution's logo

Common Use Cases

• Bank Selection UI: Display available banks in a dropdown or selection interface
• Validation: Verify that a user-selected bank is supported before processing
• Dynamic Integration: Keep your application's bank list synchronized with Beqelal's supported banks

Code Examples

curl -X GET "{base_url}/api/v1/list/banks" \
  -H "Content-Type: application/json" \
  -H "app-id: YOUR_APP_ID" \
  -H "api-key: YOUR_API_KEY"

Response Examples

[
  {
    "id": "528968",
    "name": "Master CARD",
    "type": "BANK",
    "account_length": 16,
    "regex": "",
    "logo": "https://docs.beqelal.net/api/v1/list/logs/download.png"
  },
  {
    "id": "127127",
    "name": "Kacha Push ussd",
    "type": "WALLET",
    "account_length": 12,
    "regex": "",
    "logo": "https://docs.beqelal.net/api/v1/list/logs/kachadfs_logo-removebg-preview.png"
  },
  {
    "id": "404050",
    "name": "Kacha DFS",
    "type": "WALLET",
    "account_length": 16,
    "regex": "",
    "logo": "https://docs.beqelal.net/api/v1/list/logs/kachadfs_logo-removebg-preview_Q60snDX.png"
  }
]

Best Practices

• Cache the Results: Bank lists don't change frequently, so cache the response to reduce API calls
• Refresh Periodically: Update your cached bank list daily or weekly to stay current
• Error Handling: Implement fallback behavior if the banks list is temporarily unavailable