post https://www.instantpay.in/ws/collections/upidqr/generate
Collect money from customers on your website with Dynamic BHIM UPI QR implementation.
Header Request
Accept : application/json
Content-Type: application/json
Request Parameters
Following are the parameters to be sent in the request body:
| Parameters | Mandatory (M) , Optional (O) | Descriptions |
|---|---|---|
| token | M | Token is a unique identifier of an application requesting access to your service. |
| request | M | Array |
| request.purpose | M | Payment remarks for the transaction |
| request.amount | M | Amount to be transferred |
| request.external_ref | M | Your transaction ID (Agent ID) |
| request.latitude | M | End Customer Latitude |
| request.longitude | M | End Customer Longitude |
| request.endpoint_ip | M | End Customer IP Address |
| request.expires | O | expiry time.Enter timestamp. |
| request.customer_vpa | O | VPA of the customer |
Note:-
Configure a Webhook from https://www.instantpay.in/developers/api/webhooks to receive payment notifications.
Sample Request
curl --location --request POST 'https://www.instantpay.in/ws/collections/upidqr/generate' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"token": "bf94012f**********65187117853ab4",
"request": {
"purpose": "Final Test",
"amount": "1",
"external_ref": "1645590072",
"latitude": "28.6097",
"longitude": "77.2046",
"endpoint_ip": "1*.***.***.**4",
"customer_mobile": "90******07",
"customer_email": "sh******@gmail.com"
}
}'
POST /ws/collections/upidqr/generate HTTP/1.1
Host: www.instantpay.in
Content-Type: application/json
Accept: application/json
{
"token": "bf94012f**********65187117853ab4",
"request": {
"purpose": "Final Test",
"amount": "1",
"external_ref": "1645590086",
"latitude": "28.6097",
"longitude": "77.2046",
"endpoint_ip": "1*.***.***.**4",
"customer_mobile": "90******07",
"customer_email": "sh*****@gmail.com"
}
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| statuscode | String | InstantPay Status 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/Sandbox |
Sample Response
{
"statuscode": "TXN",
"status": "QR Code generated Successfully",
"data": {
"amount": "1.00",
"order_id": "CIU0************82",
"upi_qr_string": "upi://pay?pa=dqr.189590@icici&pn=SHWETA STORE&tr=DQRCIU012205409503382&tn=Final Test&am=1&cu=INR&mc=5411"
},
"timestamp": "2022-02-23 09:50:33",
"ipay_uuid": "A1E4A04125E5FFDBEE47",
"orderid": "CIU0***********82",
"environment": "PRODUCTION"
}
Note :
1 - Latitude and Longitude must be represented in degrees with 4 digits after decimal.
2- externalRef must be unique and in alpha numeric characters.
3- Remarks should be in alphabet and it can be of maximum 20 characters.
4- Purpose are Case Sensitive.