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 (BillerResponse) {7}]

optional

billerId

integer <int32>

optional

name

string

optional

billerType

string

optional

partialPayAllowed

boolean

optional

inputParams

array[object (BillerParamsDTO) {7}]

optional

circleParams

array[object (CircleParam) {2}]

optional

paymentAmountExactness

string

optional

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": [
        {
            "billerId": 0,
            "name": "string",
            "billerType": "string",
            "partialPayAllowed": true,
            "inputParams": [
                {
                    "paramKey": "string",
                    "paramName": "string",
                    "paramType": "NUMBER",
                    "paramRegex": "string",
                    "invalidParamError": "string",
                    "mandatory": true,
                    "paramValues": [
                        {
                            "key": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "circleParams": [
                {
                    "key": "string",
                    "value": "AP"
                }
            ],
            "paymentAmountExactness": "string"
        }
    ]
}

Request

Request samples

Responses