post https://api.instantpay.in/cards/prepaid/getInventory
Get all the cards existing in your inventory
Header Parameters
For Header Reference Click here
Request Parameters
| Name | Type | Mandatory (M) , Optional (O) | Description |
|---|---|---|---|
| pagination | Array | O | |
| pagination.pageNumber | Numeric | M | Number of page |
| pagination.recordsPerPage | Numeric | M | Number of records in a page |
| filters | Array | O | |
| filters.status | String | O | Active / Locked |
| filters.type | String | O | Virtual / Physical |
| filters.contact | String | O | contact number |
| filters.kitNumber | String | O | Kit number of physical card |
| sort | Array | O | |
| sort.by | String | status,type,kitNumber,expiryDate,shortCardNumber,name,emailId,mobileNumber,cardNetwork,binType,cardVariant | |
| sort.order | String | For Ascending order 'asc' For Descending order 'desc' |
Sample Request
curl --location --request POST 'https://api.instantpay.in/cards/prepaid/getInventory' \
--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 '{
"pagination": {
"pageNumber": 1,
"recordsPerPage": 10
},
"filters": {
"status": [
"PRINTING",
"INTRANSIT",
"INACTIVE",
"ACTIVE",
"LOCKED"
],
"type": [
"VIRTUAL",
"PHYSICAL"
],
"contact": "",
"kitNumber": null
},
"sort": {
"by": "name",
"order": "asc"
}
}'
POST /cards/prepaid/getInventory 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
{
"pagination": {
"pageNumber": 1,
"recordsPerPage": 10
},
"filters": {
"status": [
"PRINTING",
"INTRANSIT",
"INACTIVE",
"ACTIVE",
"LOCKED"
],
"type": [
"VIRTUAL",
"PHYSICAL"
],
"contact": "",
"kitNumber": null
},
"sort": {
"by": "name",
"order": "asc"
}
}
Response Parameters
For Response Reference Click here
Sample Response
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": {
"meta": {
"totalPages": 1,
"currentPage": 1,
"totalRecords": 1,
"recordsOnCurrentPage": 1,
"recordFrom": 1,
"recordTo": 1
},
"records": [
{
"bankId": "811009",
"nameOnCard": "Sample Name",
"binType": "PREPAID",
"branding": "InstantPay",
"status": "ACTIVE",
"type": "VIRTUAL",
"cardTag": null,
"cardNetwork": "RuPay",
"cardVariant": "PLATINUM",
"cardPerso": "N",
"kitNumber": "1711091234",
"expiryDate": "2000-01-01",
"cardBinNumber": "12345",
"shortCardNumber": "1234",
"name": "Instantpay",
"emailId": "[email protected]",
"mobileNumber": "7428585742",
"address": "Sample Address ",
"city": "City Name",
"state": "State Name",
"pincode": "110044"
}
]
},
"timestamp": "2034-04-24 21:56:20",
"ipay_uuid": "h0059be29cf0-9bc1-49ed-86bd-36ca6d0f6ed9-LmzZmBCOb7tc",
"orderid": "1230424215619QEDEL",
"environment": "LIVE",
"internalCode": null
}
Action Code Details
For Action Code details Click here