📘
Header Parameters
For Header references Click here

Sample Request (Lock/Unlock/Block)

curl --location --request PATCH 'https://api.instantpay.in/cards/gift/{{kitNumber}}?status={{Unlock}}&iPin={{iPin}}' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \

PATCH /cards/gift/{{kitNumber}}?status={{Change status}}&iPin={{iPin}} 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 (Lock)

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Card locked successfully",
    "data": null,
    "timestamp": "2022-04-11 14:51:32",
    "ipay_uuid": "h068960958d4-1219-47e3-aa9d-37f31c1f6ede",
    "orderid": null,
    "environment": "LIVE",

}

Sample Response (Unlock)

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Card unlocked successfully",
    "data": null,
    "timestamp": "2022-04-11 14:51:32",
    "ipay_uuid": "h068960958d4-1219-47e3-aa9d-37f31c1f6ede",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null

}

Sample Response (Block)

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Card blocked successfully",
    "data": null,
    "timestamp": "2022-04-11 14:51:32",
    "ipay_uuid": "h068960958d4-1219-47e3-aa9d-37f31c1f6ede",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null

}

🚧
Important Notice
Status can be changed between Lock and Unlock.
Status cannot be changed of blocked card.

200200

400400