post https://api.instantpay.in/cards/gift
The API will be used to place order in our system.
Header Parameters
For Header references Click here
Request Parameters
| Name | Type | Mandatory (M), Optional (O) | Description |
|---|---|---|---|
| receiver | Array | M | Receiver Details |
| receiver.name | String | M | Receiver Name |
| receiver.contact | String | M | Receiver Mobile Number or Email ID |
| receiver.pincode | String | M | Receiver Pincode |
| receiver.city | String | M | Receiver City Name |
| receiver.address | String | M | Receiver Address |
| quantity | String | M | Card Quantity |
| latitude | String | M | Current Location Latitude |
| longitude | String | M | Current Location Longitude |
| externalRef | String | M | Unique Reference Number |
| iPin | String | M | Instantpay Pin |
Sample Request
curl --location --request POST 'https://api.instantpay.in/cards/gift' \
--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 '{
"receiver": {
"name": "S****** ****a",
"contact" : "sh*********[email protected]",
"pincode": "1*****",
"city": "Delhi",
"address": "S*******r, New Delhi"
},
"quantity": 1,
"latitude": "28.8951",
"longitude": "78.0364",
"externalRef": "12345678",
"iPin": "9**7"
}'
POST /cards/gift HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
{
"receiver": {
"name": "S****** ****a",
"contact" : "sha*****[email protected]",
"pincode": "1*****",
"city": "Delhi",
"address": "S*******r, New Delhi"
},
"quantity": 1,
"latitude": "28.8951",
"longitude": "78.0364",
"externalRef": "12345678",
"iPin": "9**7"
}
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/Sandbox |
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Order successfully placed",
"data": {
"ipayId": "122022********SUWWS",
"openingBalance": "106.87",
"closingBalance": "7.87",
"transactionValue": "0.00",
"payableValue": "99.00",
"commissionEarned": 0,
"commissionPaid": 0,
"surchargeEarned": "99.0000",
"surchargePaid": 29.5,
"instantpayCcf": "0.00",
"gatewayCcf": "0.00",
"bpCommission": 0,
"tds": "0.0000",
"cashback": 0
},
"timestamp": "2022-02-21 17:16:52",
"ipay_uuid": "**********-****-****-****-**********",
"orderid": "12202********SUWWS",
"environment": "LIVE",
}