GETBBPS Transaction Status
Check the current status of a BBPS bill payment by Eko TID or your client reference ID.
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
| Field | Type | Required | Description |
|---|---|---|---|
transaction-reference | string | required | Eko TID (`tid`) or your `client_ref_id` that uniquely identifies the transaction.e.g. 1734567890 |
transaction-referencestringRequiredEko TID (`tid`) or your `client_ref_id` that uniquely identifies the transaction.
example: 1734567890
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
initiator_id | string | required | Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729 |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
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.
dataobjectAPI-specific response payload.
tidstringEko's transaction ID.
amountstringTransaction amount in rupees.
operator_ref_idstringBiller or BBPS network reference number.
utility_acc_nostringConsumer/account number for which the bill was paid.