Transaction Status Enquiry

Description:: If the final transaction response will not be received by the client due to any technical or network issue then client can consume this API to get the final response for given transaction Id as path variable.

Headers

---

Content-Type: application/JSON

client_id: To be shared during integration

client_secret: To be shared during integration

Request Body Parameters

---

Parameters	Parameter Name	Parameter description with validation and examples	Attribute type	Mandatory/Not Mandatory
$1	Query Operation	Hard-coded field Must pass the value provided in E.g . It must Not be NULL. E.g. - "UAeps_txn_status_api"	String	Mandatory
$4	Start Date	Date field in yyyy-mm-dd format pass in string. It must Not be NULL. It must be same as the End Date. E.g. - "2023-05-05"	String	Mandatory
$5	End Date	Date field in yyyy-mm-dd format pass in string. It must Not be NULL. It must be same as the Start Date. E.g. -"2023-05-05"	String	Mandatory
$6	ClientRefId	Client reference id. length ≤ 20. It must Not be NULL. E.g.- "hdinn"	String	Mandatory

Sample Request Body

---

{ "$1": "UAeps_txn_status_api", "$4": "2023-05-05", "$5": "2023-05-05", "$6": "hdinn" }

Response Body Parameters

Parameters	Parameter description	Data type
status	Transaction status code. E.g - 200	Integer
message	Corresponding message of the status. E.g. - Success	String
length	Number of records displayed. E.g - 1	Integer
results	Displays the transaction record
statusDesc	Status description of the transaction. E.g. - "Suspected Fraud Decline"	String
createdDate	Created is send in timestamp. E.g. - 1688984141950	Timestamp
updatedDate	Updated is send in timestamp. E.g. - 1688984145754	Timestamp
productCode	Product Code . E.g. - "mATM"	String
txnType	Operation type of transaction. E.g. - "mATM_CASH_WITHDRAWAL"	String
txnAmount	Transaction amount. E.g. - 100	String
txnDateTime	Date and time of transaction. E.g. - 1688984141950	String
customeridentIfication	Card number. E.g. - "xxxx-xxxx-xxxx-0818"	String
status	Status of the transaction. E.g. - "AUTH_DECLINE"	String
transaction_status_code	Transaction Status Code. E.g. - 3	String
rrn	RRN Number. E.g. - "319115329358"	String
txnId	Unique id of the transaction. E.g. - "#1127905981926219776"	String
retailerUserName	Retailer’s user name. E.g. - "aepsTestR"	String
username	User Name. E.g. - "isutest"	String
clientreferenceid	Reference id the client. E.g. - “123Test”	String
param_b	To be use as per client discretion.	Alphanumeric String
param_c	To be use as per client discretion.	Alphanumeric String

Sample Response Body

SUCCESS :

{ "status": 200, "message": "Success", "length": 1, "results": [ { "statusDesc": "Invalid mc code under Meta tag", "createdDate": 1686743142182, "updatedDate": 1686743144140, "productCode": "UnifiedAEPS", "txnType": "AEPS_BALANCE_ENQUIRY", "txnAmount": 0, "txnDateTime": 1686743142182, "customeridentIfication": "xxxx-xxxx-4623", "status": "FAILED", "transaction_status_code": -1, "rrn": "316517414800", "txnId": "#1118496399520956416", "retailerUserName": "aepsTestR", "userName": "isutest", "clientreferenceid": "123Test", "param_b": null, "param_c": null } ] }

SUCCESS WITH NO DATA :

{ "message": "No record found in the Query", "length": 0, "Report": [], "status": 1 }

FAILED:

{ "status": 0, "message": "Query error: Unrecognized name: undefined at [12:29]" }

Transaction Status Codes

transaction_status_code	Status	Description
0	SUCCESS	Transaction Successful
-1	FAILED	Failed Response from bank
1	FAILED	Validation Error
2	FAILED	Exception
-1	REFUNDED	Amount Refunded to wallet

NOTE: The REFUNDED status is only relevant for the Cash Deposit API.

Detailed Status Codes

Code	Significance	Description
0	FAILED	Get error message in Response.
200	SUCCESS	Transaction response received with data.
1	SUCCESS	Transaction response with no data for required parameters

NOTE: The date and time stamp present across all endpoints in the document is in UTC timestamp format.