DELETE
Cancel an order

Authorizations

Authorization
string
header
required

The end user's JWT access token, sent as Authorization: Bearer <token>.

Obtain one from POST /partner/customers or POST /partner/customers/login — both return it as token. It identifies which of your users a call is made for, and is sent alongside your X-API-Key on every authenticated endpoint.

Event discovery, categories, subcategories and scores are public and need no token.

X-API-Key
string
header
required

ISV / partner credential — public half. Required on every request.

Identifies the integration partner (ISV) making the call. Issued by Dime Trades when the ISV is onboarded and sent on every /partner/* endpoint:

  • On the two partner endpoints that create accounts or issue tokens (POST /partner/customers, POST /partner/customers/login), it is accompanied by X-API-Secret and is the only authentication — there is no user token yet.
  • On every other partner endpoint it is sent alongside the user's Authorization: Bearer <token>: the API key says which platform is calling, the bearer token says which user it is calling for.

Credentials are scoped to one or more brands; using a key with a brandId outside that scope returns 403. Staging and production keys are separate. The key identifies your platform — treat it as a backend credential.

Path Parameters

orderId
string<uuid>
required

The UUID of the order.

Example:

"019f2cfb-9df3-733c-b8af-42a3620ee455"

Response

Cancellation request accepted.

data
CancelOrderAck · object

Acknowledgement returned by DELETE /orders/{orderId}. status is pending_cancel when the cancel was just submitted, or canceled (with a different message) when the order was already cancelled — see CancelOrderService.

pending_cancel is an acknowledgement value, not an order status. It means the cancel command was published to the matching engine; it is never written to the order, and GET /orders will keep reporting the order as open or partial until the engine confirms and the row flips to canceled. A cancel only acts on live orders (open, partial): an already-canceled order returns this ack with status: canceled and no command is published, while an order in any other terminal status (filled, partially_filled, rejected, expired) returns a 400.

errors
array