Get Biller List

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: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: 8f1e060b08e376348b39b6da2472b4b8921b1e2a302b5a0123c91007b11bb084' \
--header 'X-Ipay-Endpoint-Ip: 45.115.105.205' \
--header 'X-Ipay-Outlet-Id: 72762' \
--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": 3857,
            "currentPage": 1,
            "totalRecords": 38562,
            "recordsOnCurrentPage": 10,
            "recordFrom": 1,
            "recordTo": 10
        },
        "records": [
            {
                "billerId": "STV",
                "billerName": "Sun Direct",
                "categoryKey": "C03",
                "type": "OFFUS",
                "categoryName": "DTH",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2020-04-17",
                "billerStatus": "ACTIVE",
                "isAvailable": true
            },
            {
                "billerId": "BVP",
                "billerName": "BSNL (OLD)",
                "categoryKey": "CP0",
                "type": "OFFUS",
                "categoryName": "Mobile (Prepaid)",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2020-04-17",
                "billerStatus": "ACTIVE",
                "isAvailable": false
            },
            {
                "billerId": "BESTON000MUM01",
                "billerName": "B.E.S.T. MUMBAI (ON-US)",
                "categoryKey": "C04",
                "type": "ONUS",
                "categoryName": "Electricity",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2022-09-12",
                "billerStatus": "ACTIVE",
                "isAvailable": true
            },
            {
                "billerId": "VTV",
                "billerName": "d2h",
                "categoryKey": "C03",
                "type": "OFFUS",
                "categoryName": "DTH",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2020-04-17",
                "billerStatus": "ACTIVE",
                "isAvailable": true
            },
            {
                "billerId": "ATP",
                "billerName": "Airtel",
                "categoryKey": "C00",
                "type": "OFFUS",
                "categoryName": "Mobile (Prepaid)",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2020-04-17",
                "billerStatus": "ACTIVE",
                "isAvailable": true
            },
            {
                "billerId": "MPEZ00000MAP01",
                "billerName": "M.P. Poorv Kshetra Vidyut Vitaran - URBAN",
                "categoryKey": "C04",
                "type": "ONUS",
                "categoryName": "Electricity",
                "coverageCity": "-",
                "coverageState": "MADHYA PRADESH",
                "coveragePincode": 0,
                "updatedDate": "2020-04-11",
                "billerStatus": "ACTIVE",
                "isAvailable": true
            },
            {
                "billerId": "MMP",
                "billerName": "MTNL",
                "categoryKey": "C00",
                "type": "OFFUS",
                "categoryName": "Mobile (Prepaid)",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2020-04-17",
                "billerStatus": "ACTIVE",
                "isAvailable": true
            },
            {
                "billerId": "MSP",
                "billerName": "MTNL (OLD)",
                "categoryKey": "CP0",
                "type": "OFFUS",
                "categoryName": "Mobile (Prepaid)",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2020-04-17",
                "billerStatus": "ACTIVE",
                "isAvailable": false
            },
            {
                "billerId": "TTV",
                "billerName": "Tata Play",
                "categoryKey": "C03",
                "type": "OFFUS",
                "categoryName": "DTH",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2020-04-17",
                "billerStatus": "ACTIVE",
                "isAvailable": true
            },
            {
                "billerId": "BGP",
                "billerName": "BSNL",
                "categoryKey": "C00",
                "type": "OFFUS",
                "categoryName": "Mobile (Prepaid)",
                "coverageCity": "-",
                "coverageState": "-",
                "coveragePincode": 0,
                "updatedDate": "2020-04-17",
                "billerStatus": "ACTIVE",
                "isAvailable": true
            }
        ]
    },
    "timestamp": "2022-09-14 16:21:10",
    "ipay_uuid": "h06897434a69-*****************-7dc9b657e597",
    "orderid": null,
    "environment": "LIVE",
}
Language
Click Try It! to start a request and see the response here!