POSTAePS Mini Statement
Retrieve the last few transactions from an Aadhaar-linked bank account via biometric authentication.
Fetches a mini statement (typically the last 5–10 transactions) from a customer's bank account by authenticating through Aadhaar biometrics. Uses the dedicated mini-statement endpoint with amount=0. No money movement occurs. The response includes a list of recent debit/credit transactions with amounts and dates. Useful for customers who want to verify recent activity at an agent point without visiting a branch.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_id | string | required | Customer's registered mobile number.e.g. 9876543210 |
customer_idstringRequiredCustomer'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 Mini Statement. 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_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
user_codestringRequiredUser code of the retailer/agent the service is run for.
example: 20810200
client_ref_idstringoptionalUnique reference id per API call, generated by your system.
example: REQ-20260101-001
bank_codestringRequiredBank IIN/IFS code identifying the customer's bank.
example: 607153
amountnumberRequiredMust be 0 for Mini Statement. No debit is performed.
example: 0
aadhaarstringRequiredRSA-encrypted, Base64-encoded Aadhaar number of the customer.
example: BASE64_ENCRYPTED_AADHAAR
piddatastringRequiredPID 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>
pipenumberRequiredRouting pipe selector. Use 0 (default).
example: 0
notify_customernumberRequiredSend SMS notification to the customer. 1 = yes, 0 = no.
example: 0
latlongstringRequiredGPS coordinates of the transaction origin in 'latitude,longitude' format.
example: 28.6139,77.2090
source_ipstringRequiredIP 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_keystringRequiredStatic API key issued to your account after KYC.
secret-keystringRequiredDynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
secret-key-timestampstringRequiredCurrent time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
content-typestringRequiredapplication/json
example: application/json
Responses
statusnumberPrimary success indicator (0 = success).
messagestringHuman-readable response / error message.
response_status_idnumberGranular status id; see the shared error-codes table.
response_type_idnumberA unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
tx_statusstringTransaction state: 0=Success, 1=Fail, 2=Awaited, 3=Refund Pending, 4=Refunded, 5=On Hold.
txstatus_descstringHuman-readable transaction status.
dataobjectAPI-specific response payload.
tidstringEko's internal transaction ID for this enquiry.
bank_namestringName of the customer's bank.
ministatementarrayList of recent transactions. Each entry contains transaction date, amount, transaction type (debit/credit), and narration.
datestringTransaction date (DD-MM-YYYY or YYYY-MM-DD depending on bank).
amountstringTransaction amount in INR.
txn_typestringTransaction direction: 'C' for credit, 'D' for debit.
narrationstringBank-provided transaction narration or description.
bank_ref_numstringNPCI/bank reference number for this statement fetch.