# 关闭订单

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:closeB2bOrder

仅当订单处于待支付状态(ORDER_PRE_PAY)时,可以调用本接口主动关闭订单。对于合单支付的订单,任一子单关单会使同主单下的所有子单都被关闭。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/retail/B2b/closeb2border?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用。

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:158

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
mchidstring微信商户号。长度限制[1,32]。由微信支付生成并下发的商户号。 示例值:1230000109
out_trade_nostring商户订单号。长度限制[6,32]。原支付交易对应的商户订单号。商户订单号和B2b支付订单号必填其一 示例值:1217752501201407033233368018
order_idstringB2b支付订单号。长度限制[1,32]。原支付交易对应的B2b支付订单号。商户订单号和B2b支付订单号必填其一 示例值:o202307291423123564754773

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息

# 4. 注意事项

关闭订单为异步操作,可通过查询订单获取状态。

# 5. 代码示例

请求示例

{
  "mchid": "1230000109",
  "out_trade_no": "1217752501201407033233368018"
}{
  "mchid": "1230000109",
  "order_id": "o202307291423123564754773"
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
10004关单失败通过调用查询订单api确认订单最新状态
10711订单状态无法调用关单,请刷新查看订单状态或稍后重试通过调用查询订单api确认订单最新状态
9403203商户未完成建档 detail:[获取商户号信息失败,请确认商户号是否开通成功]

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。