Category List - OriginBills Docs

Retrieve the list of active BBPS (Bharat Bill Payment System) bill categories supported by the platform (e.g. Electricity, Mobile Postpaid, Water, Gas, etc.).

Endpoint: /v1/bbps/categories
Method: GET
Authentication: Required (Basic Auth via Header or Query Parameter)

Query Parameters

Parameter	Type	Required	Description
`authorization`	string	Optional	Can be used to authenticate the request if the `Authorization` header is not present (e.g. `Basic <base64_credentials>`).

URL Example

GET https://api.originbills.in/v1/bbps/categories

Success Response (200 OK)

{
  "status": true,
  "statusCode": 200,
  "message": "Categories retrieved successfully.",
  "data": [
    {
      "code": "ELECTRICITY",
      "name": "Electricity",
      "status": "active",
      "icon": "electricity"
    },
    {
      "code": "MOBILE-POSTPAID",
      "name": "Mobile Postpaid",
      "status": "active",
      "icon": "mobile"
    },
    {
      "code": "WATER",
      "name": "Water",
      "status": "active",
      "icon": "water"
    },
    {
      "code": "GAS",
      "name": "Gas",
      "status": "active",
      "icon": "gas"
    }
  ]
}

Response Fields

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 active category objects.
`data[].code`	string	Unique code identifier for the category (e.g. `ELECTRICITY`).
`data[].name`	string	User-friendly display name of the category.
`data[].status`	string	Status of the category (e.g., `active`).
`data[].icon`	string \| null	Suggested icon identifier for the category.

Error Responses

Unauthorized (401 Unauthorized)

Returned if the Authorization header/query parameter is invalid, missing, or empty.

{
  "status": false,
  "statusCode": 401,
  "message": "Unauthorized access."
}