跳到主要内容

WS 撤单

WS 撤单

通过私有 WebSocket 连接撤销订单。单次最多 50 笔。

前置条件

在发送交易请求前,必须先获取有效的 listenKey 并建立私有 WebSocket 连接。

请求格式

{"action":"batch-cancel-orders","param":{"id":"1004","args":[{...},{...}]}}
字段必填类型描述
actionstring固定为 "batch-cancel-orders"
paramobject批量撤单参数
param.idstring客户端请求 ID
param.argsarray撤单参数数组,1~50 个对象

args[N] 对象字段

字段名必填类型描述
ordIdstring订单 ID

请求示例

{
"action": "batch-cancel-orders",
"param": {
"id": "1004",
"args": [
{"ordId": "1000587865918838"},
{"ordId": "1000587865914949"}
]
}
}

响应格式

{"id":"1004","action":"batch-cancel-orders","code":"0","msg":"","data":[{"ordId":"1000587865918838","sCode":"0","sMsg":""},{"ordId":"","sCode":"50012","sMsg":"cancel failed: OrderNotFound"}]}

响应参数

字段名类型描述
idstring对应请求 ID
actionstring固定为 "batch-cancel-orders"
codestring处理结果码,"0" 表示已处理
msgstring处理结果说明
dataarray每笔结果,顺序与 args 一致
data[].ordIdstring订单 ID,失败时为空
data[].sCodestring单笔结果码,"0" 表示成功
data[].sMsgstring单笔结果说明

处理规则

场景错误码错误信息
全部撤单成功0
param 非合法 JSON50018Invalid request json
args 为空或超过 50 个50005args length must be between 1 and 50
单笔:字段解析失败50003Invalid arg(单笔 sCode)
单笔:缺少 ordId50003ordId is required(单笔 sCode)
单笔:撤单失败50012cancel failed(单笔 sCode)