---
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`

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

**Behaviour**

- **Read-only**: Changes nothing; only returns data.

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

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| tid | string | no | 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 | string | no | Your `client_ref_id` that identifies the transaction. You must pass either this or Eko's `tid`. e.g. 28392661538393994551 |

## 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 | 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_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=Initiated / Response Awaited (NEFT) — poll Transaction Inquiry, 3=Refund Pending, 4=Refunded, 6=Response Awaited — Transaction Inquiry required). |
| 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
{
  "status": 0,
  "response_status_id": 0,
  "response_type_id": 70,
  "message": "Transaction details fetched successfully",
  "data": {
    "tx_status": "3",
    "amount": "1000.0",
    "txstatus_desc": "Refund Pending",
    "fee": "150.0",
    "channel": "",
    "branch": "",
    "gst_benefit": "",
    "tid": "12839273",
    "tx_desc": "Indo-Nepal Money Transfer",
    "allow_retry": "0",
    "service_tax": "",
    "currency": "INR",
    "pipe": "",
    "customer_id": "7777777777",
    "bank_ref_num": "1111187250183230",
    "recipient_id": 1157,
    "timestamp": "2018-10-01 17:09:54"
  }
}
```