Eko Platform Services Logo

    GETBBPS Transaction Status

    Check the current status of a BBPS bill payment by Eko TID or your client reference ID.

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

    Generic transaction enquiry endpoint that works for all Eko transaction types including BBPS. Pass either the Eko tid or your client_ref_id as the path parameter. Returns the current tx_status (0=Success, 1=Fail, 2=Awaited, 3=Refund Pending, 4=Refunded, 5=On Hold), the operator reference, and the debited amount. Use this to handle tx_status=2 (Response Awaited) cases from Pay Bill. A timeout or slow bank response is not a failure — re-query with your client_ref_id to get the real status instead of retrying the payment.

    Path parameters

    transaction-referencestringRequired

    Eko TID (`tid`) or your `client_ref_id` that uniquely identifies the transaction.

    example: 1734567890

    Query parameters

    initiator_idstringRequired

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

    example: 9962981729

    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.

      • tidstring

        Eko's transaction ID.

      • amountstring

        Transaction amount in rupees.

      • operator_ref_idstring

        Biller or BBPS network reference number.

      • utility_acc_nostring

        Consumer/account number for which the bill was paid.