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

M

BillerId of the Biller

externalRef

String

M

Unique Reference Id

enquiryReferenceId

String

O

Mandatory When doing Bill Fetch and Validation. Pass the Bill Fetch or Validation Id received in Response

inputParameters.param1

Number

M

Biller Value

initChannel

String

M

Channel of the Biller

deviceInfo.terminalId

Number

M

Terminal Id of the Device

deviceInfo.mobile

Number

M

Mobile Number

deviceInfo.postalCode

Number

M

Postal Code

deviceInfo.geoCode

Number

M

Geo Location in lat long separated by comma

paymentMode

String

M

Payment Mode of the Biller

paymentInfo.Remarks

String

M

Remarks according to Payment mode

remarks.param1

Number

M

Customer Mobile Number

transactionAmount

Number

O

Transaction Amount

Sample Request

curl --location --request POST 'https://api.instantpay.in/marketplace/utilityPayments/payment' \
--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" : "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
}'
POST /marketplace/utilityPayments/payment 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" : "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
}

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

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