关闭订单
更新时间:2024.11.25未支付状态的订单,可在无需支付时调用此接口关闭订单。常见关单情况包括:
用户在商户系统提交取消订单请求,商户需执行关单操作。
订单超时未支付(超出商户系统设定的可支付时间或下单时的time_expire支付截止时间),商户需进行关单处理。
接口说明
支持商户:【普通商户】
请求方式:【POST】/v3/pay/transactions/out-trade-no/{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 路径参数
out_trade_no 必填 string(32)
【商户订单号】 商户下单时传入的商户系统内部订单号。
body 包体参数
mchid 必填 string(32)
【商户号】商户下单时传入的商户号。
请求示例
需配合微信支付工具库 WXPayUtility 使用,请参考 Java
1package com.java.demo; 2 3import com.google.gson.annotations.Expose; 4import com.google.gson.annotations.SerializedName; 5import com.java.utils.WXPayUtility; // 引用微信支付工具库 参考:https://pay.weixin.qq.com/doc/v3/merchant/4014931831 6import java.io.IOException; 7import java.io.UncheckedIOException; 8import java.security.PrivateKey; 9import java.security.PublicKey; 10import java.util.ArrayList; 11import java.util.HashMap; 12import java.util.List; 13import java.util.Map; 14import okhttp3.MediaType; 15import okhttp3.OkHttpClient; 16import okhttp3.Request; 17import okhttp3.RequestBody; 18import okhttp3.Response; 19 20/** 21 * 关闭订单 22 */ 23public class Order { 24 private static String HOST = "https://api.mch.weixin.qq.com"; 25 private static String METHOD = "POST"; 26 private static String PATH = "/v3/pay/transactions/out-trade-no/{out_trade_no}/close"; 27 28 public static void main(String[] args) { 29 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 30 Order client = new Order( 31 "填入 商户号", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/merchant/4013070756 32 "填入 商户API证书序列号", // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013053053 33 "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径 34 "填入 微信支付公钥ID", // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013038816 35 "填入 微信支付公钥文件路径" // 微信支付公钥文件路径,本地文件路径 36 ); 37 38 OrderRequest request = new OrderRequest(); 39 request.outTradeNo = "1217752501201407033233368018"; 40 request.mchid = "1230000109"; 41 try { 42 client.run(request); 43 44 // TODO: 请求成功,继续业务逻辑 45 } catch (WXPayUtility.ApiException e) { 46 // TODO: 请求失败,根据状态码执行不同的逻辑 47 e.printStackTrace(); 48 } 49 } 50 51 public void run(OrderRequest request) { 52 String uri = PATH; 53 uri = uri.replace("{out_trade_no}", WXPayUtility.urlEncode(request.outTradeNo)); 54 String reqBody = WXPayUtility.toJson(request); 55 56 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 57 reqBuilder.addHeader("Accept", "application/json"); 58 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 59 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, reqBody)); 60 reqBuilder.addHeader("Content-Type", "application/json"); 61 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 62 reqBuilder.method(METHOD, requestBody); 63 Request httpRequest = reqBuilder.build(); 64 65 // 发送HTTP请求 66 OkHttpClient client = new OkHttpClient.Builder().build(); 67 try (Response httpResponse = client.newCall(httpRequest).execute()) { 68 String respBody = WXPayUtility.extractBody(httpResponse); 69 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 70 // 2XX 成功,验证应答签名 71 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 72 httpResponse.headers(), respBody); 73 74 return; 75 } else { 76 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 77 } 78 } catch (IOException e) { 79 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 80 } 81 } 82 83 private final String mchid; 84 private final String certificateSerialNo; 85 private final PrivateKey privateKey; 86 private final String wechatPayPublicKeyId; 87 private final PublicKey wechatPayPublicKey; 88 89 public Order(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 90 this.mchid = mchid; 91 this.certificateSerialNo = certificateSerialNo; 92 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 93 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 94 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 95 } 96 97 public static class OrderRequest { 98 @SerializedName("mchid") 99 public String mchid; 100 101 @SerializedName("out_trade_no") 102 @Expose(serialize = false) 103 public String outTradeNo; 104 } 105}
需配合微信支付工具库 wxpay_utility 使用,请参考 Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility"// 引用微信支付工具库 参考:https://pay.weixin.qq.com/doc/v3/merchant/4015119334 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/merchant/4013070756 15 config, err := wxpay_utility.CreateMchConfig( 16 "填入 商户号", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/merchant/4013070756 17 "填入 商户API证书序列号", // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013053053 18 "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径 19 "填入 微信支付公钥ID", // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/merchant/4013038816 20 "填入 微信支付公钥文件路径", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &OrderRequest{ 28 OutTradeNo: wxpay_utility.String("1217752501201407033233368018"), 29 Mchid: wxpay_utility.String("1230000109"), 30 } 31 32 err = Order(config, request) 33 if err != nil { 34 fmt.Printf("请求失败: %+v\n", err) 35 // TODO: 请求失败,根据状态码执行不同的处理 36 return 37 } 38 39 // TODO: 请求成功,继续业务逻辑 40 fmt.Println("请求成功") 41} 42 43func Order(config *wxpay_utility.MchConfig, request *OrderRequest) (err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "POST" 47 path = "/v3/pay/transactions/out-trade-no/{out_trade_no}/close" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return err 53 } 54 reqUrl.Path = strings.Replace(reqUrl.Path, "{out_trade_no}", url.PathEscape(*request.OutTradeNo), -1) 55 reqBody, err := json.Marshal(request) 56 if err != nil { 57 return err 58 } 59 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 60 if err != nil { 61 return err 62 } 63 httpRequest.Header.Set("Accept", "application/json") 64 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 65 httpRequest.Header.Set("Content-Type", "application/json") 66 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.Path, reqBody) 67 if err != nil { 68 return err 69 } 70 httpRequest.Header.Set("Authorization", authorization) 71 72 client := &http.Client{} 73 httpResponse, err := client.Do(httpRequest) 74 if err != nil { 75 return err 76 } 77 78 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 79 if err != nil { 80 return err 81 } 82 83 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 84 // 2XX 成功,验证应答签名 85 err = wxpay_utility.ValidateResponse( 86 config.WechatPayPublicKeyId(), 87 config.WechatPayPublicKey(), 88 &httpResponse.Header, 89 respBody, 90 ) 91 if err != nil { 92 return err 93 } 94 95 return nil 96 } else { 97 return &wxpay_utility.ApiException{ 98 StatusCode: httpResponse.StatusCode, 99 Header: httpResponse.Header, 100 Body: respBody, 101 } 102 } 103} 104 105type OrderRequest struct { 106 Mchid *string `json:"mchid,omitempty"` 107 OutTradeNo *string `json:"out_trade_no,omitempty"` 108} 109 110func (o *OrderRequest) MarshalJSON() ([]byte, error) { 111 type Alias OrderRequest 112 a := &struct { 113 OutTradeNo *string `json:"out_trade_no,omitempty"` 114 *Alias 115 }{ 116 // 序列化时移除非 Body 字段 117 OutTradeNo: nil, 118 Alias: (*Alias)(o), 119 } 120 return json.Marshal(a) 121}
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/pay/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 "mchid" : "1900000001" 8 }'
应答参数
204 No Content
无应答包体
应答示例
204 No Content
1'无应答包体' 2
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 无效请求 | 请根据接口返回的详细信息检查 |
400 | MCH_NOT_EXISTS | 商户号不存在 | 请检查商户号是否正确,商户号获取方式请参考普通商户模式开发必要参数说明 |
401 | SIGN_ERROR | 签名错误 | 请检查签名参数和方法是否都符合签名算法要求,参考:如何生成签名 |
403 | RULE_LIMIT | 业务规则限制 | 因业务规则限制请求频率,请查看接口返回的详细信息 |
403 | TRADE_ERROR | 交易错误 | 因业务原因交易失败,请查看接口返回的详细信息 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请用相同参数重新调用 |