Order Cards

The API will be used to place order in our system.

📘

Header Parameters

For Header references Click here

Request Parameters

NameTypeMandatory (M), Optional (O)Description
receiverArrayMReceiver Details
receiver.nameStringMReceiver Name
receiver.contactStringMReceiver Mobile Number or Email ID
receiver.pincodeStringMReceiver Pincode
receiver.cityStringMReceiver City Name
receiver.addressStringMReceiver Address
quantityStringMCard Quantity
latitudeStringMCurrent Location Latitude
longitudeStringMCurrent Location Longitude
externalRefStringMUnique Reference Number
iPinStringMInstantpay 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": "Instantpay India Limited",
        "contact" : "[email protected]",
        "pincode": "110044",
        "city": "Delhi",
        "address": "Mohan Cooperative Industrial Estate, New Delhi"
    },
    "quantity": 1,
    "latitude": "28.8951",
    "longitude": "78.0364",
    "externalRef": "12345678",
    "iPin": "9127"
}'
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": "Instantpay India Limited",
        "contact" : "[email protected]",
        "pincode": "110044",
        "city": "Delhi",
        "address": "Mohan Cooperative Industrial Estate, New Delhi"
    },
    "quantity": 1,
    "latitude": "28.8951",
    "longitude": "78.0364",
    "externalRef": "12345678",
    "iPin": "9127"
}'

Response Parameters

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringCurrent Time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest Reference Number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox

Sample Response

{
   "statuscode": "TXN",
   "actcode": null,
   "status": "Order successfully placed",
   "data": {
       "ipayId": "1220424130343AXKFA",
       "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": "h0069be1d940-55f6-4721-92fa-2b4fe044ac93-zOoANC91jcV0",
   "orderid": "1220424130343AXKFAS",
   "environment": "LIVE",
}

Language
Click Try It! to start a request and see the response here!