关闭订单

更新时间:2025.01.16

未支付状态的订单,可在无需支付时调用此接口关闭订单。常见关单情况包括:

  • 用户在服务商系统提交取消订单请求,服务商需执行关单操作。

  • 订单超时未支付(超出服务商系统设定的可支付时间或下单时的time_expire支付截止时间),服务商需进行关单处理。

接口说明

支持商户:【普通服务商】【平台商户】

请求方式:【POST】/v3/pay/partner/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 包体参数

sp_mchid  必填 string(32)

【服务商商户号】服务商下单时传入的服务商商户号sp_mchid。


sub_mchid  必填 string(32)

【子商户号(也叫特约商户号)】服务商下单时传入的子商户号sub_mchid。

请求示例

Java
Go
curl

需配合微信支付工具库 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/partner/4014985777
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 PartnerCloseOrder {
24  private static String HOST = "https://api.mch.weixin.qq.com";
25  private static String METHOD = "POST";
26  private static String PATH = "/v3/pay/partner/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/partner/4013080340
30    PartnerCloseOrder client = new PartnerCloseOrder(
31        "填入 商户号",                  // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考https://pay.weixin.qq.com/doc/v3/partner/4013080340
32        "填入 商户API证书序列号",       // 商户API证书序列号,如何获取请参考https://pay.weixin.qq.com/doc/v3/partner/4013058924
33        "填入 商户API证书私钥文件路径", // 商户API证书私钥文件路径,本地文件路径
34        "填入 微信支付公钥ID",          // 微信支付公钥ID,如何获取请参考https://pay.weixin.qq.com/doc/v3/partner/4013038589
35        "填入 微信支付公钥文件路径"     // 微信支付公钥文件路径,本地文件路径
36    );
37
38    PartnerCloseOrderRequest request = new PartnerCloseOrderRequest();
39    request.outTradeNo = "1217752501201407033233368018";
40    request.spMchid = "1230000109";
41    request.subMchid = "1900000109";
42    try {
43      client.run(request);
44
45      // TODO: 请求成功,继续业务逻辑
46    } catch (WXPayUtility.ApiException e) {
47      // TODO: 请求失败,根据状态码执行不同的逻辑
48      e.printStackTrace();
49    }
50  }
51
52  public void run(PartnerCloseOrderRequest request) {
53    String uri = PATH;
54    uri = uri.replace("{out_trade_no}", WXPayUtility.urlEncode(request.outTradeNo));
55    String reqBody = WXPayUtility.toJson(request);
56
57    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
58    reqBuilder.addHeader("Accept", "application/json");
59    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
60    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, reqBody));
61    reqBuilder.addHeader("Content-Type", "application/json");
62    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
63    reqBuilder.method(METHOD, requestBody);
64    Request httpRequest = reqBuilder.build();
65
66    // 发送HTTP请求
67    OkHttpClient client = new OkHttpClient.Builder().build();
68    try (Response httpResponse = client.newCall(httpRequest).execute()) {
69      String respBody = WXPayUtility.extractBody(httpResponse);
70      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
71        // 2XX 成功,验证应答签名
72        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
73                                      httpResponse.headers(), respBody);
74
75        return;
76      } else {
77        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
78      }
79    } catch (IOException e) {
80      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
81    }
82  }
83
84  private final String mchid;
85  private final String certificateSerialNo;
86  private final PrivateKey privateKey;
87  private final String wechatPayPublicKeyId;
88  private final PublicKey wechatPayPublicKey;
89
90  public PartnerCloseOrder(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
91    this.mchid = mchid;
92    this.certificateSerialNo = certificateSerialNo;
93    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
94    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
95    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
96  }
97
98  public static class PartnerCloseOrderRequest {
99    @SerializedName("sp_mchid")
100    public String spMchid;
101
102    @SerializedName("sub_mchid")
103    public String subMchid;
104
105    @SerializedName("out_trade_no")
106    @Expose(serialize = false)
107    public String outTradeNo;
108  }
109}

应答参数

204 No Content

无应答包体

应答示例

204 No Content

1'无应答包体'

 

错误码

公共错误码

状态码

错误码

描述

解决方案

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

系统错误

系统异常,请用相同参数重新调用

 

 

反馈
咨询
目录
置顶