Fintech APIs & Platform for KYC, Verification & Transactions in India | Eko Platform Services
Eko Platform Services Logo

POSTAePS Mini Statement

Retrieve the last few transactions from an Aadhaar-linked bank account via biometric authentication.

POST/customer/collection/aeps-fingpay/mini-statement/{customer_id}

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 — the request shape matches Balance Enquiry (no amount). 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.

To capture the piddata PID block with an RDService-compliant fingerprint scanner, see the Aadhaar Biometric Authentication guide.

Request

Path parameters

customer_idstringRequired

Customer's registered mobile number.

example: 9000000000

Body parameters

initiator_idstringRequired

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

example: 9962981729

client_ref_idstringoptional

Unique reference ID per API call, generated by your system (max 20 characters).

example: 2026010100123456789

user_codestringRequired

Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your users

example: 10000001

bank_codestringRequired

Short bank code identifying the customer's Aadhaar-linked bank (e.g. `HDFC`, `SBIN`). Obtain from the bank list API.

example: HDFC

aadharstringRequired

RSA-encrypted, Base64-encoded Aadhaar number. Encrypt the 12-digit Aadhaar with the Eko RSA public key using PKCS#1 v1.5 padding (Java's default `Cipher.getInstance("RSA")`), then Base64-encode the ciphertext.

example: BASE64_ENCRYPTED_AADHAAR

latlongstringRequired

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

example: 28.6139,77.2090

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>

Response types

response_type_idMeaningNext step
1527Transaction Successful
1528Transaction Fail

Responses

1527Transaction Successful

  • 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.

    • tidstring

      Eko's internal transaction ID for this enquiry.

    • mini_statement_listarray

      List of recent transactions. Each entry carries the transaction date, amount, direction (Dr/Cr), and narration.

      • datestring

        Transaction date (DD/MM).

      • amountstring

        Transaction amount in INR.

      • narrationstring

        Bank-provided transaction narration or description.

      • txnTypestring

        Transaction direction: 'Cr' for credit, 'Dr' for debit.

    • sender_namestring

      Name of the agent/sender initiating the enquiry.

    • merchantnamestring

      Registered merchant name of the agent.

    • merchant_codestring

      Merchant code of the agent. May be empty.

    • user_codestring

      Echo of the agent's user_code from the request.

    • customer_balancestring

      Customer's account balance as reported by the bank (INR). May be empty.

    • commissionstring

      Commission earned by the agent on this enquiry (INR).

    • service_taxstring

      Service tax component on the fee (INR). May be empty.

    • totalfeestring

      Total fee including taxes (INR). May be empty.

    • terminal_idstring

      Terminal identifier. May be empty.

    • bank_ref_numstring

      NPCI/bank reference number for this statement fetch. May be empty.

    • transaction_datestring

      Transaction date (DD-MM-YY HH:MM:SS).

    • transaction_timestring

      Transaction timestamp (DD-MM-YY HH:MM:SS).

    • reasonstring

      Failure reason, when the enquiry did not complete. Empty on success.

    • commentstring

      Human-readable remark from the provider (e.g. 'Request Completed').

Next steps

Related