POSTAePS Balance Enquiry

Check a customer's bank account balance using Aadhaar number and biometric fingerprint — no card or PIN required.

POST/customer/collection/aeps-fingpay/balance-enquiry/{customer_id}

Retrieves the real-time account balance from any Aadhaar-linked bank. Uses the dedicated balance-enquiry endpoint with amount=0. No money movement occurs and no debit takes place. The agent must have completed AePS Fingpay activation and the current-day daily authentication before calling this API.

Path parameters

Field	Type	Required	Description
`customer_id`	string	required	Customer's registered mobile number.e.g. 9876543210

customer_idstringRequired

Customer's registered mobile number.

example: 9876543210

Body parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`user_code`	string	required	User code of the retailer/agent the service is run for.e.g. 20810200
`client_ref_id`	string	optional	Unique reference id per API call, generated by your system.e.g. REQ-20260101-001
`bank_code`	string	required	Bank IIN/IFS code identifying the customer's bank.e.g. 607153
`amount`	number	required	Must be 0 for Balance Enquiry. No debit is performed.e.g. 0
`aadhaar`	string	required	RSA-encrypted, Base64-encoded Aadhaar number of the customer.e.g. BASE64_ENCRYPTED_AADHAAR
`piddata`	string	required	PID XML string from the UIDAI-certified biometric device (fType=2, Data type='X', mc present in DeviceInfo).e.g. <?xml version='1.0'?><PidData><Data type='X'>...</Data><DeviceInfo mc='...' /></PidData>
`pipe`	number	required	Routing pipe selector. Use 0 (default).e.g. 0
`notify_customer`	number	required	Send SMS notification to the customer. 1 = yes, 0 = no.e.g. 0
`latlong`	string	required	GPS coordinates of the transaction origin in 'latitude,longitude' format.e.g. 28.6139,77.2090
`source_ip`	string	required	IP address of the merchant/agent system initiating the transaction.e.g. 103.56.78.90

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

user_codestringRequired

User code of the retailer/agent the service is run for.

example: 20810200

client_ref_idstringoptional

Unique reference id per API call, generated by your system.

example: REQ-20260101-001

bank_codestringRequired

Bank IIN/IFS code identifying the customer's bank.

example: 607153

amountnumberRequired

Must be 0 for Balance Enquiry. No debit is performed.

example: 0

aadhaarstringRequired

RSA-encrypted, Base64-encoded Aadhaar number of the customer.

example: BASE64_ENCRYPTED_AADHAAR

piddatastringRequired

PID XML string from the UIDAI-certified biometric device (fType=2, Data type='X', mc present in DeviceInfo).

example: <?xml version='1.0'?><PidData><Data type='X'>...</Data><DeviceInfo mc='...' /></PidData>

pipenumberRequired

Routing pipe selector. Use 0 (default).

example: 0

notify_customernumberRequired

Send SMS notification to the customer. 1 = yes, 0 = no.

example: 0

latlongstringRequired

GPS coordinates of the transaction origin in 'latitude,longitude' format.

example: 28.6139,77.2090

source_ipstringRequired

IP address of the merchant/agent system initiating the transaction.

example: 103.56.78.90

Headers

Field	Type	Required	Description
`developer_key`	string	required	Static API key issued to your account after KYC.
`secret-key`	string	required	Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
`secret-key-timestamp`	string	required	Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
`content-type`	string	required	application/jsone.g. application/json

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Responses

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
tx_statusstring
Transaction state: 0=Success, 1=Fail, 2=Awaited, 3=Refund Pending, 4=Refunded, 5=On Hold.
txstatus_descstring
Human-readable transaction status.
dataobject
API-specific response payload.
- balancestring
  Current account balance returned by the bank (INR). This is the key output of a Balance Enquiry.
- bank_namestring
  Name of the customer's bank.
- tidstring
  Eko's internal transaction ID for this enquiry.
- bank_ref_numstring
  NPCI/bank reference number.
- aadhaar_ref_numstring
  UIDAI authentication reference number.