关闭订单
更新时间:2025.01.07以下情况需要调用关单接口:商户订单支付失败需要生成新单号重新发起支付,要对原订单号调用关单,避免重复支付;系统下单后,用户支付超时,系统退出不再受理,避免用户继续,请调用关单接口。
|
1. 接口说明
适用对象:直连模式机构模式
请求URL:https://apihk.mch.weixin.qq.com/v3/global/transactions/id/{transaction_id}/close
或
https://apihk.mch.weixin.qq.com/v3/global/transactions/out-trade-no/{out_trade_no}/close
请求方式: POST
Path 指该参数为路径参数
Query 指该参数为URL参数
Body 指该参数需在请求JSON传参
2. 请求参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
微信支付订单号 | transaction_id | string[1,32] | 二选一 | Path 微信支付订单号 |
商户订单号 | out_trade_no | string[1,32] | Path 商户订单号 | |
商户号 | mchid | string[1,32] | 是 | Body 微信支付分配的商户号 |
子商户号 | sub_mchid | string[1,32] | 是 | Body 微信支付分配的子商户号 |
机构商户号 | sp_mchid | string[1,32] | 是 | Body 微信支付分配的机构商户号 |
请求示例
JSON
3. 返回参数
正常返回
无数据(HTTP状态码为204)
异常返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 | |||
---|---|---|---|---|---|---|---|
返回状态码 | code | string[1, 32] | 是 | 错误码,枚举值见错误码列表 | |||
返回信息 | message | string[1, 256] | 是 | 返回信息,如非空,为错误原因 | |||
详细的错误描述 | detail | object | 否 | 当code为PARAM_ERROR时返回,详细说明见下 | |||
|
返回示例
异常示例
4. 错误码
错误码 | 描述 | 解决方案 |
---|---|---|
ORDERPAID | 订单已支付 | 订单已支付,不能发起关单,请当作已支付的正常交易 |
SYSTEM_ERROR | 系统错误 | 系统异常,请重新调用该API |
ORDER_CLOSED | 订单已关闭 | 订单已关闭,无需继续调用 |
REQUIRE_POST_METHOD | 请使用post方法 | 请检查请求参数是否通过post方法提交 |