Cancel Transfer API

merchant can cancel queued transfer by calling this api.

Production

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

Testing

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

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	Unique reference id generated at merchant side to distinguish between multiple transfers. Same value will be used by merchant to check status of transfer or to cancel it.	String	Yes

Example

Sample Request :

curl -X POST \
 https://test.payumoney.com/payout/payment/cancel \
 -H 'authorization: bearer 45f87fed35bdafe9f47698ed03e202e282f873b79a57eb53a9d30247b376f01d' \
 -H 'content-type: application/x-www-form-urlencoded' \
 -H 'payoutmerchantid: 1111122' \
 -d merchantRefId=1584856958885

Response :

Success

{
 "status": 0,
 "msg": "Payout transaction cancelled",
 "code": null,
 "data": null
 }

Failure

{
 "status": 1,
 "msg": "Merchant reference Id is incorrect",
 "code": null,
 "data": null
 }