撤單

此端點允許用戶通過提供系統產生的 order_no 或客戶自訂的 reference_id 來撤銷待成交或部分成交的訂單。如果同時提供，系統將優先使用 order_no。提供兩種撤單方式：

1. 單一加密貨幣撤單：單一加密貨幣的撤單
2. 批量加密貨幣撤單：批量加密貨幣的撤單（最多同時 5 筆加密貨幣訂單）

---

單一加密貨幣撤單

HTTP 請求

DELETE /trade/v1/orders

請求參數

參數名稱	類型	是否必填	說明
order_no	STRING	否	系統產生的內部訂單編號
reference_id	STRING	否	客戶自訂的訂單ID或識別碼

cURL 請求範例

curl --location --request DELETE '{$base_url}/trade/v1/orders' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'X-API-Signature: YOUR_GENERATED_SIGNATURE' \
--header 'X-API-Timestamp: 1746774142003' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_no": "22000000022"
    "reference_id": ""
}'

成功回應範例

{
	"code": 0
}

錯誤回應範例

{
	"code": 030202,
	"message": "Invalid Parameter",
	"details": "order_no or reference_id is invalid"
}

可能的錯誤碼詳情請參見 錯誤碼參考。

---

批量加密貨幣撤單

HTTP 請求

DELETE /trade/v1/orders/batch

請求參數

參數名稱	類型	是否必填	說明
order_no	STRING	否	系統產生的內部訂單編號
reference_id	STRING	否	客戶自訂的訂單ID或識別碼

cURL 請求範例

curl --location --request DELETE '{$base_url}/trade/v1/orders/batch' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'X-API-Signature: YOUR_GENERATED_SIGNATURE' \
--header 'X-API-Timestamp: 1746774142003' \
--header 'Content-Type: application/json' \
--data-raw '[{
    "order_no": "22000000022"
    "reference_id": ""
},{
    "order_no": "22000000023"
    "reference_id": ""
},{
    "order_no": "22000000024"
    "reference_id": ""
}]'

成功回應範例

{
    "code": 0,
    "data": [
        {
            "order_no": "22000000022",
            "result": {
                "code": 0,
            }
        },
        {
            "order_no": "22000000023",
            "result": {
                "code": 0,
            }
        },
        {
            "order_no": "22000000024",
            "result": {
                "code": 11030204,
                "message": "Order Limit"
            }
        }
    ]
}

錯誤回應範例

{
	"code": 030202,
	"message": "Invalid Parameter",
	"details": "order_no or reference_id is invalid"
}

---

WebSocket 回調 - 撤單通知

如需接收訂單狀態通知，請使用WebSocket 連線。這可讓您的系統即時獲取訂單提交、部分成交、全部成交、撤單或拒單等狀態變化。

訂單狀態 WebSocket 端點

如需訂閱訂單狀態更新，請連接以下 WebSocket 端點：

wss://{{base_url}}/ws/trade/v1

連線並通過認證後，伺服器會即時推送您有效訂單的狀態更新。

---

WebSocket 訊息欄位

欄位名稱	類型	說明
market	ENUM	市場代碼（如 hkex、nasdaq）
order_type	ENUM	訂單類型（如限價單、增強限價單等）
symbol	STRING	股票代碼
name	STRING	股票名稱
order_side	ENUM	買賣方向：buy 或 sell
account_code	STRING	交易帳戶 ID
order_no	STRING	系統產生的訂單編號
order_status	ENUM	訂單狀態，撤單後為 can
price	DECIMAL	下單價格
qty	DECIMAL	原始下單數量
reference_id	STRING	客戶自訂識別碼
portfolio_id	STRING	投資組合 ID（用戶自訂外部 ID，可區分不同投資組合的訂單）
update_time	LONG	最後更新時間戳（UNIX 秒）
create_time	LONG	訂單建立時間戳

---

WebSocket 回調範例

{
	"type": "order",
	"data": {
		"market": "hkex",
		"order_type": "enhanced_limit_order",
		"symbol": "00700",
		"name": "TENCENT",
		"order_side": "buy",
		"account_code": "80114138",
		"order_no": "22000000022",
		"order_status": "can",
		"price": 423.83,
		"qty": 1000,
		"outstand_qty": 0,
		"execute_qty": 0,
		"execute_amount": 0,
		"charge": 0,
		"charge_base_currency": "HKD",
		"base_currency": "HKD",
		"reference_id": "",
		"portfolio_id": "",
		"reject_reason": "",
		"update_time": 1746775317,
		"create_time": 1746775257
	}
}