post https://uatoneapi.payu.in/payout/payment/listTransactions
The Check Transfer Status API will return the status of the transfers initiated by the merchant.
HTTP Method: POST
Environment
Test Environment | https://uatoneapi.payu.in/payout/payment/listTransactions |
Production Environment | https://payout.payumoney.com/payout/payment/listTransactions |
Sample request
curl -X POST \
https://test.payumoney.com/payout/payment/listTransactions \
-H 'authorization: Bearer 2678f236346281e6029e3430da1a721af29bb3546d6acbc27e6aadd7fca72605' \
-H 'cache-control: no-cache' \
-H 'content-type: application/x-www-form-urlencoded' \
-H 'payoutmerchantid: 1111122' \
-d 'transferStatus=QUEUED&from=01%2F01%2F2019&to=01%2F01%2F2019&page=1&pageSize=100&merchantRefId=&batchId=1'
Sample response
{
"status": 0,
"msg": null,
"code": null,
"data": {
"payoutMerchantId": null,
"noOfPages": 1,
"totalElements": 1,
"currentPage": 0,
"totalAmount": 0.0,
"succesTxn": 0,
"pendingTxn": 0,
"transactionDetails": [
{
"txnId": 71870,
"batchId": "smartSendBatch",
"merchantRefId": "0101010031",
"purpose": "Payout",
"amount": 1.0,
"txnStatus": "FAILED",
"txnSubStatus": null,
"txnSource": "SMART_SEND",
"txnDate": "2022-08-22T05:56:13.000+0000",
"scheduledTxnDate": "2022-08-22T05:56:13.000+0000",
"payuTransactionRefNo": "PAYOUT1661147773462lrSLcvHSc1K",
"beneficiaryName": "Customer",
"beneficiaryCardNo": null,
"msg": "Internal Error while validating vpa account",
"responseCode": null,
"transferType": "UPI",
"bankTransactionRefNo": null,
"nameWithBank": null,
"lastStatusUpdateDate": "2022-08-22T05:56:15.000+0000",
"succeedOn": null,
"fee": null,
"tax": null,
"txnStatusDescription": "Internal Error while validating vpa account",
"custom1": null,
"custom2": null,
"custom3": null,
"nameMatch": null
}
]
}
}
The status of a particular transaction has to be determined only from the field txnStatus in thetransactionDetails JSON against the merchantRefId.
On receiving the following JSON Response in the Check Transfer Status API, the transaction status is not determined and has to considered as unidentified or Pending by merchant.
{
"status": 0,
"msg": null,
"code": null,
"data": {
"payoutMerchantId": null,
"noOfPages": 0,
"totalElements": 0,
"currentPage": 0,
"totalAmount": 0.0,
"succesTxn": 0,
"pendingTxn": 0,
"transactionDetails": []
}
}
Headers and request parameters
Note:
The payoutMerchantId is different from PayU Merchant Id. Check the Payouts Dashboard or call the PayU Customer Support if you don’t know your payoutMerchantId.
Reference:
For sample request and response, refer to Sample Request and Response for Initiation & Tracking APIs.
Additional Info for request parameters
Parameters | Description | Example |
---|---|---|
transferStatusoptional | String Search by status of transfer. Merchant can get all success or failure transaction of the day to reconcile. The transfer status can be any of the following:- QUEUED/SCHEDULED - IN_PROGRESS - PENDING - FAILED Refer to the Transfer Status table for the description of each status. | success |
filterBySucceedOn] optional | Boolean This parameter must be passed True along with dateFrom and dateTo parameters, to filter the transactions that were successful between these dates.Note: For this filter, date range can be maximum of seven days. |