---
title: "AePS Aadhaar Pay API Reference"
description: "Accept merchant payments debited directly from a customer's Aadhaar-linked bank account via biometric authentication."
canonical: "https://eps.eko.in/docs/aeps-aadhaar-pay"
---


> **Canonical URL:** https://eps.eko.in/docs/aeps-aadhaar-pay
> 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 Aadhaar Pay API Reference

`POST https://staging.eko.in/ekoapi/v3/customer/collection/aeps-fingpay`

Accept merchant payments debited directly from a customer's Aadhaar-linked bank account via biometric authentication.

Aadhaar Pay (service_type=5) enables merchants to accept payments from customers whose bank accounts are Aadhaar-linked, authenticated with a fingerprint scan. Unlike Cash Withdrawal (where cash is dispensed), the funds are transferred to the merchant. This is useful for last-mile digital payments at kirana stores and service points where customers have no UPI or debit card. The flow is identical to Cash Withdrawal but with a positive merchant-side credit.

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

## 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 |
| service_type | number | yes | Transaction type. Use 5 for Aadhaar Pay. e.g. 5 |
| customer_id | string | yes | Customer's registered mobile number. e.g. 9876543210 |
| bank_code | string | yes | Bank IIN/IFS code identifying the customer's bank. e.g. 607153 |
| amount | number | yes | Payment amount in INR (integer). This amount is debited from the customer and credited to the merchant. e.g. 250 |
| aadhaar | string | yes | RSA-encrypted, Base64-encoded Aadhaar number of the paying customer. e.g. BASE64_ENCRYPTED_AADHAAR |
| piddata | string | yes | PID XML string from UIDAI-certified biometric device (fType=2, Data type='X', mc 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. 1 |
| 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 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.tid ⭐ | string | Eko's internal transaction ID. |
| data.amount ⭐ | number | Payment amount processed (INR). |
| data.bank_name ⭐ | string | Name of the customer's debited bank. |
| data.bank_ref_num ⭐ | string | NPCI/bank reference number. |

## Example request

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

## Example response

```json
{
  "status": 0,
  "response_status_id": 0,
  "message": "Aadhaar Pay successful",
  "tx_status": "0",
  "txstatus_desc": "Success",
  "data": {
    "tid": "EKO20240101012345",
    "tx_status": "0",
    "txstatus_desc": "Success",
    "amount": 250,
    "bank_name": "Bank of Baroda",
    "bank_ref_num": "NPCI20240101MNOP"
  }
}
```

## Error scenarios

| Status | Scenario |
| --- | --- |
| 200 | Biometric authentication failed |