Transaction Status Enquiry

Description:: If the final transaction response will not be received by 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. - "Upi_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-06-22"	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-06-22"	String	Mandatory
$6	ClientRefId	Client Reference ID. length = 19. Format to be followed - (^[A-Z]{3} [0-9]{16}$). It must Not be NULL. E.g.- "DFG5676787959405810"	String	Mandatory
$7	Param_b	Param B. To be used by the client as per requirement, length ≤ 20. E.g. -"branch1"	String	Not Mandatory
$10	Transaction ID	Transaction ID. length ≤ 20.E.g.- "1121346012644900864"	String	Mandatory

Sample Request Body

---

{ "$1": "Upi_txn_status_api", "$4": "2023-06-22", "$5": "2023-06-22", "$6": "DFG5676787959405810", "$10": "1121346012644900864" }

Response Body Parameters

Parameters	Parameter description	Data type
status	Status of the transaction operation. 200 - Success.	Integer
message	Description of the above status. E.g. - "Success"	String
length	Number of records received. 1 - One record received. 0 - No record found.	Integer
statusDesc	status description of the transaction E.g. - "transaction success"	String
createdDate	created is send in timestamp. E.g. "1687420123377"	Timestamp
updatedDate	created is send in timestamp. E.g. "1687420123509"	Timestamp
productCode	Product Code. E.g. - "UPI"	String
txnType	Operation type of transaction. E.g. - "QR_COLLECT"	String
txnAmount	Transaction amount. E.g. - "1"	Integer
txnDateTime	date and time of transaction. E.g. - "1687420123377"	Integer
customeridentIfication	Customer Identification. E.g. - "8018094801@ybl"	String
status	Status Detail. E.g. - "INITIATED"	String
rrn	Transaction unique ID. E.g. - "113715735817"	String
txnId	Unique id of the transaction. E.g. - "#1121346012644900864"	String
retailerUserName	Reatailer id. E.g. - "upitestret"	String
username	User Name. E.g. - "apisdktestapi"	String
clientreferenceid	Reference id of the client.	String
param_b	To be used as per client's discretion. E.g. - "iServeU"	Alphanumeric String
param_c	To be used as per client's discretion.	Alphanumeric String

Sample Response Body

SUCCESS :

{ "status": 200, "message": "Success", "length": 1, "results": [ { "statusDesc": null, "createdDate": 1687420123377, "updatedDate": 1687420123509, "productCode": "UPI", "txnType": "QR_COLLECT", "txnAmount": 1, "txnDateTime": 1687420123377, "customeridentIfication": "8018094801@ybl", "status": "INITIATED", "rrn": null, "txnId": "#1121346012644900864", "retailerUserName": "upitestret", "userName": "apisdktestapi", "clientreferenceid": null, "param_b": "iServeU", "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]" }

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