关于API将优化撤单失败错误码的公告

尊敬的用户:

为提升API使用体验,火币Global将优化撤销订单失败返回的错误码信息。

生效日期:2019年9月19日(GMT+8)
具体变更细节及参数要求,请参考【API文档】

火币全球站
2019年9月24日

 

以下为变更细节:
当前,
如API用户通过REST节点POST /v1/order/orders/{order-id}/submitcancel撤单失败,会返回如下错误信息 –
{
  "status": "error",
  "err-code": "order-orderstate-error",
  "err-msg": "订单状态错误"
}

如API用户通过REST节点POST /v1/order/orders/batchcancel撤单失败,会返回如下错误信息 –
{
  "status": "ok",
  "data": {
    "success": ["123","456"],
    "failed": [
       {
        "err-msg": "订单状态错误",
        "order-id": "12345678",
        "err-code": "order-orderstate-error"
      }
    ]
  }
}

自本通知生效日期起,

如API用户通过REST节点POST /v1/order/orders/{order-id}/submitcancel撤单失败,将返回如下错误信息 –
{
  "status": "error",
  "err-code": "order-orderstate-error",
  "err-msg": "订单状态错误",
  "order-state":-1 // 当前订单状态
}

如API用户通过REST节点POST /v1/order/orders/batchcancel撤单失败,将返回如下错误信息 –
{
  "status": "ok",
  "data": {
    "success": ["123","456"],
    "failed": [
      {
        "err-msg": "订单状态错误",
        "order-id": "12345678",
        "err-code": "order-orderstate-error",
        "order-state":-1 // 当前订单状态
      }
    ]
  }
}

新增字段order-state仅在撤单失败时返回。

新增字段order-state的可能取值为 –
-1 order was already closed in the long past (order state = canceled, partial-canceled, filled, partial-filled)
0 order-id not found
5 partial-canceled
6 filled
7 canceled
10 cancelling