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. - "POS_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-01-15" | 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-01-15" | String | Mandatory |
$6 | ClientRefId | Client reference id. length ≤ 18. It must Not be NULL. E.g.- "7882993433124864" | String | Mandatory |
$7 | Param_b | Param B. To be used by the client as per requirement, length ≤ 20. E.g. -"branch1" | String | Not Mandatory |
$8 | Param_c | Param C. To be used by the client as per requirement, length ≤ 20. E.g.- "loanID1234" | String | Not Mandatory |
$10 | Transaction ID | Transaction ID. length ≤ 20. E.g.- "4485418793181184" | Integer | Not Mandatory |
Sample Request Body
Response Body Parameters
Parameters | Parameter description | Data type |
statusDesc | status description of the transaction E.g. - "91 - ISSUER UNAVAILABLE" | String |
createdDate | ||
value (created date) | Created date in timestamp. E.g. "2023-01-16T10:05:01.325Z" | Timestamp |
updatedDate | ||
value (updated date) | Updated date in timestamp. E.g. - "2023-01-16T10:05:04.261Z" | Timestamp |
productCode | Product Code . E.g. - "POS" | String |
txnType | Operation type of transaction. E.g. - "Sale@POS" | String |
txnAmount | Transaction amount. E.g. - 132 | String |
txnDateTime | ||
value (Transaction Date and Time) | date and time of transaction. E.g. - "2023-01-16T10:05:01.325Z" | Timestamp |
customeridentIfication | Customer Identification. Aadhaar number E.g. - "xxxx-xxxx-4881" | String |
status | Status(SUCCESS/FAILED). E.g. - "FAILED" | String |
rrn | Transaction unique ID. E.g. - "301615193375" | String |
txnId | Unique id of the transaction. E.g. - "#4485418793181184" | String |
retailerUserName | Retailer User Name. E.g. - "isutest" | String |
username | Reatailer id. E.g. -"isutest" | String |
clientreferenceid | Reference id the client. E.g. - "6795" | String |
param_b | Param B. E.g - "branch1" | Alphanumeric String |
param_c | Param B. E.g - "morefun" | Alphanumeric String |
Sample Response Body
SUCCESS :
SUCCESS WITH NO DATA :
FAILED:
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. |