GETTransaction Inquiry

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

GET/tools/reference/transaction

Read-only: Changes nothing; only returns data.

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

Pass the reference as a query parameter — either Eko's tid or your client_ref_id. If you send both, the TID takes precedence:

By TID — /tools/reference/transaction?tid=<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?tid=2886601782.

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

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	Initiated / Response Awaited (NEFT) — keep polling
3	Refund Pending
4	Refunded
6	Response Awaited — Transaction Inquiry required

Request

Query parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`tid`Eko TID	string	optional	Eko TID that identifies the transaction. You must pass either this or your `client_ref_id`. If both are passed, Eko's TID takes precedence.e.g. 12839273
`client_ref_id`Client Reference ID	string	optional	Your `client_ref_id` that identifies the transaction. You must pass either this or Eko's `tid`.e.g. 28392661538393994551

initiator_idstringRequired

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

example: 9962981729

tidstringoptional· Eko TID

Eko TID that identifies the transaction. You must pass either this or your `client_ref_id`. If both are passed, Eko's TID takes precedence.

example: 12839273

client_ref_idstringoptional· Client Reference ID

Your `client_ref_id` that identifies the transaction. You must pass either this or Eko's `tid`.

example: 28392661538393994551

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
UI display hint only (-1/0 success, 1 failure, 2 initiated, 3 refund initiated, 4 refunded). Never branch on it — use `status` (and `tx_status` for financial APIs), or `response_type_id` where documented.
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=Initiated / Response Awaited (NEFT) — poll Transaction Inquiry, 3=Refund Pending, 4=Refunded, 6=Response Awaited — Transaction Inquiry required).
- 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

Request

Query parameters

Responses

Next steps

Related

`tx_status` values