BalanceEnquiry

Post  https://api.aopay.co.in/api/AOP/V1/AEPS/User/BalanceEnquiry

The BalanceEnquiry API is used to fetch the available account balance of a user through AEPS (Aadhaar Enabled Payment System). It validates the user’s Aadhaar-linked bank account and returns the balance details along with transaction references.

Body Parameters
{
  "Userkey": "AOP554N3XXXXX",
  "Mobile": 97XXXXXXXX,
  "Pipe": "bank6",
  "AccessModeType": "SITE",
  "AdhaarNumber": "123456789012",
  "Latitude": 37.7749,
  "Longitude": -122.4194,
  "ReferenceNo": "REF000000035",
  "DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
  "NationalBankIdentification":"6470",
  "RequestRemarks":"desired message",
  "IsIris":"No",
  "RegistrationID": "AOP-554"
}
Request Parameters
Name Type Description
Userkey String Unique identification ID (maximum 12 characters) obtained from the AEPSUserOnBoarding API response.
Mobile Integer Mobile number of the user, often used for verification or notifications.
Pipe String Must Be bank6.
Responses

200

200

Response

200

RESPONSE BODY

Json

401

401

Response

401

RESPONSE BODY

Object

status     boolean

response_code     integer

message     string

Did this page help you?     Yes    No

Language
shell Shell
python Python
node Node
c# C#
php PHP

cURL

curl --location  'https://api.aopay.co.in/api/AOP/V1/AEPS/User/BalanceEnquiry' \
--header 'Content-Type: application/json' \
--data  '{
"Userkey": "AOP554N3XXXXX",
"Mobile": 97XXXXXXXX,
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554"
}'
                                
import requests
import json

url = 'https://api.aopay.co.in/api/AOP/V1/AEPS/User/BalanceEnquiry'
payload = json.dumps({
"Userkey": "AOP554N3XXXXX",
"Mobile": "97XXXXXXXX",
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554"
}) 

headers = {
  "Content-type" : "application/json"
}

response = requests.request("POST" url, headers=headers, data=payload)

print (response.text)
                                
var requests = require("request");
var options = { 
  "method" : "POST",
  "url" : 'https://api.aopay.co.in/api/AOP/V1/AEPS/User/BalanceEnquiry',
  "headers" : {
    "Content-Type" : 'application/json'
  },
  body: JSON.stringify({
"Userkey": "AOP554N3XXXXX",
"Mobile": "97XXXXXXXX",
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554"
 }) 
}; 
request(options, function(error, response){
   if(error) throw new Error(error);
   console.log(response.body); 
}); 
                                
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post,'https://api.aopay.co.in/api/AOP/V1/AEPS/User/BalanceEnquiry')
var content = new StringContent(
  "{
"Userkey": "AOP554N3XXXXX",
"Mobile": "97XXXXXXXX",
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554"
}",
  null,"application/json"
); 

request.Content = content;
var response =  await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
                                
<?php
$curl =  curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL =>  'https://api.aopay.co.in/api/AOP/V1/AEPS/User/BalanceEnquiry',
  CURLOPT_RETURNTRANSFER =>  true,
  CURLOPT_ENCODING =>  '',
  CURLOPT_MAXREDIRS =>  10,
  CURLOPT_TIMEOUT =>  0,
  CURLOPT_FOLLOWLOCATION =>  true,
  CURLOPT_HTTP_VERSION =>  CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =>  'POST',
  CURLOPT_POSTFIELDS =>  '{
"Userkey": "AOP554N3XXXXX",
"Mobile": "97XXXXXXXX",
"Pipe": "bank6",
"AccessModeType": "SITE",
"AdhaarNumber": "123456789012",
"Latitude": 37.7749,
"Longitude": -122.4194,
"ReferenceNo": "REF000000035",
"DeviceData": "<DeviceDataXML>...</DeviceDataXML>",
"NationalBankIdentification": "6470",
"RequestRemarks": "desired message",
"IsIris": "No",
"RegistrationID": "AOP-554"
  }',
  CURLOPT_HTTPHEADER =>  array(
    'Content-Type: application/json'
  ),
));
$response =  curl_exec($curl);
curl_close($curl);
echo $response;

RESPONSE

200

401

-Result

Example

{
    "status": true,
    "msg": "Balance Enquiry Successfully",
         "data": {
                "message": "Balance Enquiry Successfully",
                "response_code": 1,
                "txnStatus": "SUCCESS",
                "error_code": 0,
                "ackno": 238,
                "balanceAmount": 1787.23000000000001818989403545856475830078125,
                "bankrrn": "500211878773",
                "terminalId": "AA787126",
                "transactionId": "20250102111144",
                "clientRefno": "DIGIFINBALENQP67f17228259796503",
                "timestamp": "2025-01-02 11:11:45"
           }
          "statusCode": 200,
}
                                
{
  "status": false,
  "response_code": 5,
  "message": "Invalid signature encoding"
}