Cancel order

[POST] /api/v2/order/cancel

Cancels an order that has not been paid yet. The order moves to deposit_canceled.

Only an order still in deposit_awaiting can be cancelled. Anything later returns 400 "Order is not in a state that allows cancellation" — once the deposit is validating or successful the money is in motion, and a failed payout is refunded instead. See Order statuses.

This endpoint also requires the end-user-creation capability on your account; without it every call returns 403. See Integration guide.

You do not have to cancel abandoned orders. An unpaid order expires by itself at order.expiresAt. Cancelling is for when the user explicitly backs out, so the offer is released immediately.

deposit_canceled is not the end of the story. If the user's payment turns up afterwards we still accept it, and the order moves on to deposit_successful. Do not treat a cancellation as proof that no money will arrive — keep handling webhooks for that order.

Request body type:

type RequestBody = {
  orderId: string;
}

Request body example:

{
  "orderId": "68728fa56ff494df5f39faf5"
}

Response

Returns the updated order — the same Order object as Get order, now with status: "deposit_canceled".