Cancel Order by Client ID

You must be authenticated and subscribed to the TRADING channel in order to send trading messages.

Submits a request to cancel an open order by providing a valid client_id.

Note

If you have created multiple orders with the same client_id, only the most recent will be cancelled with this request. It is your responsibility to ensure uniqueness in your client_ids.

Cancel Order by Client ID Request

{
    "type": "CANCEL_ORDER",
    "client_id": "8fd80590-4679-4e7d-9ef9-4346dadb5c8f"
 }

CancelOrderClientIdRequest

type

enum<string>

required

Allowed value:

CANCEL_ORDER

client_id

string <uuid>

required

Unique client id of the order to cancel

Cancel Order by Client ID Response

Error

Order not found

{
    "error": "ORDER_NOT_FOUND",
    "client_id": "8fd80590-4679-4e7d-9ef9-4346dadb5c8f"
}

Invalid Client ID

{
    "error": "CLIENT_ID_ERROR",
    "payload": {
        "type": "CANCEL_ORDER",
        "client_id": "not valid"
    }
}

Success

If a cancel order by client ID request is valid, you will receive an Order Closed notification.

Cancel Order by Client ID Request#

Cancel Order by Client ID Response#

Error#

Order not found#

Invalid Client ID#

Success#

Cancel Order by Client ID Request

Cancel Order by Client ID Response

Error

Order not found

Invalid Client ID

Success