This API is used for verifying the current status or outcome of a Unified Payments Interface (UPI) transaction.
We have two endpoints available for checking transaction status :
– Served from the "Main Server" : "getAllTransactionStatus".
– Served from the "Read-Only Server" : "getAllTransactionStatusv2".
If you are calling the check status immediately after receiving a callback, please use the "getAllTransactionStatus" endpoint.
For all other use cases, kindly use the "getAllTransactionStatusv2" endpoint.
Get:
https://{{staging/production}}/upi/{Endpoint}?refId=2024220214044504WZHWMResponse Parameters:
| PARAMETER | DATA TYPE | DESCRIPTION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| resultStatus | String | Success Failure | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| resultCode | Number | 000 for Success 400 for Failure | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| resultMsg | String | A brief textual description explaining the validation result. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | String | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for "getAllTransactionStatus" Endpoint
{
"resultCode": "000",
"resultStatus": "success",
"resultMessage": "",
"data": {
"TransactionId": "PPN80b9ebfa251549202402221405169825",
"MessageId": "2BeVimbD3V",
"ReferenceId": "2024220214044504WZHW",
"CustomerRefNo": "405314465022",
"TransactionDate": "2/22/2024 2:05:00 PM",
"TxnTypeName": "Collect_Sent",
"TxnStatus": 3,
"PayerAddress": "90xxxxxx48@paytm",
"PayerName": "Manishkumar Patel",
"PayeeAddress": "merchant.xxxxxx@digikhata",
"PayeeName": "Pay Point India Network Pvt. Ltd.",
"Amount": 3,
"TxnRemarks": "For retailer portal limit",
"ResponseMessage": "",
"CollectTxnStatus": 3,
"ApproveOrDecline": 2,
"PayerAccountNumber": "12470100017586",
"PayeeAccountNumber": "918452008800"
}
} Response for "getAllTransactionStatusv2" Endpoint
{
"resultCode": "000",
"resultStatus": "success",
"resultMessage": "",
"data": [
{
"TransactionId": "PPN80b9ebfa251549202402221405169825",
"MessageId": "2BeVimbD3V",
"ReferenceId": "2024220214044504WZHW",
"CustomerRefNo": "405314465022",
"TransactionDate": "2/22/2024 2:05:00 PM",
"TxnTypeName": "Collect_Sent",
"TxnStatus": 3,
"PayerAddress": "90xxxxxx48@paytm",
"PayerName": "Manishkumar Patel",
"PayeeAddress": "merchant.xxxxxx@digikhata",
"PayeeName": "Pay Point India Network Pvt. Ltd.",
"Amount": 3,
"TxnRemarks": "For retailer portal limit",
"ResponseMessage": "",
"CollectTxnStatus": 3,
"ApproveOrDecline": 2,
"PayerAccountNumber": "12470100017586",
"PayeeAccountNumber": "918452008800"
}
]
} Result Code
| RESULT CODE | RESULT STATUS | RESULT MESSAGE |
|---|---|---|
| 401 | Fail | Access Denied |
| 000 | Success | "",data = new {TransactionId = "",MessageId = "",ReferenceId = "",CustomerRefNo = "",TransactionDate = "",TxnTypeName = "",TxnStatus = "",PayerAddress = "",PayerName = "",PayeeAddress = "",PayeeName = "",Amount = "",TxnRemarks = "",ResponseMessage = "",CollectTxnStatus = "",ApproveOrDecline = "",PayerAccountNumber = "",PayeeAccountNumber = ""} |
| 400 | Fail | No record found. |
| 500 | Fail | Sorry, your request is not processed please try after some time. |
Txn Status Result Code
| RESULT CODE | RESULT STATUS |
|---|---|
| 1 | Pending |
| 2 | Pending |
| 3 | Success |
| 4 | Failed |
| 5 | Expired |
Powered by Froala Editor