post https://api.instantpay.in/marketplace/utilityPayments/billers
Instantpay's API has a Get Biller List feature. It provides a list of billers for telecom, gas, electricity, and insurance services. This feature lets businesses give users many billing options. It makes bill payments more flexible and inclusive.
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 |
Request Parameters
| Name | Type | Mandatory (M) , Optional (O) | Description |
|---|---|---|---|
| pagination.pageNumber | String | O | Current Page Number |
| pagination.recordsPerPage | String | O | Number of Details per Page |
| filters.updatedAfterDate | String | O | Updation of Biller Date |
Sample Request
curl --location --request POST 'https://api.instantpay.in/marketplace/utilityPayments/billers' \
--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 '{
"pagination" : {
"pageNumber" : 1,
"recordsPerPage" : 10
},
"filters":{
"categoryKey" : "",
"updatedAfterDate" : ""
}
}'
POST /marketplace/utilityPayments/billers 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: 8f1e060b08e376348b39b6da2472b4b8921b1e2a302b5a0123c91007b11bb084
X-Ipay-Endpoint-Ip: 45.115.105.205
X-Ipay-Outlet-Id: 72762
Content-Length: 169
{
"pagination" : {
"pageNumber" : 1,
"recordsPerPage" : 10
},
"filters":{
"categoryKey" : "",
"updatedAfterDate" : ""
}
}
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": "Billers List fetched successfully",
"data": {
"meta": {
"totalPages": 1,
"currentPage": 1,
"totalRecords": 8,
"recordsOnCurrentPage": 8,
"recordFrom": 1,
"recordTo": 8
},
"records": [
{
"billerId": "ATP",
"billerName": "Airtel",
"categoryKey": "C00",
"type": "OFFUS",
"categoryName": "Mobile (Prepaid)",
"coverageCity": "-",
"coverageState": "-",
"coveragePincode": 0,
"updatedDate": "2020-04-17",
"billerStatus": "ACTIVE",
"isAvailable": true,
"iconUrl": "https://static.instantpay.in/assets/logo/products/ATP.svg"
},
{
"billerId": "BSNL00000NATHL",
"billerName": "BSNL",
"categoryKey": "C00",
"type": "ONUS",
"categoryName": "Mobile (Prepaid)",
"coverageCity": "-",
"coverageState": "-",
"coveragePincode": 110001,
"updatedDate": "2022-06-06",
"billerStatus": "ACTIVE",
"isAvailable": true,
"iconUrl": "https://static.instantpay.in/assets/logo/products/BSNL00000NATHL.svg"
},
{
"billerId": "BGP",
"billerName": "BSNL (OLD)",
"categoryKey": "C00",
"type": "OFFUS",
"categoryName": "Mobile (Prepaid)",
"coverageCity": "-",
"coverageState": "-",
"coveragePincode": 0,
"updatedDate": "2020-04-17",
"billerStatus": "ACTIVE",
"isAvailable": true,
"iconUrl": "https://static.instantpay.in/assets/logo/products/BGP.svg"
},
{
"billerId": "IDP",
"billerName": "Idea (OLD)",
"categoryKey": "C00",
"type": "OFFUS",
"categoryName": "Mobile (Prepaid)",
"coverageCity": "-",
"coverageState": "-",
"coveragePincode": 0,
"updatedDate": "2020-04-17",
"billerStatus": "BLOCKED",
"isAvailable": false,
"iconUrl": "https://static.instantpay.in/assets/logo/products/IDP.svg"
},
{
"billerId": "MTNL00000NAT1U",
"billerName": "MTNL",
"categoryKey": "C00",
"type": "ONUS",
"categoryName": "Mobile (Prepaid)",
"coverageCity": "-",
"coverageState": "-",
"coveragePincode": 110001,
"updatedDate": "2023-11-08",
"billerStatus": "ACTIVE",
"isAvailable": true,
"iconUrl": "https://static.instantpay.in/assets/logo/products/MTNL00000NAT1U.svg"
},
{
"billerId": "MMP",
"billerName": "MTNL (OLD)",
"categoryKey": "C00",
"type": "OFFUS",
"categoryName": "Mobile (Prepaid)",
"coverageCity": "-",
"coverageState": "-",
"coveragePincode": 0,
"updatedDate": "2020-04-17",
"billerStatus": "ACTIVE",
"isAvailable": false,
"iconUrl": "https://static.instantpay.in/assets/logo/products/MMP.svg"
},
{
"billerId": "RJP",
"billerName": "Reliance Jio",
"categoryKey": "C00",
"type": "OFFUS",
"categoryName": "Mobile (Prepaid)",
"coverageCity": "-",
"coverageState": "-",
"coveragePincode": 0,
"updatedDate": "2020-04-17",
"billerStatus": "ACTIVE",
"isAvailable": true,
"iconUrl": "https://static.instantpay.in/assets/logo/products/RJP.svg"
},
{
"billerId": "VFP",
"billerName": "Vi",
"categoryKey": "C00",
"type": "OFFUS",
"categoryName": "Mobile (Prepaid)",
"coverageCity": "-",
"coverageState": "-",
"coveragePincode": 0,
"updatedDate": "2020-04-17",
"billerStatus": "ACTIVE",
"isAvailable": true,
"iconUrl": "https://static.instantpay.in/assets/logo/products/VFP.svg"
}
]
},
"timestamp": "2024-09-05 12:08:10",
"ipay_uuid": "h0009cef5a7a-038d-43d2-81e0-ecda27999c97-GWCgWBAU0Qwp",
"orderid": null,
"environment": "LIVE"
}