Cancel Order

put/api/prime/trading/v1/accounts/{accountId}/orders/{orderId}/cancel

Submits a request to cancel a previously placed order. The successful response confirms the request submission only, not the final order cancellation. Use the Get Order endpoint or the orders websocket to confirm the final order status.

Path Parameters

  • accountIdstringRequired
    The ID of the account
  • orderIdstringRequired
    The ID of the order to cancel. This is the value of the ID field returned when the order was created.

400 Response

error string required
errorName string required
reqId string required
context object
Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
errorName string required
Same value as the top-level errorName.
field string
Request field associated with the validation failure.
message string
Human-readable field-level validation message.

401 Response

error string required
errorName string required
reqId string required
context object
Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
errorName string required
Same value as the top-level errorName.
field string
Request field associated with the validation failure.
message string
Human-readable field-level validation message.

403 Response

error string required
errorName string required
reqId string required
context object
Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
errorName string required
Same value as the top-level errorName.
field string
Request field associated with the validation failure.
message string
Human-readable field-level validation message.

422 Response

error string required
errorName string required
reqId string required
context object
Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
errorName string required
Same value as the top-level errorName.
field string
Request field associated with the validation failure.
message string
Human-readable field-level validation message.

429 Response

error string required
errorName string required
reqId string required
context object
Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
errorName string required
Same value as the top-level errorName.
field string
Request field associated with the validation failure.
message string
Human-readable field-level validation message.

500 Response

error string required
errorName string required
reqId string required
context object
Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
errorName string required
Same value as the top-level errorName.
field string
Request field associated with the validation failure.
message string
Human-readable field-level validation message.