Get Transfer Status
Use this API to get details of a particular transfer. You can pass referenceId or transferId to fetch the details.
URL
https://merchant.payervault.com/payout-api/transferStatus
Click here to see the list of possible transfer statuses returned by Payervault.
Transfer Status | Description |
---|---|
SUCCESS | Transfer completed successfully. Acknowledged flag in the response tells whether the beneficiary bank has provided acknowledgement of the transfer request. |
ERROR | There was an error while requesting the transfer. See sub status code received for more details on why the error occurred. Example: Wrong IFSC. |
FAILED | The transfer has failed. |
PENDING | The request is getting processed. Query transfer status (/getTransferStatus) after some time to see whether the request was successful/failed. |
REVERSED | Transfer rejected by the beneficiary bank. The payout balance gets credited back with the amount charged. Note: You don't receive this when you are attempting a transfer but might see this when querying for transfer status (after a couple of hours). Configure the webhook endpoint to be notified in such cases. |
QUERY PARAMS
(Either referenceId or transferId is mandatory)
referenceId string
Reference ID of the transaction.
Example :
__URL__/transferStatus?referenceId=CFTR_123456
transferId string
Transfer ID of the transaction.
Example :
__URL__/transferStatus?transferId=TPXE_123456
Headers
X-Client-Id : | YOUR_CLIENT_ID |
---|---|
X-Client-Secret : | YOUR_CLIENT_SECRET |