---
title: "Get BBPS Locations API Reference"
description: "Retrieve the list of supported state/location IDs for filtering BBPS operators."
canonical: "https://eps.eko.in/docs/bbps-get-locations"
---


> **Canonical URL:** https://eps.eko.in/docs/bbps-get-locations
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# Get BBPS Locations API Reference

`GET https://staging.eko.in/ekoapi/v3/customer/payment/bbps/locations`

Retrieve the list of supported state/location IDs for filtering BBPS operators.

**Behaviour**

- **Read-only**: Changes nothing; only returns data.

Returns every operating location (state / UT). Pass an `operator_location_id` from here as the `location` filter on Get Operators to narrow the biller list to one state.

`operator_location_id` is a **zero-padded string** (`"06"`, `"35"`), not a number — keep it as a string when you pass it back. The list is returned under `param_attributes.list_elements`, not under `data`.

> View product & pricing details: [Bharat Bill Payment System (BBPS)](https://eps.eko.in/products/bbps-api.md)

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| client_ref_id | string | no | 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 |

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| developer_key | string | yes | Static API key issued to your account after KYC. |
| secret-key | string | yes | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
| secret-key-timestamp | string | yes | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
| content-type | string | yes | application/json e.g. application/json |

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | 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_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| data | object | API-specific response payload. |
| data.param_attributes ⭐ | object | Wrapper for the location list — returned at the top level of the response, not under `data`. |
| data.param_attributes.list_elements ⭐ | array | One entry per operating state / UT. |
| data.param_attributes.list_elements.operator_location_id ⭐ | string | Zero-padded location identifier. Pass as the `location` filter on Get Operators. |
| data.param_attributes.list_elements.operator_location_name ⭐ | string | State / UT name. |
| data.param_attributes.list_elements.abbreviation | string | Two-letter state code. |

## Response types

Branch on `response_type_id` to decide the next call:

| response_type_id | Meaning | Next step |
| --- | --- | --- |
| 2459 | Location list returned — use one as the `location` filter on Get Operators. | [bbps-get-operators](https://eps.eko.in/docs/bbps-get-operators.md) |

## Example response

`response_type_id` `2459` — Location list returned — use one as the `location` filter on Get Operators.. Next step: [bbps-get-operators](https://eps.eko.in/docs/bbps-get-operators.md).

```json
{
  "response_status_id": 0,
  "param_attributes": {
    "list_elements": [
      {
        "operator_location_name": "Haryana",
        "operator_location_id": "06",
        "abbreviation": "HR"
      },
      {
        "operator_location_name": "Madhya Pradesh",
        "operator_location_id": "23",
        "abbreviation": "MP"
      },
      {
        "operator_location_name": "Andaman and Nicobar",
        "operator_location_id": "35",
        "abbreviation": "AN"
      }
    ]
  },
  "response_type_id": 2459,
  "message": "BBPS location fetch success",
  "status": 0
}
```