Skip to main content
POST
Cancel an order

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Headers

Idempotency-Key
string
required

Client-supplied key that deduplicates retried requests. Reusing a key returns the original result instead of repeating the action.

Api-Signature
string
required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Pattern: ^[0-9A-Fa-f]{128,160}$
Api-Timestamp
integer<int64>
required

Current timestamp, represented as unix epoch seconds

Path Parameters

accountId
string<uuid>
required

Account ID or subaccount ID (a UUID) the order was placed with. Unlike lookup, cancellation is not available through a subaccount the order was merely allocated to, since canceling affects the entire order.

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

orderId
string<uuid>
required

The order ID (a UUID) returned when the order was placed.

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

Response

Cancel request accepted. Only the order ID and external ID are returned; the client is expected to look up the order's cancellation state via the order lookup endpoint.

data
Cancel Order Result · object
required