发起异常退款

更新时间：2024.12.30

提交退款申请后，退款结果通知或查询退款确认状态为退款异常，可调用此接口发起异常退款处理。支持退款至用户、退款至交易商户银行账户两种处理方式。

注意：

退款至用户时，仅支持以下银行的借记卡：招行、交通银行、农行、建行、工商、中行、平安、浦发、中信、光大、民生、兴业、广发、邮储、宁波银行。
请求频率限制：150qps，即每秒钟正常的申请退款请求次数不超过150次

接口说明

支持商户：【普通商户】

请求方式：【POST】/v3/refund/domestic/refunds/{refund_id}/apply-abnormal-refund

请求域名：【主域名】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 路径参数

refund_id 　必填 string(32)

【微信支付退款单号】申请退款受理成功时，该笔退款单在微信支付侧生成的唯一标识。申请退款成功后会返回该参数，查询退款或者退款结果通知也会返回该参数。

body 包体参数

out_refund_no 　必填 string(64)

【商户退款单号】商户申请退款时传入的商户系统内部退款单号。

type 　必填 string

【异常退款处理方式】可选：退款至用户银行卡、退款至交易商户银行账户

可选取值

USER_BANK_CARD: 退款到用户银行卡
MERCHANT_BANK_CARD: 退款至交易商户银行账户

bank_type 　选填 string(16)

【开户银行】银行类型，采用字符串类型的银行标识，值列表详见银行类型。仅支持招行、交通银行、农行、建行、工商、中行、平安、浦发、中信、光大、民生、兴业、广发、邮储、宁波银行的借记卡。
若退款至用户此字段必填。

bank_account 　选填 string(1024)

【收款银行卡号】用户的银行卡账号，该字段需要使用微信支付公钥加密（推荐），请参考获取微信支付公钥ID说明以及如何使用微信支付公钥加密敏感字段，也可以使用微信支付平台证书公钥加密，参考平台证书简介与使用说明、如何使用平台证书加密敏感字段
若退款至用户此字段必填。

real_name 　选填 string(1024)

【收款用户姓名】收款用户姓名，该字段需要使用微信支付公钥加密（推荐），请参考获取微信支付公钥ID说明以及如何使用微信支付公钥加密敏感字段，也可以使用微信支付平台证书公钥加密，参考平台证书简介与使用说明、如何使用平台证书加密敏感字段
若退款至用户此字段必填。

请求示例

需配合微信支付工具库 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 CreateAbnormalRefund {
24  private static String HOST = "https://api.mch.weixin.qq.com";
25  private static String METHOD = "POST";
26  private static String PATH = "/v3/refund/domestic/refunds/{refund_id}/apply-abnormal-refund";
27
28  public static void main(String[] args) {
29    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/merchant/4013070756
30    CreateAbnormalRefund client = new CreateAbnormalRefund(
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    CreateAbnormalRefundRequest request = new CreateAbnormalRefundRequest();
39    request.refundId = "50000000382019052709732678859";
40    request.outRefundNo = "1217752501201407033233368018";
41    request.type = AbnormalReceiveType.USER_BANK_CARD;
42    request.bankType = "ICBC_DEBIT";
43    request.bankAccount = client.encrypt("bank_account");
44    request.realName = client.encrypt("real_name");
45    try {
46      Refund response = client.run(request);
47
48      // TODO: 请求成功，继续业务逻辑
49      System.out.println(response);
50    } catch (WXPayUtility.ApiException e) {
51      // TODO: 请求失败，根据状态码执行不同的逻辑
52      e.printStackTrace();
53    }
54  }
55
56  public Refund run(CreateAbnormalRefundRequest request) {
57    String uri = PATH;
58    uri = uri.replace("{refund_id}", WXPayUtility.urlEncode(request.refundId));
59    String reqBody = WXPayUtility.toJson(request);
60
61    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
62    reqBuilder.addHeader("Accept", "application/json");
63    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
64    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, reqBody));
65    reqBuilder.addHeader("Content-Type", "application/json");
66    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
67    reqBuilder.method(METHOD, requestBody);
68    Request httpRequest = reqBuilder.build();
69
70    // 发送HTTP请求
71    OkHttpClient client = new OkHttpClient.Builder().build();
72    try (Response httpResponse = client.newCall(httpRequest).execute()) {
73      String respBody = WXPayUtility.extractBody(httpResponse);
74      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
75        // 2XX 成功，验证应答签名
76        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
77                                      httpResponse.headers(), respBody);
78
79        // 从HTTP应答报文构建返回数据
80        return WXPayUtility.fromJson(respBody, Refund.class);
81      } else {
82        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
83      }
84    } catch (IOException e) {
85      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
86    }
87  }
88
89  private final String mchid;
90  private final String certificateSerialNo;
91  private final PrivateKey privateKey;
92  private final String wechatPayPublicKeyId;
93  private final PublicKey wechatPayPublicKey;
94
95  public CreateAbnormalRefund(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
96    this.mchid = mchid;
97    this.certificateSerialNo = certificateSerialNo;
98    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
99    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
100    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
101  }
102
103  public String encrypt(String plainText) {
104    return WXPayUtility.encrypt(this.wechatPayPublicKey, plainText);
105  }
106
107  public enum Status {
108    @SerializedName("SUCCESS")
109    SUCCESS,
110    @SerializedName("CLOSED")
111    CLOSED,
112    @SerializedName("PROCESSING")
113    PROCESSING,
114    @SerializedName("ABNORMAL")
115    ABNORMAL
116  }
117
118  public enum Account {
119    @SerializedName("AVAILABLE")
120    AVAILABLE,
121    @SerializedName("UNAVAILABLE")
122    UNAVAILABLE
123  }
124
125  public enum PromotionType {
126    @SerializedName("COUPON")
127    COUPON,
128    @SerializedName("DISCOUNT")
129    DISCOUNT
130  }
131
132  public static class GoodsDetail {
133    @SerializedName("merchant_goods_id")
134    public String merchantGoodsId;
135
136    @SerializedName("wechatpay_goods_id")
137    public String wechatpayGoodsId;
138
139    @SerializedName("goods_name")
140    public String goodsName;
141
142    @SerializedName("unit_price")
143    public Long unitPrice;
144
145    @SerializedName("refund_amount")
146    public Long refundAmount;
147
148    @SerializedName("refund_quantity")
149    public Integer refundQuantity;
150  }
151
152  public enum Channel {
153    @SerializedName("ORIGINAL")
154    ORIGINAL,
155    @SerializedName("BALANCE")
156    BALANCE,
157    @SerializedName("OTHER_BALANCE")
158    OTHER_BALANCE,
159    @SerializedName("OTHER_BANKCARD")
160    OTHER_BANKCARD
161  }
162
163  public static class Amount {
164    @SerializedName("total")
165    public Long total;
166
167    @SerializedName("refund")
168    public Long refund;
169
170    @SerializedName("from")
171    public List<FundsFromItem> from;
172
173    @SerializedName("payer_total")
174    public Long payerTotal;
175
176    @SerializedName("payer_refund")
177    public Long payerRefund;
178
179    @SerializedName("settlement_refund")
180    public Long settlementRefund;
181
182    @SerializedName("settlement_total")
183    public Long settlementTotal;
184
185    @SerializedName("discount_refund")
186    public Long discountRefund;
187
188    @SerializedName("currency")
189    public String currency;
190
191    @SerializedName("refund_fee")
192    public Long refundFee;
193  }
194
195  public enum AbnormalReceiveType {
196    @SerializedName("USER_BANK_CARD")
197    USER_BANK_CARD,
198    @SerializedName("MERCHANT_BANK_CARD")
199    MERCHANT_BANK_CARD
200  }
201
202  public enum FundsAccount {
203    @SerializedName("UNSETTLED")
204    UNSETTLED,
205    @SerializedName("AVAILABLE")
206    AVAILABLE,
207    @SerializedName("UNAVAILABLE")
208    UNAVAILABLE,
209    @SerializedName("OPERATION")
210    OPERATION,
211    @SerializedName("BASIC")
212    BASIC,
213    @SerializedName("ECNY_BASIC")
214    ECNY_BASIC
215  }
216
217  public static class CreateAbnormalRefundRequest {
218    @SerializedName("refund_id")
219    @Expose(serialize = false)
220    public String refundId;
221
222    @SerializedName("out_refund_no")
223    public String outRefundNo;
224
225    @SerializedName("type")
226    public AbnormalReceiveType type;
227
228    @SerializedName("bank_type")
229    public String bankType;
230
231    @SerializedName("bank_account")
232    public String bankAccount;
233
234    @SerializedName("real_name")
235    public String realName;
236  }
237
238  public static class Promotion {
239    @SerializedName("promotion_id")
240    public String promotionId;
241
242    @SerializedName("scope")
243    public PromotionScope scope;
244
245    @SerializedName("type")
246    public PromotionType type;
247
248    @SerializedName("amount")
249    public Long amount;
250
251    @SerializedName("refund_amount")
252    public Long refundAmount;
253
254    @SerializedName("goods_detail")
255    public List<GoodsDetail> goodsDetail;
256  }
257
258  public static class Refund {
259    @SerializedName("refund_id")
260    public String refundId;
261
262    @SerializedName("out_refund_no")
263    public String outRefundNo;
264
265    @SerializedName("transaction_id")
266    public String transactionId;
267
268    @SerializedName("out_trade_no")
269    public String outTradeNo;
270
271    @SerializedName("channel")
272    public Channel channel;
273
274    @SerializedName("user_received_account")
275    public String userReceivedAccount;
276
277    @SerializedName("success_time")
278    public String successTime;
279
280    @SerializedName("create_time")
281    public String createTime;
282
283    @SerializedName("status")
284    public Status status;
285
286    @SerializedName("funds_account")
287    public FundsAccount fundsAccount;
288
289    @SerializedName("amount")
290    public Amount amount;
291
292    @SerializedName("promotion_detail")
293    public List<Promotion> promotionDetail;
294  }
295
296  public static class FundsFromItem {
297    @SerializedName("account")
298    public Account account;
299
300    @SerializedName("amount")
301    public Long amount;
302  }
303
304  public enum PromotionScope {
305    @SerializedName("GLOBAL")
306    GLOBAL,
307    @SerializedName("SINGLE")
308    SINGLE
309  }
310}

应答参数

200 OK

refund_id 　必填 string(32)

【微信支付退款单号】申请退款受理成功时，该笔退款单在微信支付侧生成的唯一标识。

out_refund_no 　必填 string(64)

【商户退款单号】商户申请退款时传入的商户系统内部退款单号。

transaction_id 　必填 string(32)

【微信支付订单号】微信支付侧订单的唯一标识。

out_trade_no 　必填 string(32)

【商户订单号】商户下单时传入的商户系统内部订单号。

channel 　必填 string

【退款渠道】退款渠道

ORIGINAL: 原路退款
BALANCE: 退回到余额
OTHER_BALANCE: 原账户异常退到其他余额账户
OTHER_BANKCARD: 原银行卡异常退到其他银行卡(发起异常退款成功后返回)

user_received_account 　必填 string(64)

【退款入账账户】取当前退款单的退款入账方，有以下几种情况：
1）退回银行卡：{银行名称}{卡类型}{卡尾号}
2）退回支付用户零钱:支付用户零钱
3）退还商户:商户基本账户商户结算银行账户
4）退回支付用户零钱通:支付用户零钱通
5）退回支付用户银行电子账户:支付用户银行电子账户
6）退回支付用户零花钱:支付用户零花钱
7）退回用户经营账户:用户经营账户
8）退回支付用户来华零钱包:支付用户来华零钱包
9）退回企业支付商户:企业支付商户

success_time 　选填 string(64)

【退款成功时间】

1、定义：退款成功的时间，该字段在退款状态status为SUCCESS（退款成功）时返回。

2、格式：遵循rfc3339标准格式：yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日；T 字符用于分隔日期和时间部分；HH:mm:ss 表示具体的时分秒；TIMEZONE 表示时区（例如，+08:00 对应东八区时间，即北京时间）。

示例：2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。

create_time 　必填 string(64)

【退款创建时间】

1、定义：提交退款申请成功，微信受理退款申请单的时间。

示例：2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。

status 　必填 string

【退款状态】退款单的退款处理状态。

SUCCESS: 退款成功
CLOSED: 退款关闭
PROCESSING: 退款处理中
ABNORMAL: 退款异常，退款到银行发现用户的卡作废或者冻结了，导致原路退款银行卡失败，可前往商户平台-交易中心，手动处理此笔退款，可参考：退款异常的处理，或者通过该接口处理。
注：状态流转说明请参考状态流转图

funds_account 　必填 string

【资金账户】退款所使用资金对应的资金账户类型

UNSETTLED: 未结算资金
AVAILABLE: 可用余额
UNAVAILABLE: 不可用余额
OPERATION: 运营账户
BASIC: 基本账户（含可用余额和不可用余额）
ECNY_BASIC: 数字人民币基本账户

amount 　必填 object

【金额信息】订单退款金额信息

属性

promotion_detail 　选填 array[object]

【优惠退款详情】订单各个代金券的退款详情，订单使用了代金券且代金券发生退款时返回。

属性

应答示例

200 OK

1{
2  "refund_id" : "50000000382019052709732678859",
3  "out_refund_no" : "1217752501201407033233368018",
4  "transaction_id" : "1217752501201407033233368018",
5  "out_trade_no" : "1217752501201407033233368018",
6  "channel" : "ORIGINAL",
7  "user_received_account" : "招商银行信用卡0403",
8  "success_time" : "2020-12-01T16:18:12+08:00",
9  "create_time" : "2020-12-01T16:18:12+08:00",
10  "status" : "SUCCESS",
11  "funds_account" : "UNSETTLED",
12  "amount" : {
13    "total" : 100,
14    "refund" : 100,
15    "from" : [
16      {
17        "account" : "AVAILABLE",
18        "amount" : 444
19      }
20    ],
21    "payer_total" : 90,
22    "payer_refund" : 90,
23    "settlement_refund" : 100,
24    "settlement_total" : 100,
25    "discount_refund" : 10,
26    "currency" : "CNY",
27    "refund_fee" : 100
28  },
29  "promotion_detail" : [
30    {
31      "promotion_id" : "109519",
32      "scope" : "GLOBAL",
33      "type" : "COUPON",
34      "amount" : 5,
35      "refund_amount" : 100,
36      "goods_detail" : [
37        {
38          "merchant_goods_id" : "1217752501201407033233368018",
39          "wechatpay_goods_id" : "1001",
40          "goods_name" : "iPhone6s 16G",
41          "unit_price" : 528800,
42          "refund_amount" : 528800,
43          "refund_quantity" : 1
44        }
45      ]
46    }
47  ]
48}

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
400	INVALID_REQUEST	HTTP 请求不符合微信支付 APIv3 接口规则	请参阅接口规则
401	SIGN_ERROR	验证不通过	请参阅签名常见问题
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
400	INVALID_REQUEST	请求参数符合参数格式，但不符合业务规则	此状态代表本次请求的退款申请失败，请根据具体的错误提示做相应处理。
401	SIGN_ERROR	签名错误	请检查签名参数和方法是否都符合签名算法要求，参考：如何生成签名
404	RESOURCE_NOT_EXISTS	退款单不存在	请检查退款单号是否有误
429	FREQUENCY_LIMITED	频率限制	该笔退款未受理，请降低频率后重试
500	SYSTEM_ERROR	系统超时等	请不要更换商户退款单号，请使用相同参数再次调用API。

文档是否有帮助

更多支持

开发文档(服务商)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服