关闭合单订单
更新时间:2025.01.16未支付状态的订单,服务商(合单发起方)可在无需支付时调用此接口关闭订单。常见关单情况包括:
用户在商户系统提交取消订单请求,商户需执行关单操作。
订单超时未支付(超出商户系统设定的可支付时间或下单时的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
需配合微信支付工具库 WXPayUtility 使用,请参考 iwiki-document:inline_state
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 合单关单 24 */ 25public class UnionClose { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/combine-transactions/out-trade-no/{combine_out_trade_no}/close"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 UnionClose client = new UnionClose( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 UnionCloseRequest request = new UnionCloseRequest(); 41 request.combineOutTradeNo = "1217752501201407033233368018"; 42 request.combineAppid = "wxd678efh567hg6787"; 43 request.subOrders = new ArrayList<>(); 44 { 45 UnionCloseSubOrder subOrdersItem = new UnionCloseSubOrder(); 46 subOrdersItem.mchid = "1900000109"; 47 subOrdersItem.outTradeNo = "20150806125346"; 48 subOrdersItem.subMchid = "1230000109"; 49 subOrdersItem.subAppid = "wxd678efh567hg6999"; 50 request.subOrders.add(subOrdersItem); 51 }; 52 try { 53 client.run(request); 54 } catch (WXPayUtility.ApiException e) { 55 // TODO: 请求失败,根据状态码执行不同的逻辑 56 e.printStackTrace(); 57 } 58 } 59 60 public void run(UnionCloseRequest request) { 61 String uri = PATH; 62 uri = uri.replace("{combine_out_trade_no}", WXPayUtility.urlEncode(request.combineOutTradeNo)); 63 String reqBody = WXPayUtility.toJson(request); 64 65 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 66 reqBuilder.addHeader("Accept", "application/json"); 67 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 68 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 69 reqBuilder.addHeader("Content-Type", "application/json"); 70 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 71 reqBuilder.method(METHOD, requestBody); 72 Request httpRequest = reqBuilder.build(); 73 74 // 发送HTTP请求 75 OkHttpClient client = new OkHttpClient.Builder().build(); 76 try (Response httpResponse = client.newCall(httpRequest).execute()) { 77 String respBody = WXPayUtility.extractBody(httpResponse); 78 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 79 // 2XX 成功,验证应答签名 80 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 81 httpResponse.headers(), respBody); 82 83 return; 84 } else { 85 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 86 } 87 } catch (IOException e) { 88 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 89 } 90 } 91 92 private final String mchid; 93 private final String certificateSerialNo; 94 private final PrivateKey privateKey; 95 private final String wechatPayPublicKeyId; 96 private final PublicKey wechatPayPublicKey; 97 98 public UnionClose(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 99 this.mchid = mchid; 100 this.certificateSerialNo = certificateSerialNo; 101 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 102 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 103 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 104 } 105 106 public static class UnionCloseRequest { 107 @SerializedName("combine_appid") 108 public String combineAppid; 109 110 @SerializedName("combine_out_trade_no") 111 @Expose(serialize = false) 112 public String combineOutTradeNo; 113 114 @SerializedName("sub_orders") 115 public List<UnionCloseSubOrder> subOrders = new ArrayList<UnionCloseSubOrder>(); 116 } 117 118 public static class UnionCloseSubOrder { 119 @SerializedName("mchid") 120 public String mchid; 121 122 @SerializedName("out_trade_no") 123 public String outTradeNo; 124 125 @SerializedName("sub_mchid") 126 public String subMchid; 127 128 @SerializedName("sub_appid") 129 public String subAppid; 130 } 131 132} 133
需配合微信支付工具库 wxpay_utility 使用,请参考 iwiki-document:inline_state
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10 "strings" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 15 config, err := wxpay_utility.CreateMchConfig( 16 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 17 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 18 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &UnionCloseRequest{ 28 CombineOutTradeNo: wxpay_utility.String("1217752501201407033233368018"), 29 CombineAppid: wxpay_utility.String("wxd678efh567hg6787"), 30 SubOrders: []UnionCloseSubOrder{UnionCloseSubOrder{ 31 Mchid: wxpay_utility.String("1900000109"), 32 OutTradeNo: wxpay_utility.String("20150806125346"), 33 SubMchid: wxpay_utility.String("1230000109"), 34 SubAppid: wxpay_utility.String("wxd678efh567hg6999"), 35 }}, 36 } 37 38 err = UnionClose(config, request) 39 if err != nil { 40 fmt.Printf("请求失败: %+v\n", err) 41 // TODO: 请求失败,根据状态码执行不同的处理 42 return 43 } 44 45 // TODO: 请求成功,继续业务逻辑 46 fmt.Println("请求成功") 47} 48 49func UnionClose(config *wxpay_utility.MchConfig, request *UnionCloseRequest) (err error) { 50 const ( 51 host = "https://api.mch.weixin.qq.com" 52 method = "POST" 53 path = "/v3/combine-transactions/out-trade-no/{combine_out_trade_no}/close" 54 ) 55 56 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 57 if err != nil { 58 return err 59 } 60 reqUrl.Path = strings.Replace(reqUrl.Path, "{combine_out_trade_no}", url.PathEscape(*request.CombineOutTradeNo), -1) 61 reqBody, err := json.Marshal(request) 62 if err != nil { 63 return err 64 } 65 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 66 if err != nil { 67 return err 68 } 69 httpRequest.Header.Set("Accept", "application/json") 70 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 71 httpRequest.Header.Set("Content-Type", "application/json") 72 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 73 if err != nil { 74 return err 75 } 76 httpRequest.Header.Set("Authorization", authorization) 77 78 client := &http.Client{} 79 httpResponse, err := client.Do(httpRequest) 80 if err != nil { 81 return err 82 } 83 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 84 if err != nil { 85 return err 86 } 87 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 88 // 2XX 成功,验证应答签名 89 err = wxpay_utility.ValidateResponse( 90 config.WechatPayPublicKeyId(), 91 config.WechatPayPublicKey(), 92 &httpResponse.Header, 93 respBody, 94 ) 95 if err != nil { 96 return err 97 } 98 return nil 99 } else { 100 return wxpay_utility.NewApiException( 101 httpResponse.StatusCode, 102 httpResponse.Header, 103 respBody, 104 ) 105 } 106} 107 108type UnionCloseRequest struct { 109 CombineAppid *string `json:"combine_appid,omitempty"` 110 CombineOutTradeNo *string `json:"combine_out_trade_no,omitempty"` 111 SubOrders []UnionCloseSubOrder `json:"sub_orders,omitempty"` 112} 113 114func (o *UnionCloseRequest) MarshalJSON() ([]byte, error) { 115 type Alias UnionCloseRequest 116 a := &struct { 117 CombineOutTradeNo *string `json:"combine_out_trade_no,omitempty"` 118 *Alias 119 }{ 120 // 序列化时移除非 Body 字段 121 CombineOutTradeNo: nil, 122 Alias: (*Alias)(o), 123 } 124 return json.Marshal(a) 125} 126 127type UnionCloseSubOrder struct { 128 Mchid *string `json:"mchid,omitempty"` 129 OutTradeNo *string `json:"out_trade_no,omitempty"` 130 SubMchid *string `json:"sub_mchid,omitempty"` 131 SubAppid *string `json:"sub_appid,omitempty"` 132} 133
应答参数
204 No Content
无应答包体
应答示例
204 No Content
1'无应答包体' 2
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
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 | 系统错误 | 系统异常,请用相同参数重新调用 |