Eko Platform Services Logo

    GETTransaction Inquiry

    Get the status of any transaction by Eko TID or your client_ref_id.

    GET/tools/reference/transaction/{transaction-reference}

    Looks up a transaction's status using either Eko's TID or your own client_ref_id — useful when a response timed out and you never received the TID. tx_status codes: 0 = Success, 1 = Fail, 2 = Awaited/Initiated (NEFT), 3 = Refund Pending, 4 = Refunded, 5 = Hold. A timeout should never be treated as an automatic failure — always inquire.

    Path parameters

    transaction-referencestringRequired

    Eko TID or your client_ref_id identifying the transaction.

    example: 12971397

    Query 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

    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.

    • dataobject

      API-specific response payload.

      • tx_statusstring

        Transaction status (0 Success, 1 Fail, 2 Awaited, 3 Refund Pending, 4 Refunded, 5 Hold).

      • txstatus_descstring

        Human-readable transaction status.

      • tidstring

        Eko transaction ID.

      • client_ref_idstring

        Your reference id for the transaction.

      • amountstring

        Transaction amount (INR).

      • bank_ref_numstring

        Bank/UTR reference number.

      • recipient_namestring

        Recipient's name.

      • timestampstring

        Transaction timestamp.