GETGet BBPS Locations

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

GET/customer/payment/bbps/locations

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.

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 (max 20 characters).e.g. 2026010100123456789

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 (max 20 characters).

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_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Response types

response_type_id	Meaning	Next step
`2459`	Location list returned — use one as the `location` filter on Get Operators.	Get BBPS Operators

Responses

2459Location list returned — use one as the `location` filter on Get Operators.Next:Get BBPS Operators

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
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
  Wrapper for the location list — returned at the top level of the response, not under `data`.
  - list_elementsarray
    One entry per operating state / UT.
    - operator_location_idstring
      Zero-padded location identifier. Pass as the `location` filter on Get Operators.
    - operator_location_namestring
      State / UT name.
    - abbreviationstring
      Two-letter state code.

Next steps

NextGETGet BBPS OperatorsList all active BBPS billers, optionally filtered by category and/or state.

import { EpsClient } from "@ekoindia/eps-sdk";

const client = new EpsClient({

developerKey: process.env.EPS_DEVELOPER_KEY,

accessKey: process.env.EPS_ACCESS_KEY,

initiatorId: "9962981729",

environment: "sandbox",

});

const result = await client.call("bbps-get-locations");

console.log(result);

{

"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

}

Request

Query parameters

Response types

Responses

Next steps

Related