Check Transfer Status API

It will return the status of the transfers initiated by the merchant.

Production

https://payout.payumoney.com/payout/payment/listTransactions

Testing

https://test.payumoney.com/payout/payment/listTransactions

** Result are sorted on latest first basis.

Request Header Params

Key	Description	Data type	Mandatory	possible Values
Authorization	Access token generated earlier.	String	Yes	Bearer {access_token}
payoutMerchantId	This is the merchant id provided while onboarding	String	Yes

payountMerchantId is different from payumoney merchant id, please check payouts dashboard or call customer support if you don’t know your payoutsMerchantID

Request Params

Key	Description	Data type	Mandatory	possible Values
merchantRefId	Used while initiating transfer	String	No
transferStatus	Search by status of transfer. Merchant can get all success or failure transaction of the day to reconcile	String	No	QUEUED IN_PROGRESS PENDING FAILED SUCCESS WAITING_FOR_RETRY Added more information below
from	Date from transfer required	Date(dd/MM/yyyy )	No
to	Date to transfer required	Date(dd/MM/yyyy )	No
page	Page Number, Default 1	Integer	No
pageSize	Size of the page. Max 100, Default 10	Integer	No

Example

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&do=01%2F01%2F2019&page=1&pageSize=100&merchantRefId=&batchId=1'

Use the content type as 'application/x-www-form-urlencoded' to avoid erro

Sample Response :

{
 "status": 0,
 "msg": null,
 "code": null,
 "data": {
    "noOfPages": 1,
    "totalElements": 2,
    "currentPage": 0,
    "totalAmount": 0,
    "succesTxn": 0,
    "pendingTxn": 0,
    "transactionDetails": [
          {
          "txnId": 1165,
          "batchId": "Test",
          "merchantRefId": "7891247",
          "purpose": "test",
          "amount": 1.1,
          "txnStatus": "FAILED",
          "txnSubStatus" : "REVERSED",
          "txnDate": "2020-02-22T10:44:18.000+0000",
          "payuTransactionRefNo": "PAYOUT1582368257721B3aHZrZ7uql",
          "beneficiaryName": "shishir",
          "msg": "Failed",
          "responseCode": "0",
          "transferType": "NEFT",
          "bankTransactionRefNo": "PAYOUT1582368257721B3aHZrZ7uql",
          "nameWithBank": null,
          "lastStatusUpdateDate": "2020-02-22T10:45:02.000+0000"
           "succeedOn": ""
          },
          {
          "txnId": 1165,
          "batchId": "Test",
          "merchantRefId": "7891247",
          "purpose": "test",
          "amount": 1.1,
          "txnStatus": "SUCCESS",
          "txnSubStatus" : null,
          "txnDate": "2020-02-22T10:44:18.000+0000",
          "payuTransactionRefNo": "PAYOUT1582368257721B3aHZrZ7uql",
          "beneficiaryName": "shishir",
          "msg": "Failed",
          "responseCode": "0",
          "transferType": "NEFT",
          "bankTransactionRefNo": "PAYOUT1582368257721B3aHZrZ7uql",
          "nameWithBank": null,
          "lastStatusUpdateDate": "2020-02-22T10:45:02.000+0000"
           "succeedOn": "2020-02-22T10:45:02.000+0000"
          }
       ]
    }
 }

Response Params

Parameter	Description
txnId	Transaction id at payu end
batchId	Batch id provided by merchant at the time of initiating transfer
merchantRefId	merchantRefId provided by merchant at the time of initiating transfer
purpose	Purpose provided by merchant at the time of initiating transfer
amount	Transfer amount
txnStatus	QUEUED , IN_PROGRESS ,PENDING FAILED, SUCCESS, WAITING_FOR_RETRY for more info scroll below
txnSubStatus	Sub status of txn.
txnDate	Date when transaction initiated
payuTransactionRefNo	Payu transfer reference number.
beneficiaryName	Name of the beneficiary passed in request
msg	Response msg
responseCode	Response code from payu side, Please check below table for all values
transferType	Mode of the transfer used while initiating request (IMPS,NEFT,UPI)
bankTransactionRefNo	Bank transfer reference number
nameWithBank	Beneficiary name as per bank
lastStatusUpdateDate	Transfer terminating state time (Transfer success or failure time)

Transaction Status Meanings

Status	Description
QUEUED	It will be first state once we get transaction request from merchant. If merchant is not having enough balance in his account txn will be in queued state only till he/she do deposit in virtual account. ** Check disable queued payout
IN_PROGRESS	Transaction picked for processing with bank
PENDING	We have received pending status from bank. Final status will be updated once we get success or failure from bank. Reconciliation for these type of transaction happen after every 5 min.
FAILED	Transaction got failed at bank end. Check error message and fix if anything wrong in request or else retry.
SUCCESS	Transaction got success. Amount is transferred to customer account
WAITING_FOR_RETRY	Transaction is waiting to be picked again. You will get this status only in case bank / beneficiary bank server is down and you have passed retry as true or empty while calling transfer API.

Response Code in case of failure.

Error Code	Msg
600022	Purpose Code is Pass purpose code Check Internally Business required for this customer
600024	Invalid Debit Account for Customer
600025	Hold Funds Present - Refer to Drawer ( Account would Overdraw )
600023	A transaction with same reference number is already processed or under processing
600040	Rejected/Failed at upstream IMPS Service
600020	Purpose Code not found
600042	Correct beneficiary details and retry
600021	Only registered beneficiaries are allowed for this purpose code
600041	No Relationship Exists with the debit Account {AccountNo} and partner
600045	Transaction is in error due to issue with the transaction details.
600043	Transaction accepted by RBI but beneficiary bank rejected it.
600039	Correct beneficiary details and retry
600049	Request Reference Number sent in the request was not found.
600011	Invalid Transfer Type
600038	Rejected/Failed at beneficiary bank
600051	Gateway Timeout
600013	Beneficiary not acceptable
600012	Limit Daily/transaction/rate exceeded
600047	Bad Request
600026	Rejected/Failed at upstream CBS Service
600050	Internal Server Error
600010	Insufficient Balance in debit account, payment required
600028	Rejected by upstream CBS Service for the request parameters passed
600014	Bad Gateway
600027	No Relationship Exists with the debit Account {AccountNo} and partner
600048	Internal error
600029	NEFT - Both Customer Mobile and Email is not valid
600054	Outward transaction is rejected by the payment body
600053	Transaction is in error due to issue with the transaction details
600031	Destination Bank and Branch could not be resolved
600036	Beneficiary Bank is not enabled for Foreign Inward Remittance
600032	Acquiring Bank CBS or node offline
600037	Beneficiary account is closed
600034	Amount limit exceeded
600044	Outward Transaction Rejected
600035	Account blocked/frozen
600017	The transaction amount should be multiples of Re 1 for RTGS
600030	To Account Number is Invalid
600018	Transfer Amount is less than minimum amount for RTGS
600033	Invalid Benificiary MMID/Mobile Number
600046	Transaction is in error due to issue with the transaction details.
600015	The transaction amount exceeds the maximum amount for IMPS
600016	The transfer currency is not supported. Supported currency is INR
600019	IMPS is not enabled for the beneficiary IFSC
600052	The requested entity is no longer available