Transaction Inquiry

Get the status of a transaction using Eko TID or client_ref_id

📘

Examples

To check the status of a transaction using TID 12345, use following request parameter :

tid:2886601782

In case you have not received Eko's TID (say, due to network timeout), you can enquire about the status of a transaction using your own unique reference number (say, 567890) by using the following request parameter :

client_ref_id : 567890

🚧

Transaction Timeout

A transaction can timeout due to multiple reasons where partner bank responses could be slow or due to network connectivity, delayed or no response may occur.

In such cases transaction should not be treated as declined or failed. Ideally, it should be inquired using Transaction Inquiry API by passing your own unique reference number i.e. client_ref_id.

Possible values of parameter tx_status:

tx_statusDescription
0Success
1Fail
2Response Awaited/Initiated (in case of NEFT)
3Refund Pending
4Refunded
5Hold (Transaction Inquiry Required)
Path Params
string
required

Eko TID or your client_ref_id that uniquely identifies the transaction

Query Params
int32
required

Your registered mobile number (See Platform Credentials for UAT)

string
required

Unique code of your registered agent/retailer

Headers
string
required

Your static API key (See Guide)

string
required

Your dynamically generated security key, unique for every request (See Guide)

string
required

The current timestamp used to generate secret-key

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json