Payment Biller

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
billerIdStringMandatoryBillerId of the Biller
externalRefStringMandatoryUnique Reference Id
enquiryReferenceIdStringOptionalMandatory When doing Bill Fetch and Validation. Pass the Bill Fetch or Validation Id received in Response
inputParameters.param1NumberMandatoryBiller Value
initChannelStringMandatoryChannel of the Biller
deviceInfo.terminalIdNumberMandatoryTerminal Id of the Device
deviceInfo.mobileNumberMandatoryMobile Number
deviceInfo.postalCodeNumberMandatoryPostal Code
deviceInfo.geoCodeNumberMandatoryGeo Location in lat long separated by comma
paymentModeStringMandatoryPayment Mode of the Biller
paymentInfo.RemarksStringMandatoryRemarks according to Payment mode
remarks.param1NumberMandatoryCustomer Mobile Number
transactionAmountNumberMandatoryTransaction Amount
customerPanOptional
(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",
    "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",
    "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

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataStringResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive
internalCodeStringIt 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
}
Language
Click Try It! to start a request and see the response here!