未支付状态的订单,服务商(合单发起方)可在无需支付时调用此接口关闭订单。常见关单情况包括:
用户在商户系统提交取消订单请求,商户需执行关单操作。
订单超时未支付(超出商户系统设定的可支付时间或下单时的time_expire支付截止时间),商户需进行关单处理。
注意
此接口只能整单关闭,不支持关闭部分子单,关单的合单服务商商户号、合单商户订单号、子单个数、服务商商户号、子商户号、子单商户订单号必须与下单时传入的完全一致。
接口说明支持商户:【普通服务商】
请求方式:【POST】/v3/combine-transactions/out-trade-no/{combine_out_trade_no}/close
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
path 路径参数
combine_out_trade_no 必填 string(32)
【合单商户订单号】合单下单时传入的合单商户订单号。
body 包体参数
combine_appid 必填 string(32)
【合单服务商APPID】合单下单时传入的combine_appid。
sub_orders 必填 array[ReqCloseSubOrder]
【子单信息列表】合单下单时传入的子单信息列表。
属性 mchid 必填 string(32)
【服务商商户号】 合单下单时传入的服务商商户号。
out_trade_no 必填 string(32)
【子单商户订单号】合单下单时传入的子单商户订单号。
sub_mchid 必填 string(32)
【子商户号(也叫特约商户号)】 合单下单时传入的子商户号。
sub_appid 选填 string(32)
【子商户APPID】合单下单时传入子商户APPID。该sub_appid与sub_mchid有绑定关系。
请求示例
POST
1curl -X POST \
2 https://api.mch.weixin.qq.com/v3/combine-transactions/out-trade-no/1217752501201407033233368018/close \
3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4 -H "Accept: application/json" \
5 -H "Content-Type: application/json" \
6 -d '{
7 "combine_appid" : "wxd678efh567hg6787",
8 "sub_orders" : [
9 {
10 "mchid" : "1900000109",
11 "out_trade_no" : "20150806125346",
12 "sub_mchid" : "1230000109",
13 "sub_appid" : "wxd678efh567hg6999"
14 }
15 ]
16 }'
17应答参数204 No Content
无应答包体
应答示例
204 No Content
1'无应答包体'
错误码公共错误码状态码
错误码
描述
解决方案
400
PARAM_ERROR
参数错误
请根据错误提示正确传入参数
400
INVALID_REQUEST
HTTP 请求不符合微信支付 APIv3 接口规则
请参阅接口规则检查传入的参数
401
SIGN_ERROR
验证不通过
请参阅签名常见问题排查
500
SYSTEM_ERROR
系统异常,请稍后重试
请稍后重试
业务错误码状态码
错误码
描述
解决方案
400
APPID_MCHID_NOT_MATCH
AppID和mch_id不匹配
请确认AppID和mch_id是否匹配,参考:查询商户号绑定的APPID
400
INVALID_REQUEST
输入的请求非法,请求关单的子单信息与下单时的子单信息不一致
请检查关单传入的子单信息与下单时传入的子单信息或子单数量是否一致
400
INVALID_REQUEST
无效请求
请根据接口返回的详细信息检查
400
MCH_NOT_EXISTS
商户号不存在
请检查商户号是否正确,商户号获取方法参考:服务商模式开发必要参数说明
400
ORDER_CLOSED
订单已关闭
当前订单已关闭,请重新下单
401
SIGN_ERROR
签名错误
请检查签名参数和方法是否都符合签名算法要求,参考:如何生成签名
403
NOAUTH
商户无权限
请商户联系对接运营申请此接口相关权限,参考:权限申请
403
OUT_TRADE_NO_USED
商户订单号重复
请核实商户订单号是否重复提交
403
RULELIMIT
业务规则限制
因业务规则限制请求频率,请查看接口返回的详细信息
429
FREQUENCY_LIMITED
频率超限
请降低请求接口频率
500
SYSTEMERROR
系统错误
系统异常,请用相同参数重新调用