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

    customer_idstringRequired

    Customer's registered mobile number.

    example: 9876543210

    Body parameters

    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 Mini Statement. 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

    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.

      • tidstring

        Eko's internal transaction ID for this enquiry.

      • bank_namestring

        Name of the customer's bank.

      • ministatementarray

        List of recent transactions. Each entry contains transaction date, amount, transaction type (debit/credit), and narration.

        • datestring

          Transaction date (DD-MM-YYYY or YYYY-MM-DD depending on bank).

        • amountstring

          Transaction amount in INR.

        • txn_typestring

          Transaction direction: 'C' for credit, 'D' for debit.

        • narrationstring

          Bank-provided transaction narration or description.

      • bank_ref_numstring

        NPCI/bank reference number for this statement fetch.