Bill Enquiry

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

billerId

String

M

BillerId of the Biller

initChannel

String

M

Channel of the Biller

externalRef

String

M

Unique Reference Id

inputParameters.param1

Number

M

Biller Value

deviceInfo.mac

String

M

Device Mac Id

deviceInfo.ip

String

M

Device Ip Address

remarks.param1

Number

M

Customer Mobile Number

transactionAmount

Number

O

Amount

Sample Request

curl --location --request POST 'https://api.instantpay.in/marketplace/utilityPayments/prePaymentEnquiry' \
--header 'Accept: 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 'Content-Type: application/json' \
--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
Host: api.instantpay.in
Content-Type: application/json
Accept: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}

{
   "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

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": "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",
}
Language
Click Try It! to start a request and see the response here!