Bank Account

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

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code -1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN


Info :

Click Here to know how to get the Credentials.

Request Parameters

ParametersTypeMandatory (M) , Optional(O)Description
bankProfileIdStringMYou will get from Instantpay Portal.
accountNumberStringMLinked Current account number
externalRefStringMUnique Reference number
latitudeStringMCurrent location latitude
longitudeStringMCurrent location longitude

Sample Request

curl --location --request POST '' \
--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
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

statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )

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.

Click Try It! to start a request and see the response here!