To cancel a payment, you use a payment resource.

Payments at Cleeng are a reference to the actual payment that happens at the payment gateway or in-app store.

To cancel a payment, make a PATCH request to the /3.1/payments/{paymentId}/cancel endpoint where paymentId is the reference of the payment you want to cancel.

Please note that you can use this endpoint to cancel a payment that has been authorized but not captured yet. (For more information about payment authorization and capture, see here).

Cancelling a payment means that the payment is not processed any further.

{
  "success": true,
  "message": "Payment cancelled successfully"
}