Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
/v1/bbps/operatorGET| Parameter | Type | Required | Description |
|---|---|---|---|
category_code | string | Yes | The code of the category you want to query operators for (e.g. ELECTRICITY, WATER). |
authorization | string | Optional | Can be used to authenticate the request if the Authorization header is not present (e.g. Basic <base64_credentials>). |
GET https://api.originbills.in/v1/bbps/operator?category_code=ELECTRICITY
{
"status": true,
"statusCode": 200,
"message": "Operators retrieved successfully.",
"data": [
{
"operator_id": 101,
"name": "Tata Power - Mumbai",
"status": "active",
"category_name": "Electricity",
"bill_fetch_required": true,
"bbps_enabled": true,
"parameters": [
{
"ca_number": "Consumer Account Number",
"regex": "^[0-9]{9,12}$"
}
]
},
{
"operator_id": 102,
"name": "BSES Yamuna - Delhi",
"status": "active",
"category_name": "Electricity",
"bill_fetch_required": true,
"bbps_enabled": true,
"parameters": [
{
"ca_number": "CA Number",
"regex": "^[0-9]{9}$"
}
]
}
]
}
| Field | Type | Description |
|---|---|---|
status | boolean | Indicates if the operation was successful. |
statusCode | integer | HTTP response status code. |
message | string | A descriptive message from the server. |
data | array | List of operator objects for the category. |
data[].operator_id | integer | null | Unique identifier for the operator (to be used when fetching or paying bills). |
data[].name | string | Name of the operator/biller. |
data[].status | string | Current status of the operator (e.g., active). |
data[].category_name | string | Name of the category this operator belongs to. |
data[].bill_fetch_required | boolean | Indicates if fetching the bill is mandatory before making a payment. |
data[].bbps_enabled | boolean | Whether the operator is enabled under BBPS. |
data[].parameters | array | Array of required input parameters for the operator. Each element contains the parameter key name, its description/label, and a regex for validation. |
category_code query parameter is missing.
{
"status": false,
"statusCode": 400,
"message": "category_code is required."
}
Authorization header/query parameter is invalid or missing.
{
"status": false,
"statusCode": 401,
"message": "Unauthorized access."
}