Fetch Biller by Category

Fetch Biller

Postman Collection

BBPS

URL

GET : /v1/service/bbps/fetch/biller/category

Headers

Content-Type  (String)   required
application/json

Authorization  (String)   required
Basic Auth

Accept  (String)   required
application/json

Body Params

categoryName  (String)   Required
Bill Category Name (Max Length: 20)

page  (String)   Required
Category Page Number (Max Length: 20)

pageSize  (String)   Required
Category Page Size (Max Length: 20)

Request

Example Request

    curl --location --request GET '/v1/service/bbps/fetch/biller/category' \
        --header 'Content-Type: application/json' \
        --header 'Authorization: Basic Og==' \
        --data '{
            "categoryName" : "Electricity",
            "page" : "0",
            "pageSize" : "500"
        }'

Response Samples

SUCCESS

    {
        "code": "0x0200",
        "message": "Record fetched successfully.",
        "status": "SUCCESS",
        "data": {
            "billerResp": [
                {
                    "billerId": "121F00000NAT4D",
                    "billerName": "121 Finance Private Limited",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Loan Repayment",
                    "billerCoverage": "IND",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact and above"
                },
                {
                    "billerId": "EDU017960UTT01",
                    "billerName": "5Th Centenary School",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Education Fees",
                    "billerCoverage": "IND-UTT-Udham Singh Nagar",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact"
                },
                {
                    "billerId": "EDU009008MAP01",
                    "billerName": "7I World School Shivpuri Link Road Gwalior",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Education Fees",
                    "billerCoverage": "IND-MAP-Gwalior",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact"
                },
                {
                    "billerId": "EDU012723RAJ01",
                    "billerName": "A'S Saint Steward Morris School",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Education Fees",
                    "billerCoverage": "IND-RAJ-Bhilwara",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact"
                },
                {
                    "billerId": "EDU013533TND01",
                    "billerName": "Aaa International School",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Education Fees",
                    "billerCoverage": "IND-TND-Virudhunagar",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact"
                },
                {
                    "billerId": "EDU013534TND01",
                    "billerName": "Aachi International School",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Education Fees",
                    "billerCoverage": "IND-TND-Madurai",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact"
                },
                {
                    "billerId": "AADA00000ASMNP",
                    "billerName": "Aadarsh Gurukul Senior Secondary School",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Education Fees",
                    "billerCoverage": "IND-ASM",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact and below"
                },
                {
                    "billerId": "EDU011391PUN01",
                    "billerName": "Aadesh International School",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Education Fees",
                    "billerCoverage": "IND-PUN-Hoshiarpur",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact"
                },
                {
                    "billerId": "EDU002707CHH01",
                    "billerName": "Aadeshwar Academy",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Education Fees",
                    "billerCoverage": "IND-CHH-Bastar",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": false,
                    "paymentAmountExactness": "Exact"
                },
                {
                    "billerId": "AADH00000NATPT",
                    "billerName": "Aadhar Housing Finance Limited",
                    "billerType": "FETCH_PAY",
                    "billerCategory": "Loan Repayment",
                    "billerCoverage": "IND",
                    "billerResponseType": "SINGLE",
                    "billerDescription": "Please enter the Application ID/Loan Account No.. Do not include any special characters.",
                    "planMDMRequirement": "NOT_SUPPORTED",
                    "adhocBiller": true,
                    "paymentAmountExactness": "Exact"
                }
            ],
            "pageNo": 0,
            "pageSize": 10,
            "totalElements": 22234,
            "totalPages": 2224,
            "generalResp": {
                "statusCode": "200",
                "status": "success",
                "message": "Billers retrieved successfully",
                "remarks": ""
            }
        }
    }

FAILED

    {
        "code": "0x0202",
        "status": "FAILURE",
        "message": "No Record found",
        "data": "Please use valid name"
    }

Response Code

Status Code	Status	Message
0x0200	SUCCESS	TRANSACTION SUCCESSFULL
0x0201	UNAUTHORIZED	UNAUTHORIZED USER
0x0202	FAILURE	FAILURE USER
0x0203	MISSING_PARAMETER	MISSING PARAMETER
0x0204	CONNECTION_TIMEOUT	CONNECTION TIMEOUT
0x0205	SOMETHING_WENT_WRONG	SOMETHING WENT WRONG
0x0206	PENDING	TRANSACTION PENDING
0x0207	REVERSED	TRANSACTION REVERSED
0x0209	REDIRECT	REDIRECT URL