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 secret key	M	Y
X-Ipay-Endpoint-Ip	String	End Customer IP Address	M	N

📘
Info :
Click Here to know how to get the Credentials.

Request Parameters

Parameters	Type	Mandatory (M) , Optional(O)	Description
bankProfileId	String	M	0 (Fixed)
accountNumber	String	M	Instantpay Registered Mobile Number
externalRef	String	M	Unique Reference number
latitude	String	M	Current location latitude
longitude	String	M	Current location longitude

Sample Request

curl --location --request POST 'https://api.instantpay.in/accounts/balance' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data-raw '{
   "bankProfileId": "0",
   "accountNumber": "7428585742",
   "externalRef": "PROD1",
   "latitude": "20.1236",
   "longitude": "78.3228"
}'

POST /accounts/balance 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}}
Content-Type: application/json

{
   "bankProfileId": "0",
   "accountNumber": "7428585742",
   "externalRef": "PROD1",
   "latitude": "20.1236",
   "longitude": "78.3228"
}

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

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Transaction Successful",
    "data": {
        "bankId": "0",
        "bankProfileId": 0,
        "accountNumber": "7428585742",
        "accountShortNumber": "5742",
        "balance": {
            "total": "16.82",
            "lien": "0.00",
            "available": "16.82"
        },
        "poolReferenceId": "",
        "pool": {
            "account": "7428585742",
            "openingBal": "16.82",
            "mode": "DR",
            "amount": "0.00",
            "closingBal": "16.82"
        }
    },
    "timestamp": "2022-03-21 10:20:36",
    "ipay_uuid": "h00695deb945-3def-42ba-8857-2ff7bac93fe6",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null

}

❗️
Note :
1 - Latitude and Longitude must be represented in degrees with 4 digits after decimal.
2- externalRef must be unique and in alpha numeric characters.
3- Call this API once an hour to sync the data in your application.