get https://api.instantpay.in/cards/gift/balance/{{kitNumber}}
The API will be used to check gift card balance.
Header Parameters
For Header references Click here
Query Params
| Name | Description |
|---|---|
| kitnumber | pass the kitnumber of the card in the url body |
Sample Request
curl --location --request GET 'https://api.instantpay.in/cards/gift/balance/{{kitNumber}}' \
--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/balance/{{kitNumber}} 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": "Balance fetched successfully",
"data": {
"balance": "5.00"
},
"timestamp": "2022-04-11 15:03:22",
"ipay_uuid": "h00696095d10-da1c-4a03-a485-765747778255",
"orderid": null,
"environment": "LIVE",
}