Use the Order management API to cancel uncaptured orders.
When your customers don't want to proceed with the purchase and need to cancel their order before you capture it, send an API call to cancel the authorization.
When you cancel the order, we release the authorized amount and you can't make further updates to the order.
To successfully cancel the order, don’t capture any items listed in it.
The following diagram depicts how this API call works:
To cancel an authorized order, send a
POST request to the
order_id is the identifier you get in a successful response when placing a new order. You don't need a request body for this
If the request is successful, the order is canceled, and you'll receive a
204 No content response.
If your request contains errors, you'll receive an error response. It can be because the order has captures or is closed.
Make sure the
order_id is correct. You can use the
correlation_id and the
order_id values to troubleshoot the call in the Merchant portal Logs section.
Ready to send this request? See the API reference of this call.