Download all Existing Inventory Cards

The API will be used to download all existing cards in the inventory in csv or xlsx format.

📘

Header Parameters

For Header references Click here

Query Params

Name

Description

pagination

Records per page

status

PROCESSING
PROCESSING_FAILED
INACTIVE
ACTIVE
LOCKED
BLOCKED

type

VIRTUAL
PHYSICAL

sort

sort by name

sort

sort by order (asc)

kitnumber

pass the kitnumber of the card in the url body

mobilenumber

pass the registered mobile number in the url body

Sample Request

curl --location -g --request GET 'https://api.instantpay.in/cards/gift/getInventory/download?type=xlsx&pagination[recordsPerPage]=10&filters[status][]=PROCESSING&filters[status][]=PROCESSING_FAILED&filters[status][]=INACTIVE&filters[status][]=ACTIVE&filters[status][]=LOCKED&filters[type][]=VIRTUAL&filters[type][]=PHYSICAL&filters[contact]={{contact number}}&filters[kitNumber]={{kitnumber}}&sort[by]=name&sort[order]=asc' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
GET /cards/gift/getInventory/download?type=xlsx&pagination[recordsPerPage]=10&filters[status][]=PROCESSING&filters[status][]=PROCESSING_FAILED&filters[status][]=INACTIVE&filters[status][]=ACTIVE&filters[status][]=LOCKED&filters[type][]=VIRTUAL&filters[type][]=PHYSICAL&filters[contact]={{contact number}}&filters[kitNumber]={{kitnumber}}&sort[by]=name&sort[order]=asc 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}}

Sample Response

📘

Info :

Downloaded file will be in csv/xlsx format as passed in the URL.

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