Header Parameters

Name	Type	Description	Mandatory(M),Optional(O)	Provided by INSTANTPAY(Y/N)
X-Ipay-Auth-Code	String	Auth Code - 1 (Fixed)	M	Y
X-Ipay-Client-Id	String	Unique Client Id	M	Y
X-Ipay-Client-Secret	String	Unique Client Secret	M	Y
X-Ipay-Endpoint-Ip	String	End Customer IP Address	M	Y

Request Parameters

Parameter Name	Type	Requirement	Description
cardNumber	String	Mandatory	cardNumber
pin	String	Mandatory	pincode

Sample Request

curl --location 'https://api.instantpay.in/cards/brand/balance' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: 1' \
--header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOX923SyPZlQWg5sCmZbpfcw=' \
--header 'X-Ipay-Client-Secret: 6f3d58493d8585d2d6dffb0225fc117129071c7411a5c56d77fc0514304353cb' \
--header 'X-Ipay-Endpoint-Ip: 45.115.105.205' \
--data '{
    "cardNumber" : "1004690023957370",
    "pin" : "172767"
}'

POST /cards/brand/balance HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: 1
X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOX923SyPZlQWg5sCmZbpfcw=
X-Ipay-Client-Secret: 6f3d58493d8585d2d6dffb0225fc117129071c7411a5c56d77fc0514304353cb
X-Ipay-Endpoint-Ip: 45.115.105.205
Content-Length: 66

{
    "cardNumber" : "1004690023957370",
    "pin" : "172767"
}

Response Parameters

Parameter Name	Type	Description
statuscode	String	InstantPay StatusCode
actcode	String	Action Code
status	String	Status message
data	String	Response Data(if Present)
timestamp	String	Response time(YYYY-MM-DD HH:\|\|:SS)
ipay_uuid	String	Request reference number
orderid	String	Transaction Id(if transaction otherwise it is null)
environment	String	Live/Sandbox
internalCode	String	It will be null

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "expiry": "2024-05-18",
        "cardNumber": "1004690023957370",
        "cardBalance": "1.0000",
        "currency": {
            "code": "INR",
            "numericCode": "356",
            "symbol": "₹"
        }
    },
    "timestamp": "2023-05-19 12:05:48",
    "ipay_uuid": "h0059933d026-9f85-4af4-833d-914c6f7516a3",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}