---
title: "AePS Balance Enquiry API Reference"
description: "Check a customer's bank account balance using Aadhaar number and biometric fingerprint — no card or PIN required."
canonical: "https://eps.eko.in/docs/aeps-balance-enquiry"
---


> **Canonical URL:** https://eps.eko.in/docs/aeps-balance-enquiry
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# AePS Balance Enquiry API Reference

`POST https://staging.eko.in/ekoapi/v3/customer/collection/aeps-fingpay/balance-enquiry/{customer_id}`

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

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.

> View product & pricing details: [AePS Cashout](https://eps.eko.in/products/aeps-api.md)

## Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| customer_id | string | yes | Customer's registered mobile number. e.g. 9876543210 |

## Body parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| user_code | string | yes | User code of the retailer/agent the service is run for. e.g. 20810200 |
| client_ref_id | string | no | Unique reference id per API call, generated by your system. e.g. REQ-20260101-001 |
| bank_code | string | yes | Bank IIN/IFS code identifying the customer's bank. e.g. 607153 |
| amount | number | yes | Must be 0 for Balance Enquiry. No debit is performed. e.g. 0 |
| aadhaar | string | yes | RSA-encrypted, Base64-encoded Aadhaar number of the customer. e.g. BASE64_ENCRYPTED_AADHAAR |
| piddata | string | yes | 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 | yes | Routing pipe selector. Use 0 (default). e.g. 0 |
| notify_customer | number | yes | Send SMS notification to the customer. 1 = yes, 0 = no. e.g. 0 |
| latlong | string | yes | GPS coordinates of the transaction origin in 'latitude,longitude' format. e.g. 28.6139,77.2090 |
| source_ip | string | yes | IP address of the merchant/agent system initiating the transaction. e.g. 103.56.78.90 |

## Headers

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

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | Granular status id; see the shared error-codes table. |
| response_type_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| tx_status | string | Transaction state: 0=Success, 1=Fail, 2=Awaited, 3=Refund Pending, 4=Refunded, 5=On Hold. |
| txstatus_desc | string | Human-readable transaction status. |
| data | object | API-specific response payload. |
| data.balance ⭐ | string | Current account balance returned by the bank (INR). This is the key output of a Balance Enquiry. |
| data.bank_name ⭐ | string | Name of the customer's bank. |
| data.tid ⭐ | string | Eko's internal transaction ID for this enquiry. |
| data.bank_ref_num | string | NPCI/bank reference number. |
| data.aadhaar_ref_num | string | UIDAI authentication reference number. |

## Example request

```json
{
  "initiator_id": "9962981729",
  "user_code": "20810200",
  "client_ref_id": "REQ-20260101-001",
  "bank_code": "607153",
  "amount": 0,
  "aadhaar": "BASE64_ENCRYPTED_AADHAAR",
  "piddata": "<?xml version='1.0'?><PidData><Data type='X'>...</Data><DeviceInfo mc='...' /></PidData>",
  "pipe": 0,
  "notify_customer": 0,
  "latlong": "28.6139,77.2090",
  "source_ip": "103.56.78.90"
}
```

## Example response

```json
{
  "status": 0,
  "response_status_id": 0,
  "message": "Balance Enquiry successful",
  "tx_status": "0",
  "txstatus_desc": "Success",
  "data": {
    "tid": "EKO20240101005678",
    "tx_status": "0",
    "txstatus_desc": "Success",
    "balance": "5500.75",
    "bank_name": "State Bank of India",
    "bank_ref_num": "NPCI20240101EFGH",
    "aadhaar_ref_num": "UIDAI987654321"
  }
}
```

## Error scenarios

| Status | Scenario |
| --- | --- |
| 200 | Bank server timeout / balance unavailable |
| 200 | Aadhaar not linked to selected bank |