Cancel a Payment

post https://{environment}.joinforage.app/api/payments/{payment_ref}/cancel/

✅
This endpoint is only relevant to Forage SDK integrations.
If you’re building with the Fully Hosted or Custom Forage Checkout UI, then use the Order and OrderPayment endpoints.

A POST request to /payments/{payment_ref}/cancel/ stops an existing Payment object from being submitted for capture in future API calls.

A Payment can only be canceled if its status is requires_confirmation or failed.

This endpoint has no financial side effects because it doesn’t affect successfully captured or processing Payments.