Eko Platform Services Logo

GETGet List of Banks

Fetch a list of all banks.

GET/tools/reference/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

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

client_ref_idstringoptional

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.

example: 2026010100123456789

Response types

response_type_idMeaningNext step
398Bank list returned successfully—

Responses

398Bank list returned successfully

  • statusnumber

    Primary success indicator (0 = success).

  • messagestring

    Human-readable response / error message.

  • response_status_idnumber

    UI 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_idnumber

    A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.

  • dataobject

    API-specific response payload.

    • param_attributesobject

      Container for the returned list.

      • list_elementsarray

        Array of banks.

        • labelstring

          Bank display name.

        • valuestring

          Eko bank code — pass as `bank_code` to Get Bank Details.

        • dependent_paramsarray

          Bank-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).

          • namestring

            Attribute name.

          • valuenumber

            Attribute value. Absent on the `account` entry.

          • length_minnumber

            Minimum account-number length. Only on the `account` entry.

          • length_maxnumber

            Maximum account-number length. Only on the `account` entry.

          • pattern_errorstring

            Validation message to show for an invalid account number. Optional; only on the `account` entry.

Next steps

NextGETGet Bank DetailsFetch a bank's details (id, name, channels) by its Eko bank code.

Related