Validate Billers

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code - 1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Outlet-IdStringMerchant unique IDMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

NameTypeMandatory (M) , Optional (O)Description
billerIdStringMBillerId of the Biller
initChannelStringMChannel of the Biller
externalRefStringMUnique Reference Id
inputParameters.param1NumberMBiller Value
deviceInfo.macStringMDevice Mac Id
deviceInfo.ipStringMDevice Ip Address
remarks.param1NumberMCustomer Mobile Number
transactionAmountNumberMAmount

Sample Request

curl --location --request POST 'https://api.instantpay.in/marketplace/utilityPayments/prePaymentEnquiry' \
 --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 '
{
		"billerId" : "UPPCL0000UTP01",
    "initChannel" : "AGT",
    "externalRef":"123TEST",
    "inputParameters":{
        "param1":3584****5000
    },
    "deviceInfo" : {
        "mac":"BC-BE-33-65-E6-AC",
        "ip":"103.254.205.164"
    },
    "remarks" : {
        "param1" : 9999999999
    },
    "transactionAmount" : 10
}'
POST /marketplace/utilityPayments/prePaymentEnquiry HTTP/1.1
ost: 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

{
   "billerId" : "UPPCL0000UTP01",
    "initChannel" : "AGT",
    "externalRef":"123TEST",
    "inputParameters":{
        "param1":3584****5000
    },
    "deviceInfo" : {
        "mac":"BC-BE-33-65-E6-AC",
        "ip":"103.254.205.164"
    },
    "remarks" : {
        "param1" : 9999999999
    },
    "transactionAmount" : 10
}

Response Parameters

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "enquiryReferenceId": "TSB1a481c1f6a5d44c986dc481822571516",
        "CustomerName": "SMT DEVI",
        "BillNumber": "358495532763",
        "BillPeriod": "NA",
        "BillDate": "09/09/2022",
        "BillDueDate": "16/09/2022",
        "BillAmount": "1981.00",
        "CustomerParamsDetails": [
            {
                "Name": "Consumer Number",
                "Value": "3584****5000"
            }
        ]
    },
    "timestamp": "2022-09-14 15:16:35",
    "ipay_uuid": "h00697433346-**************-30a7a5fa526d",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!