GETGet Recharge Plans

List the prepaid mobile / DTH recharge plans available for an operator and circle.

GET/customer/payment/bbps/recharge/{customer_mobile}/operator/plans

Lists available recharge plans for an operator and circle. Plans arrive under dependent_params at the top level (not under data): the req_list entry's value array holds the plans, and its type_metadata[].headers describe which field is the price, the validity and the description.

circleid is the circle_area value returned by Get Operator Code and Circle — the parameter is renamed between the two calls. Once the customer picks a plan, submit its amount through Pay Bill.

Tip

This endpoint is one step in a complete workflow:

BBPS — Prepaid Mobile / DTH Recharge — Detect the operator and circle from the customer's mobile number, read the operator's input fields, list the available plans, then submit the chosen plan as a payment.

Request

Path parameters

Field	Type	Required	Description
`customer_mobile`	string	required	Customer's mobile number.e.g. 9876543210

customer_mobilestringRequired

Customer's mobile number.

example: 9876543210

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
`phone_operator_code`	string	required	Operator code from the Get Operator Code and Circle response.e.g. 400
`circleid`	string	required	Circle identifier — the value returned as `circle_area` by Get Operator Code and Circle. Note the name differs between the two endpoints.e.g. 5

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

phone_operator_codestringRequired

Operator code from the Get Operator Code and Circle response.

example: 400

circleidstringRequired

Circle identifier — the value returned as `circle_area` by Get Operator Code and Circle. Note the name differs between the two endpoints.

example: 5

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
`1804`	Plans returned — let the customer pick one, then submit its `amount` as the recharge.	Pay BBPS Bill
`1805`	Plans could not be fetched. The envelope still carries `status: 0`, so branch on this id. The recharge can still proceed with an amount entered by the agent.	Pay BBPS Bill

Responses

1804Plans returned — let the customer pick one, then submit its `amount` as the recharge.Next:Pay BBPS Bill

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.
- dependent_paramsarray
  Plan groups — returned at the top level, not under `data`. The entry named `req_list` carries the plans.
  - namestring
    Group name; `req_list` holds the plan list.
  - valuearray
    The available plans.
    - amountstring
      Plan price in rupees. Send this as `amount` to Pay Bill.
    - validitystring
      How long the plan is valid for.
    - plan_descriptionstring
      What the plan includes.
  - type_metadataarray
    Column metadata describing which plan field is the price, the validity and the description.