Payment Biller

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	Mandatory	BillerId of the Biller
externalRef	String	Mandatory	Unique Reference Id
enquiryReferenceId	String	Optional	Mandatory When doing Bill Fetch and Validation. Pass the Bill Fetch or Validation Id received in Response
telecomCircle	String	Optional (Mandatory when billerId is of Prepaid recharges)	You will get the data from Telecom Circle API
inputParameters.param1	Number	Mandatory	Biller Value
initChannel	String	Mandatory	Channel of the Biller
deviceInfo.terminalId	Number	Mandatory	Terminal Id of the Device
deviceInfo.mobile	Number	Mandatory	Mobile Number
deviceInfo.postalCode	Number	Mandatory	Postal Code
deviceInfo.geoCode	Number	Mandatory	Geo Location in lat long separated by comma
paymentMode	String	Mandatory	Payment Mode of the Biller
paymentInfo.Remarks	String	Mandatory	Remarks according to Payment mode
remarks.param1	Number	Mandatory	Customer Mobile Number
transactionAmount	Number	Mandatory	Transaction Amount
customerPan		Optional (Mandatory If transactionAmount is >= 50000 )	PAN Number of the Customer

Sample Request

curl --location --request POST 'https://api.instantpay.in/marketplace/utilityPayments/payment' \
--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" : "JIO000000NAT01",
    "externalRef":"123TEST",
    "enquiryReferenceId":"TSB6b77dbcb0d26423e91b5229922521106",
    "telecomCircle": ""
    "inputParameters":{
        "param1":"9876543211"
    },
    "initChannel" : "AGT",
    "deviceInfo" : {
        "terminalId" : "12813923",
        "mobile" : "9876543211",
        "postalCode" : "110044",
        "geoCode":"28.6326,77.2175"
    },
    "paymentMode":"Cash",
    "paymentInfo":{
        "Remarks":"CashPayment"
    },
    "remarks" : {
        "param1" :9876543211
    },
    "transactionAmount" : 13,
    "customerPan" : ""

}'

POST /marketplace/utilityPayments/payment HTTP/1.1
Host: api.instantpay.in
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" : "JIO000000NAT01",
    "externalRef":"123TEST",
    "enquiryReferenceId":"TSB6b77dbcb0d26423e91b5229922521106",
    "telecomCircle": "",
    "inputParameters":{
        "param1":"9876543211"
    },
    "initChannel" : "AGT",
    "deviceInfo" : {
        "terminalId" : "12813923",
        "mobile" : "9876543211",
        "postalCode" : "110044",
        "geoCode":"28.6326,77.2175"
    },
    "paymentMode":"Cash",
    "paymentInfo":{
        "Remarks":"CashPayment"
    },
    "remarks" : {
        "param1" : 9876543211
    },
    "transactionAmount" : 13,
    "customerPan" : ""

}

Response Parameters

Name	Type	Description
statuscode	String	InstantPay Status Code
actcode	String	Action Code
status	String	Status Message
data	String	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
internalCode	String	It will be null

Sample Response

{
    "statuscode": "TUP",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "externalRef": "123TEST",
        "poolReferenceId": "1220915151159ZPWNC",
        "txnValue": "1.00",
        "txnReferenceId": "00",
        "pool": {
            "account": "983****7",
            "openingBal": "8.88",
            "mode": "DR",
            "amount": "1.00",
            "closingBal": "7.88"
        },
        "billerDetails": {
            "name": "Airtel Postpaid",
            "account": "971*****05"
        },
        "billDetails": {
            "CustomerName": null,
            "BillNumber": null,
            "BillPeriod": null,
            "BillDate": null,
            "BillDueDate": null,
            "BillAmount": null,
            "CustomerParamsDetails": null
        }
    },
    "timestamp": "2022-09-15 15:11:59",
    "ipay_uuid": "h006974534a7-1662-4544-ade4-6dfaabb24f65",
    "orderid": "1220915151159XCYJA",
    "environment": "LIVE",
    "internalCode": null
}