GETGet List of Banks
Fetch a list of all banks.
- Read-only: Changes nothing; only returns data.
Returns a list of all banks. Use the Get Bank Details API to get additional information about a bank.
The bank list is returned under param_attributes.list_elements, not under data. Each bank carries its account-number rules and Eko bank_id in a dependent_params name/value list — look entries up by name, not by position.
Request
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
initiator_id | string | required | Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729 |
client_ref_id | string | optional | Unique reference ID per API call, generated by your system (10–20 characters; 10 recommended). The SDKs generate one for every non-GET call when you don't.e.g. 2026010100123456789 |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
client_ref_idstringoptionalUnique reference ID per API call, generated by your system (10–20 characters; 10 recommended). The SDKs generate one for every non-GET call when you don't.
example: 2026010100123456789
These headers authenticate and sign every request. See How Auth Works for details.
| Field | Type | Required | Description |
|---|---|---|---|
developer_key | string | required | Static API key issued to your account after KYC. |
secret-key | string | required | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
secret-key-timestamp | string | required | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
content-type | string | required | application/jsone.g. application/json |
developer_keystringRequiredStatic API key issued to your account after KYC.
secret-keystringRequiredDynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
secret-key-timestampstringRequiredCurrent time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
content-typestringRequiredapplication/json
example: application/json
Response types
| response_type_id | Meaning | Next step |
|---|---|---|
398 | Bank list returned successfully | — |
Responses
398Bank list returned successfully
statusnumberPrimary success indicator (0 = success).
messagestringHuman-readable response / error message.
response_status_idnumberUI display hint only (-1/0 success, 1 failure, 2 initiated, 3 refund initiated, 4 refunded). Never branch on it — use `status` (and `tx_status` for financial APIs), or `response_type_id` where documented.
response_type_idnumberA unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobjectAPI-specific response payload.
param_attributesobjectContainer for the returned list.
list_elementsarrayArray of banks.
labelstringBank display name.
valuestringEko bank code — pass as `bank_code` to Get Bank Details.
dependent_paramsarrayBank-specific attributes as `name`/`value` pairs. Known names: `account` (account-number length rules), `ifsc_required` (1 = IFSC must be sent with the account), `varifiable` (1 = account verification available; key spelled as returned), `bank_id` (Eko bank identifier), `is_face_auth_available`, `is_iris_auth_available` (1 = supported).
namestringAttribute name.
valuenumberAttribute value. Absent on the `account` entry.
length_minnumberMinimum account-number length. Only on the `account` entry.
length_maxnumberMaximum account-number length. Only on the `account` entry.
pattern_errorstringValidation message to show for an invalid account number. Optional; only on the `account` entry.