Get all Inventory Cards

📘

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?pagination[recordsPerPage]=10&filters[status][]=PROCESSING&filters[status][]=PROCESSING_FAILED&filters[status][]=INACTIVE&filters[status][]=ACTIVE&filters[status][]=LOCKED&filters[status][]=BLOCKED&filters[type][]=VIRTUAL&filters[type][]=PHYSICAL&filters[contact]={{mobileNumber}}&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?pagination[recordsPerPage]=10&filters[status][]=PROCESSING&filters[status][]=PROCESSING_FAILED&filters[status][]=INACTIVE&filters[status][]=ACTIVE&filters[status][]=LOCKED&filters[status][]=BLOCKED&filters[type][]=VIRTUAL&filters[type][]=PHYSICAL&filters[contact]={{mobileNumber}}&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}}

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": 1,
            "recordsOnCurrentPage": 1,
            "recordFrom": 1,
            "recordTo": 1
        },
        "records": [
            {
                "bankId": 1****9,
                "trackingId": "2",
                "name": "S*****Z **I",
                "branding": "InstantPay",
                "status": "ACTIVE",
                "type": "Physical",
                "tag": null,
                "cardNetwork": "RuPay",
                "cardVariant": "CORPORATE",
                "cardPerso": "Y",
                "kitNumber": "3********6",
                "expiryDate": "2024-02-29",
                "cardBinNumber": "8****9",
                "shortCardNumber": "5**2",
                "emailId": "[email protected]",
                "mobileNumber": "98******07"
            }
        ]
    },
    "timestamp": "2022-04-11 15:36:13",
    "ipay_uuid": "h006960968d0-a99c-421f-b558-964153b7f8f8",
    "orderid": null,
    "environment": "LIVE"
}
Language
URL
Click Try It! to start a request and see the response here!