GET

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.

Header Params

Authorization string required

Bearer token for authorization

Body Params

object

Client message to cancel an order on an established WebSocket connection.

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.

Responses

101

Switching Protocols. The server responds with WsCancelOrderResponse for each cancel_order message.

Response Body

Server response to a cancel_order message. Accepted responses confirm the cancel request was accepted; rejected responses contain a structured error. Confirm final cancellation on the orders channel or via Get Order.

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.

403

Forbidden - Insufficient permissions

Response Body

object

error string required
errorName string required
reqId string required

curl -X GET \ --url 'https://app.bitgo-test.com/api/prime/trading/v1/ws (cancel_order)' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Authorization: string' \ --header 'content-type: application/json' \ --data '{,"type":"cancel_order","reqId":"c2a8e4f0-9b1d-4e7a-8c3f-1e2d3f4a5b6c","accountId":"f230fdebfa084ffebc7e00515f54603f","orderId":"8a1f2e3d-4c5b-6a7e-8f9d-0a1b2c3d4e5f"}'

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/prime/trading/v1/ws (cancel_order)") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["Authorization"] = 'string' request["content-type"] = 'application/json' request.body = '{,"type":"cancel_order","reqId":"c2a8e4f0-9b1d-4e7a-8c3f-1e2d3f4a5b6c","accountId":"f230fdebfa084ffebc7e00515f54603f","orderId":"8a1f2e3d-4c5b-6a7e-8f9d-0a1b2c3d4e5f"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/prime/trading/v1/ws (cancel_order)', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'Authorization' => 'string', 'content-type' => 'application/json', ], 'body' => '{,"type":"cancel_order","reqId":"c2a8e4f0-9b1d-4e7a-8c3f-1e2d3f4a5b6c","accountId":"f230fdebfa084ffebc7e00515f54603f","orderId":"8a1f2e3d-4c5b-6a7e-8f9d-0a1b2c3d4e5f"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/prime/trading/v1/ws (cancel_order)" payload = {,"type":"cancel_order","reqId":"c2a8e4f0-9b1d-4e7a-8c3f-1e2d3f4a5b6c","accountId":"f230fdebfa084ffebc7e00515f54603f","orderId":"8a1f2e3d-4c5b-6a7e-8f9d-0a1b2c3d4e5f"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "Authorization": "string", "content-type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.text)

{ "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" }