Balance Enquiry

Balance enquiry in AEPS (Aadhaar Enabled Payment System) refers to the process of checking the balance of your bank account linked to your Aadhaar number using the AEPS platform. When you initiate a balance enquiry through AEPS, the system verifies your identity through biometric authentication and then retrieves and displays the current balance of your bank account. This allows you to stay updated on the available funds in your account without visiting a bank branch or using traditional banking methods.

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-Outlet-IdStringMerchant Unique IDMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN

Request Parameters

NameTypeMandatory (M) , Optional (O)Description
bankiinStringMUnique bank identification number (You will get it from list of banks API)
latitudeStringMCurrent location latitude
longitudeStringMCurrent location longitude
mobileStringMUser Mobile no
externalRefStringMUnique Reference number
biometricDataArrayMBiometric data details
biometricData.encryptedAadhaarStringMAadhar details in encrypted form
biometricData.dcStringMReturned by RD Service when using biometric authentication. Registered Device code.
biometricData.ciStringMReturned by RD Service when using biometric authentication. Public key certificate identifier of UIDAI using which skey was encrypted.
biometricData.hmacStringMReturned by RD Service when using biometric authentication. SHA -256 Hash of PID XML and then encrypted and base 64 encoded.
biometricData.dpIdStringMReturned by RD Service when using biometric authentication. Device provider Id.
biometricData.mcStringMReturned by RD Service when using biometric authentication. encrypted registered device public key certificate.
biometricData.pidDataTypeStringMReturned by RD Service when using biometric authentication. Protobuff format or XML format.
biometricData.sessionKeyStringMReturned by RD Service when using biometric authentication. AES session key generated dynamically for every txn.
biometricData.miStringMReturned by RD Service when using biometric authentication. RD model Id.
biometricData.rdsIdStringMReturned by RD Service when using biometric authentication. RD Service Id.
biometricData.errCodeStringO0(Default)- Request success
biometricData.errInfoStringOInformation about the error
biometricData.fCountStringOTotal number of FIR records which was part of input.
biometricData.fTypeStringMWhen connecting the Device to RD service send ftype 2 in the request.
biometricData.iCountStringMTotal number of IIR records which was part of input.
biometricData.iTypeStringOISO format (0 for IIR), 0 (IIR) is default.
biometricData.pCountStringONumber of face photo records to be captured (0 to 1).
biometricData.pTypeStringMFace format
biometricData.srnoStringMSerial Number of biometric device.
biometricData.sysidStringOSystem Id
biometricData.tsStringOCurrent Timestamp.
biometricData.pidDataStringMReturned by RD Service when using biometric authentication.
biometricData.qScoreStringMIf quality check is done, send a normalized score that is between 0 and 100. Device providers may allow configuration within RD service to use specific quality check algorithms to be enabled.
biometricData.nmPointsStringMNumber of minutiae points when FMR is captured. Applications may use this for accepting or retrying the capture.
biometricData.rdsVerStringMReturned by RD Service when using biometric authentication. RD Service version.

📘

Note:

Click here for guidelines for entering data in latitude/ longitude parameter.

Sample Request

curl --location --request POST 'https://api.instantpay.in/fi/aeps/balanceInquiry' \
--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 ' {
        "bankiin": "109104",
        "latitude": "21.3241",
        "longitude": "70.1321",
        "mobile": "7428585742",
        "externalRef": "1672908701918",
        "biometricData": {
            "encryptedAadhaar": "GWFDLdnHmGF7Am6oG4F6X6GNyO02eQj24hlOiK/Y+js=",
            "dc": "81cfa394-d641-44cf-835d-cb65532bbc20",
            "ci": "20221021",
            "hmac": "fmumT8v9WnB3SxGBWl0w/D3aoB5lYoeoyPfWV0XD4McWPc6qJLnlqP/XdX22T0Rb",
            "dpId": "STARTEK.ACPL",
            "mc": "MIIDgDCCAmigAwIBAgIFAAZeW+IwDQYJKoZIhvcNAQELBQAwdDEdMBsGA1UEAxMUQklKQVkgQU1BUk5BVEggU0lOSEExEDAOBgNVBAgTB0dVSkFSQVQxETAPBgNVBAsTCERJUkVDVE9SMSEwHwYDVQQKExhBQ0NFU1MgQ09NUFVURUNIIFBWVCBMVEQxCzAJBgNVBAYTAklOMB4XDTIyMDQyNjA2MDg0M1oXDTIyMDUyNjA2MDg0M1owUTELMAkGA1UEBhMCSU4xEDAOBgNVBAgMB0d1amFyYXQxDTALBgNVBAoMBFVTRVIxDTALBgNVBAsMBFVTRVIxEjAQBgNVBAMMCVBST0RfVVNFUjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMk3kObEzchV/cithqKtBslzmafe4ky0mpPYwp4zTwt/d5RJ2JbtKnWYYLHJ8IUCXbhGPMtAmiZAG3fA6tlCw71z0rimo11g8GUQasfkKZE93V0cO8zW+V4Mi/V27mNfduZBGeGRyf5YPq4JDA3GnKrW7kSiHpUJ+KMp8QWZA5vqam0kknqGO06Zpx0x8jOmV27z3XN8Xh/3nDOfTh+NelQ6dkrLCkHpN4oWYPmj+uIF/JrTfPtgYe9+54z6LO/K3zNfHSsZtuO7IWWvC3DYFRoDLzc9pVAQ5DP0xxrEUYwJJu258NNrd4ouZel+EIEFg73FM9fTV5VxmmGxaQQugLECAwEAAaM8MDowDAYDVR0TBAUwAwEB/zALBgNVHQ8EBAMCAYYwHQYDVR0OBBYEFIuDs650JC9y2NFbmYq8mLXQLmEDMA0GCSqGSIb3DQEBCwUAA4IBAQAT9FUmGdDb9f1BpIhk0Ak3Zko2sggSMD9ORg7veRKTUEvX5xUNowDT37jgXWPRIn3lZ9pHIbJOL4oDLPQACpL2GReagcwGWyhm9J9ICO7Z0mocXhc/M101fWlpX0qEUhpNgaz+AqXWmM5vj6eeGd50xTXKirVmlzlnqwzc+1RNu3fP0h5HQhxd2HIroffLHLBEzVZMIaLZ7NBuMdCdfSfYa9fFAyFJ/WhT4hskcRNecZLoH89Bk1fgJMd7MnFXpe1JQqgZqE1REp+wDQom0DRxtyLT8a8HndP/1Fn/PiXP+AaJOmGiJMNZ66QBirdAxfQUhozPlich2KVFeOagTmyB",
            "pidDataType": "X",
            "sessionKey": "S0eB9GZ+7Xbi3H8e28PMsU6RHFazDF9Y9v2X/h04LZbHF8/34kssLaOp9TAvWnasp84p4nI8t4/xepzL49jM6s5QMZr6tRT/I5bEssN1519p2NXMg9VCsWpAlAe+piaN9FZPLjiANmADuqaEvOLo4B7/kTaj1htBWTb7PO0G0Sbd2whqWx7y5gInpkmYMTMGXxPzXflmCvAnR/6mIKVgeyPiWzFSCIAWtwK1JIUXt+HmMiANNaJ4YDbtnZLCWYp11HhnjalrU5RwpqV1dqCZ8bYT1Ev7TBkq8iWAK0Zya/6U2nYG45ds/U1y8M8pj3aM+HxxjvBdgvjRUNeZooPyvg==",
            "mi": "FM220U",
            "rdsId": "ACPL.WIN.001",
            "errCode": "0",
            "errInfo": "",
            "fCount": "1",
            "fType": "2",
            "iCount": 0,
            "iType": "",
            "pCount": 0,
            "pType": "",
            "srno": "N00115075",
            "sysid": "MDAyNTM4ODU4MUI0OTgwNU4wQ1YxODM4TUIwMDU0NDk3SkFOMENWMDM2MjM3NDEw",
            "ts": "2022-04-27T18:50:01+05:30",
            "pidData": "MjAyMi0wNC0yN1QxODo1MDowMaLf5YbPf8bCcPuH0xuQrPSGr7OzKh1qi32Ec2YBOLcvYP+LPbRr+7DvqENyRS+rICJRL6vRffJrpceBNKgT2nYZmFaGYdq3Fj+QQH+aOe3gr6BPZKEAM8xA7LW4VhV/UbYuC/YlhhzSdSn9TmIeFGYViFC9ZvXFhYCdKMpkoDG68/7i2KlggKzx4f9L/nPwQ7C4BpVYmBnkU6bLEIKhSao2iKxkv2Y6S+VIrSSm9BYAMYBP2f3fibPxXnB5vO0tlidzXKMYvnCHQMLLDvtcoiBQ1CCowm/7dE70xpjgoSfVmIk7FuHvWzKZWxJDTXnFCAdd57Hmjeear4wgsWzHcqyylYDDS0r4lV5llROPiaTcNgXv7JegsqlUimD31tSYGBd5XlNQGevEpyi8rJwWHmxeLVf/1p1aYMJr2BymPEOmvlyl5n7K9dOSCE1cbNmJq7lnLm8DdS5zJCxhG4Damk+zOT3UpvD3WKVTl7uqeP5mZJxP71/gz7lII2UDUvapFsWLymu//y3bqAPJv26EL8+Gzfx7am7pdLfaS69B7M9kDQqICsub1mbpD8NpiRmd5p2dFVneuaBPZgvESZSJ4yxbC6DmQglfO0ItfiWPnUHOGiQxMOMNPUTMJkPqTJQZ4u6Odv0NOkOpnkgp/fn6/p9h+Z+Ysdxbr1UqQH9yF9Q2QkladwLhDs+2gOGEFXrK/FDaJykaJKsaQa52wvfvnQ4Lw0ZsXQOxNBb7r6LOQ8vSUYLpoBdN3gQV4DWsHKXdMY+m8JzMQDelDvX8lgXpsH1SSr+BE+ij58yMGhO4n/Bsvfz8stc+x1Cw3nK22wwsc9IHmvDdbzmOlkpJYoFWFJnw82Iq5Vt4VMMUUe98kuXzJjj9cZKu22cbe1Bs4eP59D1swLS3/AD2lMe1x1H5lpCcmEkAHQqd0DD/dyGN7wTApO7tbCgMUXN+StiroRvBI0YH/ZXK5nEK7wqrzhqG/ugpQwF/4a6eCxQQPxz5vt8J8Gd6FkDaPKWfVBKuRUz+KNK3NURUrCtrFvVeWlPbR+JvTeIC6KpTQFZLa/7+wAyqbDvPu5+YZKQxLtnMKHCLTXOfFHElg5MTj3TQpomTMOtXcU98glXYBGZeIOUhLoeCnS8oLmD2yFPsDuCTUzIixmV27fwfl7S0OGZvj+to73evW5HefRSGmcHo04gb26uwaiIvvZH2hOGWZ7RvUzcTTuO8eyk8myJuV9eYNCWyQKBRlFW4FZyxqlXiSOSMl/w4NaEhvTRqOh5srfm9DX6gZVGvtzBnOjq7ApyaS7oGVtRHCjvCbX/ibr/ldoSEQPmhfNsXWGMY8wPF2xKRPOZp677Msg2NBA1qNL9VEuQIXA==",
            "qScore": "100",
            "nmPoints": "51",
            "rdsVer": "1.0.3"
        }
    }'
POST /aeps/balanceInquiry 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}}

 "Body":  {
       "bankiin": "109104",
        "latitude": "21.3241",
        "longitude": "70.1321",
        "mobile": "7428585742",
        "externalRef": "1672908701918"
        "biometricData": {
            "encryptedAadhaar": "GWFDLdnHmGF7Am6oG4F6X6GNyO02eQj24hlOiK/Y+js=",
            "dc": "81cfa394-d641-44cf-835d-cb65532bbc20",
            "ci": "20221021",
            "hmac": "fmumT8v9WnB3SxGBWl0w/D3aoB5lYoeoyPfWV0XD4McWPc6qJLnlqP/XdX22T0Rb",
            "dpId": "STARTEK.ACPL",
            "mc": "MIIDgDCCAmigAwIBAgIFAAZeW+IwDQYJKoZIhvcNAQELBQAwdDEdMBsGA1UEAxMUQklKQVkgQU1BUk5BVEggU0lOSEExEDAOBgNVBAgTB0dVSkFSQVQxETAPBgNVBAsTCERJUkVDVE9SMSEwHwYDVQQKExhBQ0NFU1MgQ09NUFVURUNIIFBWVCBMVEQxCzAJBgNVBAYTAklOMB4XDTIyMDQyNjA2MDg0M1oXDTIyMDUyNjA2MDg0M1owUTELMAkGA1UEBhMCSU4xEDAOBgNVBAgMB0d1amFyYXQxDTALBgNVBAoMBFVTRVIxDTALBgNVBAsMBFVTRVIxEjAQBgNVBAMMCVBST0RfVVNFUjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMk3kObEzchV/cithqKtBslzmafe4ky0mpPYwp4zTwt/d5RJ2JbtKnWYYLHJ8IUCXbhGPMtAmiZAG3fA6tlCw71z0rimo11g8GUQasfkKZE93V0cO8zW+V4Mi/V27mNfduZBGeGRyf5YPq4JDA3GnKrW7kSiHpUJ+KMp8QWZA5vqam0kknqGO06Zpx0x8jOmV27z3XN8Xh/3nDOfTh+NelQ6dkrLCkHpN4oWYPmj+uIF/JrTfPtgYe9+54z6LO/K3zNfHSsZtuO7IWWvC3DYFRoDLzc9pVAQ5DP0xxrEUYwJJu258NNrd4ouZel+EIEFg73FM9fTV5VxmmGxaQQugLECAwEAAaM8MDowDAYDVR0TBAUwAwEB/zALBgNVHQ8EBAMCAYYwHQYDVR0OBBYEFIuDs650JC9y2NFbmYq8mLXQLmEDMA0GCSqGSIb3DQEBCwUAA4IBAQAT9FUmGdDb9f1BpIhk0Ak3Zko2sggSMD9ORg7veRKTUEvX5xUNowDT37jgXWPRIn3lZ9pHIbJOL4oDLPQACpL2GReagcwGWyhm9J9ICO7Z0mocXhc/M101fWlpX0qEUhpNgaz+AqXWmM5vj6eeGd50xTXKirVmlzlnqwzc+1RNu3fP0h5HQhxd2HIroffLHLBEzVZMIaLZ7NBuMdCdfSfYa9fFAyFJ/WhT4hskcRNecZLoH89Bk1fgJMd7MnFXpe1JQqgZqE1REp+wDQom0DRxtyLT8a8HndP/1Fn/PiXP+AaJOmGiJMNZ66QBirdAxfQUhozPlich2KVFeOagTmyB",
            "pidDataType": "X",
            "sessionKey": "S0eB9GZ+7Xbi3H8e28PMsU6RHFazDF9Y9v2X/h04LZbHF8/34kssLaOp9TAvWnasp84p4nI8t4/xepzL49jM6s5QMZr6tRT/I5bEssN1519p2NXMg9VCsWpAlAe+piaN9FZPLjiANmADuqaEvOLo4B7/kTaj1htBWTb7PO0G0Sbd2whqWx7y5gInpkmYMTMGXxPzXflmCvAnR/6mIKVgeyPiWzFSCIAWtwK1JIUXt+HmMiANNaJ4YDbtnZLCWYp11HhnjalrU5RwpqV1dqCZ8bYT1Ev7TBkq8iWAK0Zya/6U2nYG45ds/U1y8M8pj3aM+HxxjvBdgvjRUNeZooPyvg==",
            "mi": "FM220U",
            "rdsId": "ACPL.WIN.001",
            "errCode": "0",
            "errInfo": "",
            "fCount": "1",
            "fType": "2",
            "iCount": 0,
            "iType": "",
            "pCount": 0,
            "pType": "",
            "srno": "N00115075",
            "sysid": "MDAyNTM4ODU4MUI0OTgwNU4wQ1YxODM4TUIwMDU0NDk3SkFOMENWMDM2MjM3NDEw",
            "ts": "2022-04-27T18:50:01+05:30",
            "pidData": "MjAyMi0wNC0yN1QxODo1MDowMaLf5YbPf8bCcPuH0xuQrPSGr7OzKh1qi32Ec2YBOLcvYP+LPbRr+7DvqENyRS+rICJRL6vRffJrpceBNKgT2nYZmFaGYdq3Fj+QQH+aOe3gr6BPZKEAM8xA7LW4VhV/UbYuC/YlhhzSdSn9TmIeFGYViFC9ZvXFhYCdKMpkoDG68/7i2KlggKzx4f9L/nPwQ7C4BpVYmBnkU6bLEIKhSao2iKxkv2Y6S+VIrSSm9BYAMYBP2f3fibPxXnB5vO0tlidzXKMYvnCHQMLLDvtcoiBQ1CCowm/7dE70xpjgoSfVmIk7FuHvWzKZWxJDTXnFCAdd57Hmjeear4wgsWzHcqyylYDDS0r4lV5llROPiaTcNgXv7JegsqlUimD31tSYGBd5XlNQGevEpyi8rJwWHmxeLVf/1p1aYMJr2BymPEOmvlyl5n7K9dOSCE1cbNmJq7lnLm8DdS5zJCxhG4Damk+zOT3UpvD3WKVTl7uqeP5mZJxP71/gz7lII2UDUvapFsWLymu//y3bqAPJv26EL8+Gzfx7am7pdLfaS69B7M9kDQqICsub1mbpD8NpiRmd5p2dFVneuaBPZgvESZSJ4yxbC6DmQglfO0ItfiWPnUHOGiQxMOMNPUTMJkPqTJQZ4u6Odv0NOkOpnkgp/fn6/p9h+Z+Ysdxbr1UqQH9yF9Q2QkladwLhDs+2gOGEFXrK/FDaJykaJKsaQa52wvfvnQ4Lw0ZsXQOxNBb7r6LOQ8vSUYLpoBdN3gQV4DWsHKXdMY+m8JzMQDelDvX8lgXpsH1SSr+BE+ij58yMGhO4n/Bsvfz8stc+x1Cw3nK22wwsc9IHmvDdbzmOlkpJYoFWFJnw82Iq5Vt4VMMUUe98kuXzJjj9cZKu22cbe1Bs4eP59D1swLS3/AD2lMe1x1H5lpCcmEkAHQqd0DD/dyGN7wTApO7tbCgMUXN+StiroRvBI0YH/ZXK5nEK7wqrzhqG/ugpQwF/4a6eCxQQPxz5vt8J8Gd6FkDaPKWfVBKuRUz+KNK3NURUrCtrFvVeWlPbR+JvTeIC6KpTQFZLa/7+wAyqbDvPu5+YZKQxLtnMKHCLTXOfFHElg5MTj3TQpomTMOtXcU98glXYBGZeIOUhLoeCnS8oLmD2yFPsDuCTUzIixmV27fwfl7S0OGZvj+to73evW5HefRSGmcHo04gb26uwaiIvvZH2hOGWZ7RvUzcTTuO8eyk8myJuV9eYNCWyQKBRlFW4FZyxqlXiSOSMl/w4NaEhvTRqOh5srfm9DX6gZVGvtzBnOjq7ApyaS7oGVtRHCjvCbX/ibr/ldoSEQPmhfNsXWGMY8wPF2xKRPOZp677Msg2NBA1qNL9VEuQIXA==",
            "qScore": "100",
            "nmPoints": "51",
            "rdsVer": "1.0.3"
        }
    }

Response Parameters

NameTypeDescription
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 )
environmentStringLive

Sample Response

{
        "statuscode": "TXN",
        "actcode": null,
        "status": "Transaction Successful",
        "data": {
            "externalRef": "1672908701918",
            "bankName": "BARODA RAJASTHAN KSHETRIYA GRAMIN BANK",
            "accountNumber": "xxxxxxxx0191",
            "ipayId": "DNA012300514222251",
            "transactionMode": "DR",
            "payableValue": "0.00",
            "transactionValue": "0.00",
            "openingBalance": "742094.52",
            "closingBalance": "742094.52",
            "operatorId": "300514651156",
            "walletIpayId": "DNA012300514222251",
            "bankAccountBalance": "1520.00",
            "miniStatement": []
        },
        "timestamp": "2023-01-05 14:22:24",
        "ipay_uuid": "h00698267120-56c1-4e53-b3c7-d5da471a52d3",
        "orderid": "DNA012300514222251",
        "environment": "LIVE",
        "internalCode": null
    }

📘

Aadhaar Encryption (Sample)

For Aadhaar Encryption Details click here

❗️

Please Note:

To avoid transaction failures and account suspension, for every merchant you need to pass the unique outlet Id in the headers.

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