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

Returns all supported location (state) identifiers. Pass the returned location_id as the `location` query parameter in the Get Operators call to narrow results to a specific state or circle.

> 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 |
| user_code | string | yes | User code of the retailer/agent the service is run for. e.g. 20810200 |

## 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 | Granular status id; see the shared error-codes table. |
| 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.locations | array | List of supported state/location entries. |
| data.locations.id ⭐ | number | Location identifier to use as the `location` filter when querying operators. |
| data.locations.location_name | string | State or circle name. |

## Example response

```json
{
  "status": 0,
  "response_status_id": 0,
  "message": "Success",
  "response_type_id": 1388,
  "data": {
    "locations": [
      {
        "id": 1,
        "location_name": "Andhra Pradesh"
      },
      {
        "id": 2,
        "location_name": "Bihar"
      },
      {
        "id": 3,
        "location_name": "Gujarat"
      },
      {
        "id": 4,
        "location_name": "Karnataka"
      },
      {
        "id": 5,
        "location_name": "Maharashtra"
      },
      {
        "id": 6,
        "location_name": "Rajasthan"
      },
      {
        "id": 7,
        "location_name": "Delhi"
      },
      {
        "id": 8,
        "location_name": "Tamil Nadu"
      },
      {
        "id": 9,
        "location_name": "Uttar Pradesh"
      },
      {
        "id": 10,
        "location_name": "West Bengal"
      }
    ]
  }
}
```
