Get Billers

API takes 2 optional parameter billerType and stateCode. If both are not available then it return all the biller supported. API response will be huge for this case, so it is recommended to use the one of billerType or stateCode to fetch the biller list.
billerType: return the list of the billers for specific category
stateCode: return the list of billers belongs to specific state code.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

billerType

enum<string>

optional

Allowed values:

ELECTRICITYGASWATERBROADBANDINSURANCEDTHPREPAIDLANDLINEPOSTPAIDDATACARDDATACARD_BPEMIFASTagMUNICIPALITYLPG_BOOKINGCABLE_TVCLUBS_ASSOCIATIONSCREDIT_CARDEDUCATION_FEESHEALTH_INSURANCEHOSPITAL_PATHOLOGYHOUSING_SOCIETYLIFE_INSURANCELOAN_REPAYMENTMUNICIPAL_SERVICESMUNICIPAL_TAXESRECURRING_DEPOSITSUBSCRIPTIONOTHERS

stateCode

enum<string>

optional

Allowed values:

AndhraPradeshArunachalPradeshAssamBiharChattisgarhGoaGujaratHaryanaHimachalPradeshJammuAndKashmirJharkhandKarnatakaKeralaMadhyaPradeshMaharashtraManipurMeghalayaMizoramNagalandOrissaPunjabRajasthanSikkimTamilNaduTelanganaTripuraUttarakhandUttarPradeshWestBengalAndamanAndNicobarChandigarhDadraandNagarHaveliDamanAndDiuDelhiLakshadweepPondicherryINVALID_STATE_CODE

Responses

🟢200OK

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

array[object (BillerV2Response) {10}]

optional

billerId

integer

required

name

string

required

billerType

string

required

partialPayAllowed

boolean

required

inputParams

array [object {7}]

required

circleParams

array [object {2}]

required

paymentAmountExactness

string

required

state

string

required

circleStateMapping

object

required

viewBillSupported

boolean

required

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