get https://api.instantpay.in/marketplace/utilityPayments/category
The Get Category feature organises various billing services, like telecom and utilities. It helps businesses streamline their billing options. With this, users can easily navigate billing categories. It ensures a simple, organised payment process that improves service delivery.
Header Parameters
Name | Type | Description | Mandatory (M) , Optional (O) | Provided by INSTANTPAY (Y/N) |
---|---|---|---|---|
X-Ipay-Auth-Code | String | Auth Code - 1 (Fixed) | M | Y |
X-Ipay-Client-Id | String | Unique Client ID | M | Y |
X-Ipay-Client-Secret | String | Unique secret key | M | Y |
X-Ipay-Outlet-Id | String | Merchant unique ID | M | Y |
X-Ipay-Endpoint-Ip | String | End Customer IP Address | M | N |
Sample Request
curl --location --request GET 'https://api.instantpay.in/marketplace/utilityPayments/category' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'X-Ipay-Outlet-Id: {{outletID}}' \
--data-raw '
'
GET /marketplace/utilityPayments/category HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=
X-Ipay-Client-Secret: 679db35f926b8d0240a8c0d28729528ee8e6d5effa5fa0b20c04454004d2d825
X-Ipay-Endpoint-Ip: 45.115.105.205
X-Ipay-Outlet-Id: 72762
Response Parameters
Name | Type | Description |
---|---|---|
statuscode | String | InstantPay Status Code |
actcode | String | Action Code |
status | String | Status Message |
data | Array | Response Data (If Present) |
timestamp | String | Current time (YYYY-MM-DD HH:II:SS) |
ipay_uuid | String | Request reference number |
orderid | String | Transaction Id ( If transaction otherwise it is null ) |
environment | String | Live |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Biller Category fetched successfully",
"data": [
{
"categoryKey": "C05",
"categoryName": "Broadband",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C05.svg",
"billerList": 864
},
{
"categoryKey": "C06",
"categoryName": "Cable TV",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C06.svg",
"billerList": 52
},
{
"categoryKey": "C22",
"categoryName": "Clubs & Associations",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C22.svg",
"billerList": 20
},
{
"categoryKey": "C15",
"categoryName": "Credit Card",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C15.svg",
"billerList": 17
},
{
"categoryKey": "C12",
"categoryName": "Donation",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C12.svg",
"billerList": 24
},
{
"categoryKey": "C03",
"categoryName": "DTH",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C03.svg",
"billerList": 11
},
{
"categoryKey": "C09",
"categoryName": "Education Fee",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C09.svg",
"billerList": 38890
},
{
"categoryKey": "C04",
"categoryName": "Electricity",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C04.svg",
"billerList": 107
},
{
"categoryKey": "C29",
"categoryName": "Electricity (Prepaid)",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C28.svg",
"billerList": 1
},
{
"categoryKey": "C10",
"categoryName": "FASTag Recharge",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C10.svg",
"billerList": 26
},
{
"categoryKey": "C14",
"categoryName": "Gas (LPG Cylinder)",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C14.svg",
"billerList": 4
},
{
"categoryKey": "C07",
"categoryName": "Gas (PNG)",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C07.svg",
"billerList": 74
},
{
"categoryKey": "C21",
"categoryName": "Hospital & Pathology",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C21.svg",
"billerList": 40
},
{
"categoryKey": "C17",
"categoryName": "Housing Society",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C17.svg",
"billerList": 238
},
{
"categoryKey": "C11",
"categoryName": "Insurance",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C11.svg",
"billerList": 216
},
{
"categoryKey": "C02",
"categoryName": "Landline",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C02.svg",
"billerList": 10
},
{
"categoryKey": "C13",
"categoryName": "Loan EMI",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C13.svg",
"billerList": 365
},
{
"categoryKey": "C01",
"categoryName": "Mobile (Postpaid)",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C01.svg",
"billerList": 14
},
{
"categoryKey": "C00",
"categoryName": "Mobile (Prepaid)",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C00.svg",
"billerList": 8
},
{
"categoryKey": "C19",
"categoryName": "Municipal Taxes",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C19.svg",
"billerList": 160
},
{
"categoryKey": "C30",
"categoryName": "National Pension Scheme (NPS)",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C28.svg",
"billerList": 1
},
{
"categoryKey": "C28",
"categoryName": "NCMC Recharge",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C28.svg",
"billerList": 1
},
{
"categoryKey": "C20",
"categoryName": "Recurring Deposit",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C20.svg",
"billerList": 44
},
{
"categoryKey": "C24",
"categoryName": "Rental",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C24.svg",
"billerList": 18
},
{
"categoryKey": "C18",
"categoryName": "Subscription",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C18.svg",
"billerList": 62
},
{
"categoryKey": "C08",
"categoryName": "Water",
"iconUrl": "https://static.instantpay.in/assets/logo/products/C08.svg",
"billerList": 61
}
],
"timestamp": "2024-09-05 13:00:20",
"ipay_uuid": "h0009cef6d21-c93c-45da-8c77-01934dd2a67e-3KZJsqVPqDPV",
"orderid": null,
"environment": "LIVE"
}