Transaction Status Enquiry
Description:: This API will fetch the transaction id details according to the provided request mentioned below.
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. - "Cashout_addbank_status" | 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-03-23" | 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-03-23" | 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.- "871502989336576" | String | Mandatory |
$10 | Transaction ID | Transaction ID. length ≤ 20.E.g.- "871502989336576" | String | Not Mandatory |
Sample Request Body
Response Body Parameters
Parameters | Parameter description | Data type |
status | Transaction Status Code. E.g. - 200 | Integer |
message | Message for the above transaction status. E.g. - “Success” | String |
length | Length. E.g. - 1 | Integer |
results | Results of performed transaction. | |
transactionId | Transaction ID. E.g. - 386107533434880 | Integer |
subStatus | Sub Status of the Transaction. E.g. - 0 | Integer |
status | Status of the Transaction. E.g. - "SUCCESS" | String |
statusDesc | Status description of the transaction E.g. - "CO00 - Transaction is Successful." | String |
beneName | Beneficiary’s Account Number. E.g. - "33171402473" | String |
beneAccountNo | Beneficiary’s Name. E.g. - "kiran" | String |
beneifsc | Beneficiary’s IFSC. E.g. - "SBIN0001083" | Integer |
benePhoneNo | Beneficiary’s Phone Number. E.g. - 7381279922 | Integer |
beneBankName | Beneficiary’s Bank’s Name. E.g. - "State Bank of India" | String |
clientreferenceid | Client Reference id. E.g. - "10824456780909" | String |
latlong | Latitude and Longitude. E.g. - "22.8031731,88.7874172" | String |
pincode | Pincode. E.g. - 751024 | Integer |
custName | Name of the Customer. E.g. - "Vijay Nayak" | String |
custMobNo | Customer’s Mobile Number. E.g. - 9821361027 | Integer |
rrn | Transaction unique ID. E.g. - "308214158501" | Integer |
paramA | To be used as per client. | Alphanumeric String |
paramB | To be used as per client. | Alphanumeric String |
dateTime | Date and time of transaction. E.g. - "03-23-2023 02:28:08" | String |
txnAmount | Transaction amount. E.g. - 100 | Integer |
txnType | Operation type of transaction. E.g. - "IMPS" | String |
Sample Response Body
SUCCESS :
FAILED :
Detailed Status Codes
Sl.No. | Status | Code | Mode | Description | HTTP Status Code |
1 | SUCCESS | 0 | IMPS & NEFT | IMPS & NEFT SUCCESS | 200 |
2 | SUCCESS | 1 | IMPS & NEFT | IMPS & NEFT INPROGRESS TO SUCCESS | 200 |
3 | FAILED | 0,-1 | IMPS & NEFT | IMPS & NEFT FAILED | 200 |
4 | FAILED | 1 | IMPS & NEFT | IMPS & NEFT INPROGRESS TO FAILED | 200 |
5 | INPROGRESS | 1 | IMPS & NEFT | IMPS & NEFT INPROGRESS | 200 |
NOTES:
- If a time-out is encountered then do not perform a status check immediately after you get the status , wait for at least 15 seconds then proceed.
- If you receive "statusCode"& "status" different from those mentioned in the above table, treat them as IMPS INPROGRESS transactions.
- Here you have to always refer to both "statusCode" & "status", for the fate of the transaction.