Cancel an OrderPayment

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

✅
This endpoint is only relevant to Fully Hosted and Custom integrations.
If you’re building with a Forage SDK, then use the Payments endpoints.

🚧
To keep your app secure, requests to cancel an OrderPayment should only be generated on the server-side.

A POST request to /orders/{order_ref}/payments/{payment_ref}/cancel/ cancels an existing OrderPayment.

An OrderPayment can only be cancelled if its status is requires_confirmation or failed. Because only payments in these unsuccessful states can be canceled, this endpoint has no financial side effects.

On success, the API responds with the original OrderPayment object.