Skip to main content
The cancelByCloid action lets you cancel orders using the client order ID (c field) you assigned when placing each order. This is useful when your system manages its own order identifiers and you want to avoid storing the exchange-assigned oid alongside them. You can include multiple cancels in a single signed request.

​
Endpoint

​
Request Body

​
Action Fields

​
string
required
Fixed value: "cancelByCloid".
​
array
required
Array of cancel-by-cloid objects. Each entry identifies the contract and the client order ID of the order to cancel.

​
Cancel Object Fields

​
int32
required
asset — The integer contract ID for the order you want to cancel. Must match the contract the order was placed on.
​
string
required
clientOrderId — The client order ID you set in the c field when placing the order (an int64 decimal string, e.g. "1778763737044"). This value must match exactly.

​
Responses

The order was found by its client order ID and removed from the book.

​
Response Fields

​
array
One entry per cancel object in request order. Each entry is either:
  • The string "success" — the order was located by client order ID and cancelled.
  • An object {"error": "<reason>"} — the cancellation failed; inspect the reason string for details.
To use cancelByCloid, you must have set the c field on the original order request. If you did not provide a client order ID at placement, use the standard cancel action with the exchange oid instead.