Fetch Biller List

💡

This API allows you to retrieve a list of billers supported by BBPS.
It accepts two optional parameters:

billerType: Returns the list of billers for a specific category (for example, electricity, water, telecom).

stateCode: Returns the list of billers available for a specific state code.

Note:
If both billerType and stateCode are not provided, the API will return all supported billers, which may result in a very large response payload. It is recommended to use at least one of these parameters to narrow down the results and optimize performance.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Body

Example

{
    "response_code": 0,
    "response_message": "Success",
    "payload": [
        {
            "billerId": 12345,
            "name": "Electricity Company XYZ",
            "billerType": "ELECTRICITY",
            "inputParams": [
                {
                    "paramKey": "cn",
                    "paramName": "Consumer ID",
                    "paramType": "NUMBER",
                    "paramRegex": "^[0-9]{10}$",
                    "invalidParamError": "Consumer ID must be a 10-digit number",
                    "mandatory": true,
                    "paramValues": []
                },
                {
                    "paramKey": "ad1",
                    "paramName": "Billing Month",
                    "paramType": "NUMBER",
                    "paramRegex": "^(0?[1-9]|1[0-2])$",
                    "invalidParamError": "Please enter a valid month (1-12)",
                    "mandatory": true,
                    "paramValues": [
                        {
                            "key": "1",
                            "value": "January"
                        },
                        {
                            "key": "2",
                            "value": "February"
                        },
                        {
                            "key": "3",
                            "value": "March"
                        }
                    ]
                }
            ],
            "circleParams": [
                {
                    "key": "circle",
                    "value": "AP"
                },
                {
                    "key": "region",
                    "value": "South"
                }
            ],
            "paymentAmountExactness": "EXACT",
            "state": "ANDAMAN_AND_NICOBAR_ISLANDS",
            "circleStateMapping": {
                "AP": "ANDAMAN_AND_NICOBAR_ISLANDS"
            },
            "viewBillSupported": true
        }
    ]
}

Request

Request samples

Responses