撤單響應
接口信息
接口: POST /api/v1/orders/cancel-result
描述: 當Maker請求取消已鎖定的訂單時,Taker通過此接口返回取消處理結果
鑑權: API Key憑據認證
使用場景
當Taker通過WebSocket收到cancellation_request消息時,需要:
- 檢查訂單是否可以取消(是否已開始交易流程)
- 如果可以取消,執行取消操作(解鎖訂單)
- 調用此接口通知系統取消結果
請求參數
| 字段 | 類型 | 必填 | 說明 |
|---|---|---|---|
| order_hash | string | 是 | 訂單哈希值 |
| taker_address | string | 是 | Taker地址 |
| cancellation_success | boolean | 是 | 取消是否成功 |
| message | string | 是 | 處理結果消息 |
響應參數
| 字段 | 類型 | 說明 |
|---|---|---|
| success | boolean | 接口調用是否成功 |
| message | string | 響應消息 |
| order_hash | string | 訂單哈希值 |
請求示例
取消成功
bash
curl -X POST "/api/v1/orders/cancel-result" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"order_hash": "0x1234567890abcdef...",
"taker_address": "0xabcdef1234567890...",
"cancellation_success": true,
"message": "Order cancelled successfully"
}'取消失敗
bash
curl -X POST "/api/v1/orders/cancel-result" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"order_hash": "0x1234567890abcdef...",
"taker_address": "0xabcdef1234567890...",
"cancellation_success": false,
"message": "Order already in trading process, cannot cancel"
}'響應示例
json
{
"code": 0,
"data": {
"success": true,
"message": "Cancellation result recorded",
"order_hash": "0x1234567890abcdef..."
}
}注意事項
- 此接口必須在收到
cancellation_requestWebSocket消息後調用 - 如果取消成功(cancellation_success=true),訂單將被解鎖並更新為cancelled或expired狀態
- 如果取消失敗(cancellation_success=false),訂單保持locked狀態,Taker應繼續完成交易
- 建議在收到取消請求後盡快響應,避免超時