GETTransaction Inquiry

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

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

Get the current status of a transaction using either Eko's TID or your own client_ref_id. This is a generic inquiry endpoint — it works for all Eko financial transaction types (fund transfer, BBPS, AePS settlement, NEFT, and more).

The transaction reference goes in the URL path. Pass an Eko TID as-is; to look up by your client_ref_id, prefix it with client_ref_id::

By TID — /tools/reference/transaction/<TID>
By client_ref_id — /tools/reference/transaction/client_ref_id:<your client_ref_id>

Note

Examples

To check the status of a transaction using TID 2886601782, call /tools/reference/transaction/2886601782.

If you never received Eko's TID (say, due to a network timeout) but sent your own unique reference 567890, look it up with /tools/reference/transaction/client_ref_id:567890.

Warning

Transaction timeout

A transaction can time out for many reasons — a slow partner-bank response, or network connectivity causing a delayed or missing response.

In such cases the transaction must not be treated as declined or failed. Inquire about its real status using this API with your own client_ref_id, instead of retrying the payment.

`tx_status` values

`tx_status`	Description
0	Success
1	Fail
2	Response Awaited / Initiated (in case of NEFT)
3	Refund Pending
4	Refunded
5	Hold (Transaction Inquiry required)

Request

Path parameters

Field	Type	Required	Description
`transaction-reference`	string	required	Eko TID or your `client_ref_id` that identifies the transaction. Pass a TID as-is; to look up by `client_ref_id`, prefix it — e.g. `client_ref_id:567890`.e.g. 12971397

transaction-referencestringRequired

Eko TID or your `client_ref_id` that identifies the transaction. Pass a TID as-is; to look up by `client_ref_id`, prefix it — e.g. `client_ref_id:567890`.

example: 12971397

Query parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`client_ref_id`	string	optional	Unique reference ID per API call, generated by your system (max 20 characters).e.g. 2026010100123456789

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

These headers authenticate and sign every request. See How Auth Works for details.

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

Next steps

NextPOSTGet Refund OTPRequest the refund OTP for a failed transaction (sent to the customer's mobile).

tx_status values