Used to cancel the collect request

Request Headers

Header NameHeader Value
X-VERIFYSHA256("/v3/charge/{merchantId}/{transactionId}/cancel" +
salt key) + ### + salt index

Path Parameters

Parameter NameTypeDescriptionMandatory
merchantIdSTRINGUnique Merchant ID assigned to the merchant by PhonePeYes
transactionIdSTRINGUnique Transaction ID generated by the merchant to track this request to PhonePeYes

Response Parameters

Parameter NameTypeDescription
successBOOLEANSuccess status of the request
codeENUMSee below section for list of codes
messageSTRINGShort message about status
dataOBJECTEmpty object

Response Codes

The code in the above API response could be.

  • INTERNAL_SERVER_ERROR : There can be internal server error. Merchant should retry the cancel API request.
  • PAYMENT_ALREADY_COMPLETED : Payment has been succesful hence can't cancel the request. For this case merchant should trigger successful transaction, generating the bill.
Click Try It! to start a request and see the response here!