Skip to main content
POST
/
cancel-order
cURL
curl --request POST \
  --url https://gateway.architect.exchange/orders/cancel-order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "oid": "<string>",
  "aid": "<string>"
}
'
{
  "cxl_rx": true
}

Authorizations

​
Authorization
string
header
required

User session token

Body

application/json

Identifier of the order to cancel; either oid (server order id) or cid (client order id).

​
oid
string
required

Strong type for Order IDs to prevent mixing with other string values

Order IDs are ULIDs with a prefix:

  • Regular orders: O-
  • Liquidation orders: L-
​
aid
string | null

Optional account ID, selecting which account's cid namespace the reference resolves against. Only meaningful when the order is given by cid — a cid is unique per account, not globally — and superfluous when oid is supplied (server order ids are globally unique). If omitted, the default (primary) account is used.

Response

Order cancel requested

​
cxl_rx
boolean
required

Whether the cancel request has been accepted; e.g. true, false