get https://api.instantpay.in/cards/gift/getInventory/getInventory
Header Parameters
For Header references Click here
Request Parameters
| Name | Type | Mandatory (M), Optional (O) | Description |
|---|---|---|---|
| pagination | Array | M | Pagination Details |
| pagination.pageNumber | String | M | Page Number |
| pagination.recordsPerPage | String | M | Records in a Page |
| filters | Array | M | Filter Details |
| filters.status | String | M | INACTIVE, PROCESSING, PROCESSING_FAILED, ACTIVE, LOCKED, BLOCKED |
| filters.type | String | M | VIRTUAL , PHYSICAL |
| filters.contact | String | M | Contact number |
| filters.kitNumber | String | M | Kit Number of Gift Card |
| sort | Array | M | For Sorting |
| sort.by | String | M | Sorting Field Name |
| sort.order | String | M | asc- Ascending Order Desc- Descending Order |
Sample Request
curl --location --request GET 'https://api.instantpay.in/cards/gift/getInventory' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
--header 'X-Ipay-Client-Secret: d9bfb3b4da2ce8a908f60b09b6765e357caac7adca641f8dc0358db02170841c' \
--header 'X-Ipay-Endpoint-Ip: 45.115.105.205' \
--data-raw '{
"pagination": {
"pageNumber": 1,
"recordsPerPage": 2
},
"filters": {
"status": [
"INACTIVE",
"PROCESSING",
"PROCESSING_FAILED",
"ACTIVE",
"LOCKED",
"BLOCKED"
],
"type": [
"VIRTUAL",
"PHYSICAL"
],
"contact": "",
"kitNumber": null
},
"sort": {
"by": "name",
"order": "asc"
}
}'
GET /cards/gift/getInventory HTTP/1.1
Host: 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: d9bfb3b4da2ce8a908f60b09b6765e357caac7adca641f8dc0358db02170841c
X-Ipay-Endpoint-Ip: 45.115.105.205
Content-Length: 477
{
"pagination": {
"pageNumber": 1,
"recordsPerPage": 2
},
"filters": {
"status": [
"INACTIVE",
"PROCESSING",
"PROCESSING_FAILED",
"ACTIVE",
"LOCKED",
"BLOCKED"
],
"type": [
"VIRTUAL",
"PHYSICAL"
],
"contact": "",
"kitNumber": null
},
"sort": {
"by": "name",
"order": "asc"
}
}
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": "Transaction Successful",
"data": {
"meta": {
"totalPages": 1,
"currentPage": 1,
"totalRecords": 2,
"recordsOnCurrentPage": 2,
"recordFrom": 1,
"recordTo": 2
},
"records": [
{
"id": 10,
"bankId": 134119,
"nameOnCard": "**** *******",
"branding": "InstantPay",
"status": "ACTIVE",
"type": "PHYSICAL",
"cardNetwork": "RuPay",
"cardVariant": "CORPORATE",
"cardPerso": "Y",
"kitNumber": "31******06",
"expiryDate": "2023-09-30",
"cardBinNumber": "81****69",
"shortCardNumber": "0**8",
"name": "**** ******",
"emailId": "suje******instantpay.in",
"mobileNumber": "97******05",
"address": "HOUSE NUMBER- *********NUMBER-26, ",
"city": "JH******NUN",
"state": "RAJASTHAN",
"pincode": "33****01"
},
{
"id": 11,
"bankId": 134119,
"nameOnCard": "**** *******",
"branding": "InstantPay",
"status": "ACTIVE",
"type": "PHYSICAL",
"cardNetwork": "RuPay",
"cardVariant": "CORPORATE",
"cardPerso": "Y",
"kitNumber": "31*******05",
"expiryDate": "2023-09-30",
"cardBinNumber": "81**69",
"shortCardNumber": "0**8",
"name": "***** *****",
"emailId": "suje******@instantpay.in",
"mobileNumber": "97******05",
"address": "HOUSE NUMBER- ********NUMBER-26, ",
"city": "JH*****NUN",
"state": "RAJASTHAN",
"pincode": "33**01"
}
]
},
"timestamp": "2022-02-23 16:47:14",
"ipay_uuid": "**********-****-****-****-**********",
"orderid": null,
"environment": "LIVE",
}