GETGet Operator Parameters

Fetch the custom input fields required by a specific biller before payment.

GET/customer/payment/bbps/operator/{operator_id}/parameters

Returns the input fields the chosen operator requires — field names, labels, types and validation regex — so you can render the bill-entry form dynamically.

list_elements is the source of truth for this operator's fields. The documented parameters on Fetch Bill and Pay Bill are only the common set; every param_name returned here must also be sent to both calls, with identical values. Call this once per operator and cache the result.

The payload is returned under param_attributes, not under data.

Tip

This endpoint is used in these workflows:

BBPS — Pay a Utility Bill — Pick a biller by category, read the fields it requires, fetch the live bill, then pay the exact amount. Get Locations is an optional extra filter on the biller list, and UPPCL (operator 190) additionally needs a district_discome from Get District Discome — neither is a step here because neither applies to every biller.
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
`operator_id`	number	required	The `operator_id` from the Get Operators response.e.g. 5

operator_idnumberRequired

The `operator_id` from the Get Operators response.

example: 5

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
`2463`	Parameter schema returned — collect these fields, then fetch the bill.	Fetch BBPS Bill

Responses

2463Parameter schema returned — collect these fields, then fetch the bill.Next:Fetch 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.
- param_attributesobject
  Wrapper for the operator's parameter schema — returned at the top level of the response, not under `data`.
  - operator_namestring
    Display name of the operator.
  - operator_idnumber
    The operator this schema belongs to.
  - fetchBillnumber
    Whether live bill fetch is supported (`1` = yes).
  - BBPSnumber
    Whether the biller is on the BBPS network; display Bharat BillPay branding per NPCI guidelines.
  - list_elementsarray
    The input fields this operator requires. Send every `param_name` to BOTH Fetch Bill and Pay Bill.
    - param_namestring
      Field name to submit at bill-fetch / pay time.
    - param_labelstring
      Label to show the agent.
    - param_idstring
      Identifier for this field.
    - param_typestring
      Field type — e.g. `Numeric`, `List`.
    - regexstring
      Client-side validation pattern.
    - error_messagestring
      Validation message to show when the regex does not match.

Next steps

NextGETGet District Discome (UPPCL)Resolve the district-level distribution company code required by UPPCL (operator 190).