POST · Products & purchasing
Hold an order cancellation for confirmation
Hold an order cancellation for confirmation
/api/v1/orders/{order}/actions/cancel
Description
Reads the order, refuses anything but an unpaid proforma, and returns {status:"confirmation_required", confirmationUrl, preview} — the preview names the order, its ocr and lines, the amount that will not be charged, and the effect. Deletes nothing on this call.
Path parameters
| Name | Type | Description |
|---|---|---|
order
required
|
string |
Body
Send as application/json.
| Name | Type | Description |
|---|---|---|
order_id
required
|
integer |
The order to cancel, from list_orders → data[].orderId. Minimum 1.
|
attempt_key
|
string | Idempotency key for this intent. Keep it stable across retries so a timed-out retry cannot buy the same thing twice. Up to 128 characters. |
Responses
A 200 response returns the shape shown in the rail.
Every non-2xx response is an RFC 7807 problem with a stable
code.
Commonly returned errors
The codes this operation reaches on its own path: the auth stack, its own validation and
ownership checks, and the transport. Not a closed set — a shared code from the
full registry can still surface. Each links to the code’s own page,
the same URL its type dereferences to.