---
title: "Transaction Inquiry API Reference"
description: "Get the status of any transaction by Eko TID or your client_ref_id."
canonical: "https://eps.eko.in/docs/transaction-inquiry"
---


> **Canonical URL:** https://eps.eko.in/docs/transaction-inquiry
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# Transaction Inquiry API Reference

`GET https://staging.eko.in/ekoapi/v3/tools/reference/transaction/{transaction-reference}`

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

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.

> View product & pricing details: [Transactions & Refunds](https://eps.eko.in/products/transactions-api.md)

## Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| transaction-reference | string | yes | Eko TID or your client_ref_id identifying the transaction. e.g. 12971397 |

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| user_code | string | yes | User code of the retailer/agent the service is run for. e.g. 20810200 |

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| developer_key | string | yes | Static API key issued to your account after KYC. |
| secret-key | string | yes | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
| secret-key-timestamp | string | yes | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
| content-type | string | yes | application/json e.g. application/json |

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | Granular status id; see the shared error-codes table. |
| response_type_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| data | object | API-specific response payload. |
| data.tx_status ⭐ | string | Transaction status (0 Success, 1 Fail, 2 Awaited, 3 Refund Pending, 4 Refunded, 5 Hold). |
| data.txstatus_desc ⭐ | string | Human-readable transaction status. |
| data.tid ⭐ | string | Eko transaction ID. |
| data.client_ref_id ⭐ | string | Your reference id for the transaction. |
| data.amount | string | Transaction amount (INR). |
| data.bank_ref_num | string | Bank/UTR reference number. |
| data.recipient_name | string | Recipient's name. |
| data.timestamp | string | Transaction timestamp. |

## Example response

```json
{
  "response_type_id": 1472,
  "data": {
    "bank_ref_num": "8761099407",
    "account": "234243534",
    "fee": "5.0",
    "client_ref_id": "Settlemet7206123420",
    "gst": "0.76",
    "sender_name": "Flipkart",
    "timestamp": "2019-11-01 17:50:44",
    "ifsc": "SBIN0000001",
    "beneficiary_account_type": 1,
    "txstatus_desc": "Success",
    "tx_status": "0",
    "tid": "12971397",
    "amount": "1045.0",
    "payment_mode": 5,
    "recipient_name": "Virender Singh"
  },
  "message": "Sucess! Enquiry success.",
  "status": 0,
  "response_status_id": 0
}
```
