post https://api.instantpay.in/accounts/balance
Check balance of all bank accounts that you have linked with your InstantPay account. A fee is applicable on balance checks via API.
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 | You will get from Instantpay Portal. |
| accountNumber | String | M | Linked Current account 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 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--data-raw '{
"bankProfileId": "10910",
"accountNumber": "7428585742",
"externalRef": "PROD1",
"latitude": "20.1236",
"longitude": "78.3228"
}'
POST /accounts/balance HTTP/1.1
Host: api.instantpay.in
Accept: application/json
Content-Type: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
{
"bankProfileId": "10910",
"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": {
"bankProfileId": "10910",
"accountNumber": "7428585742",
"accountShortNumber": "2161",
"balance": {
"total": "17838.64",
"lien": "0.00",
"available": "17838.64"
},
"poolReferenceId": "1220123145065KVYEE",
"pool": {
"account": "7428585742",
"openingBal": "214.50",
"mode": "DR",
"amount": "0.30",
"closingBal": "214.20"
}
}
"timestamp": "2022-02-18 11:36:07",
"ipay_uuid": "h00695deb945-3def-42ba-8857-2ff7bac93fe6",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}
Note :
Latitude and Longitude must be represented in degrees with 4 digits after decimal.
externalRef must be unique and in alpha numeric characters.
This API call is chargeable, For more Information connect with your respective Key Account Manager.