PUBLISH Cancel Order

The status field in the response object can take the following values:

canceled: Indicates that the specified order has been canceled.
order_not_found: Indicates that no order exists with the provided order_id.
fast_cancel: Indicates that the client_order_id provided is not in the book. If it eventually reaches the book, it will be automatically canceled upon arrival.

Additionally, other issues such as authentication failures will result in an HTTP 400 error and an error_description.

REQUEST

HEADER PARAMS


msg_type string required Message type: `cancel_order`
id number required The ID of the request. This is returned in the response header.
version integer required Version number: `1`

##### BODY PARAMS


order_id string The order ID of the limit order that was returned from a previous `add_order` call. If not present, `account_id` and `client_order_id` must be provided. If present, it will be used for the cancellation regardless of other fields.
account_id string The account ID of which the order belongs to. Must be provided if `order_id` is absent.
client_order_id string The client order ID of an order. Must be provided if `order_id` is absent.

Example

[
  {
    "msg_type":"cancel_order",
    "id": 1002,
    "version": 1
  },
  {
    "order_id": "8524676410238383080"
  }
]

RESPONSE


client_order_id string The client order ID.
order_id string The unique ID of the order.
status string The status of the cancellation. Can be `canceled`, `order_not_found`, or `fast_cancel`.
market_seqno string The market sequence number of the `cancel`. A monotonic sequence number updated for each book event. e.g. a fill, cancel, etc.
transaction_ts string The time the order was canceled by the system in UNIX epoch nanoseconds.
size string The size of the order that was canceled.

Example

[
  {
    "msg_type":"cancel_order_response",
    "id": 1002,
    "version": 1
  },
  {
    "client_order_id": "8524676410238383080",
    "order_id": "8524676410238383080",
    "status": "canceled",
    "market_seqno": 123456,
    "transaction_ts": "1727155069335724372",
    "size": "1"
  }
]