本文目录接口请求体请求头请求示例响应示例取消规则错误码

取消订单 ​

取消尚未支付的支付订单。此接口使用请求头 HMAC 签名。

接口 ​

POST /v4.0.0/api/orders/cancel

请求体 ​

字段类型必填说明
payOrderIdstring是HashNut 订单 ID

请求头 ​

参见身份认证了解所需的 HMAC 签名请求头:

  • hashnut-request-uuid
  • hashnut-request-timestamp
  • hashnut-request-sign

请求示例 ​

json
{
  "payOrderId" : "01KWCGJ443GX4SCBQK53CTF04A"
}

响应示例 ​

json
{
  "code" : 0,
  "msg" : "success",
  "ui" : null,
  "version" : null,
  "count" : 0,
  "data" : null
}

取消规则 ​

  • 只有处于 INIT (0) 状态的订单可以被取消。
  • 已收到支付的订单(PAID、CONFIRMING、SUCCESS 等)无法取消。
  • 取消后订单状态变为 CANCELED (-3)。
  • 取消操作不可逆。

WARNING

订单取消后,其分配的收款地址将释放回地址池。如果客户在取消后仍向该地址转账,付款可能会被归属到其他订单或无法被检测到。请确保您的前端在取消后立即移除支付地址的展示。

错误码 ​

错误码说明
0成功
1001参数无效
1002认证失败
2001订单未找到
2002订单不在 INIT 状态(无法取消)