WSS

Cancel Order

Send on an established WebSocket connection to cancel a previously placed order.

Submits a cancel request for the given orderId. A successful response confirms the cancel request was accepted, not that the order is already canceled — confirm final status on the orders subscription channel or via Get Order.

See the REST Cancel Order endpoint for validation error codes.

Requires access token scope: trade_trade on the token used to open the connection.

Idempotency: canceling an order already in pending_cancel is accepted again.

Connection

WSS wss://app.bitgo-test.com/api/prime/trading/v1/ws

Channel cancel_order

Authorization The access token used to open the connection must have the trade_trade scope to send cancel_order messages. If the token is missing or invalid the upgrade is refused with HTTP 403 and no socket is opened; a token without trade_trade gets a WebSocket cancel_order_response with status: rejected and error code common:permissionDenied.

Messages sent

Cancel order

Cancel order request.

object

type string enum required

Must be cancel_order.

cancel_order
reqId string

Optional client correlation ID, echoed in the response when valid. Omitted from the response when not supplied or when reqId itself fails validation. Use a fresh reqId on each send (including retries). Do not use reqId for idempotency — use orderId only to identify the order being canceled.

up to 36 characters
accountId string required

The ID of the account
orderId string uuid required

The order ID to cancel (UUID). Validation errors use field id in the error payload (not orderId), even though the request field is orderId.

Messages received

Cancel order response

The server responds with a cancel_order_response for each cancel_order message.

ONE OF

type string enum required

cancel_order_response
reqId string

Echoed when the client supplied a valid reqId.
status string enum required

accepted
orderId string uuid required

Echoes the orderId from the cancel_order request.

type string enum required

cancel_order_response
reqId string

Echoed when the client supplied a valid reqId.
status string enum required

rejected
error object required

Structured error when status is rejected. Error codes mirror REST domain codes (e.g. trade:invalidQuantity) without the REST backend: prefix.
error object
- code string required
  Error code. Common values:
  - common:invalidArgument — validation failure (see field)
  - common:permissionDenied — missing trade_trade scope
  - trade:orderNotCancelable — cancel on completed/canceled order
  - internal:internalError — internal failure (generic message)
  - internal:timeout — request timed out or connection canceled
- field string nullable
  
  Request field associated with the error when applicable. Cancel validation uses id for orderId wire field errors.
- message string required
  
  Human-readable error detail.

# Connect (npm i -g wscat) wscat -c "wss://app.bitgo-test.com/api/prime/trading/v1/ws" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" # Then send the subscribe frame: > { "accountId": "f230fdebfa084ffebc7e00515f54603f", "orderId": "8a1f2e3d-4c5b-6a7e-8f9d-0a1b2c3d4e5f", "reqId": "c2a8e4f0-9b1d-4e7a-8c3f-1e2d3f4a5b6c", "type": "cancel_order" }

import WebSocket from 'ws'; const ws = new WebSocket('wss://app.bitgo-test.com/api/prime/trading/v1/ws', { headers: { Authorization: 'Bearer YOUR_ACCESS_TOKEN' } }); ws.on('open', () => { ws.send(JSON.stringify({ "accountId": "f230fdebfa084ffebc7e00515f54603f", "orderId": "8a1f2e3d-4c5b-6a7e-8f9d-0a1b2c3d4e5f", "reqId": "c2a8e4f0-9b1d-4e7a-8c3f-1e2d3f4a5b6c", "type": "cancel_order" })); }); ws.on('message', (data) => { console.log(JSON.parse(data)); });

{ "error": { "code": "trade:orderNotCancelable", "message": "order is already completed" }, "reqId": "d3b9f1a2-7e4c-4b1a-9f3e-2a1b3c4d5e6f", "status": "rejected", "type": "cancel_order_response" }

{ "error": { "code": "common:invalidArgument", "field": "id", "message": "required" }, "reqId": "c2a8e4f0-9b1d-4e7a-8c3f-1e2d3f4a5b6c", "status": "rejected", "type": "cancel_order_response" }