业务示例代码

1package com.tencent.pay.refund;
2
3import com.java.demo.Create;  // 使用商户平台申请退款接口https://pay.weixin.qq.com/doc/v3/merchant/4013071036
4
5public class WXPayRefund {
6  
7  public static void main(String[] args) {
8    Create ceateRefund = Create(
9        "19xxxxxxxx",                    // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756
10        "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053
11        "/path/to/apiclient_key.pem",    // 商户API证书私钥文件路径，本地文件路径
12        "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816
13        "/path/to/wxp_pub.pem",          // 微信支付公钥文件路径，本地文件路径
14    );
15    
16    CreateRequest createRefundRequest = new CreateRequest();
17    
18    // 原支付订单信息
19    createRefundRequest.transactionId = "4200000020202506035017900000";
20    createRefundRequest.amount = new AmountReq();
21    createRefundRequest.amount.total = 800L;
22    
23    // 退款信息
24    // 商户退款单号生成方式商户视实际情况生成，需要保证平台商户下全局唯一
25    createRefundRequest.outRefundNo = "4200000020202506035017900000_1";
26    createRefundRequest.reason = "成团退差价";
27    createRefundRequest.amount.refund = 200L;
28    
29    // 退款成功，退款关闭，退款异常时需要微信支付通知商户商户，可以加上回调URL，退款到这几个状态时会调用这个URL通知商户
30    createRefundRequest.notifyUrl = "https://weixin.qq.com";
31    
32    // 退款资金来源
33    // 1. 对于出行预付押金退款
34    //       - 不填写表示已结退款，从出行商户基本户出资退款
35    //       - 填写UNSETTLED，表示未结退款，从押金账户出资退款
36    // 2. 对于老资金流商户（老资金流也叫旧资金流，旧资金流如何区分见：https://kf.qq.com/faq/161223N7fi2E161223EvY3Ir.html）
37    //       - 不填写表示未结退款，从未结账户出资退款
38    //       - 填写AVAILABLE，表示从可用余额出资退款
39    // createRefundRequest.fundsAccount = ReqFundsAccount.AVAILABLE;
40    
41    // 退款商品信息
42    createRefundRequest.goodsDetail = new ArrayList<>();
43    {
44      GoodsDetail goodDetail = new GoodsDetail();
45      goodDetail.merchantGoodsId = "1217752501201407033233368018";
46      goodDetail.wechatpayGoodsId = "1001";
47      goodDetail.goodsName = "iPhone6s 16G";
48      goodDetail.unitPrice = 528800L;
49      goodDetail.refundAmount = 528800L;
50      goodDetail.refundQuantity = 1L;
51      goodDetail.goodsDetail.add(item0);
52    };
53    
54    
55    Refund refund;
56    try {
57      refund = ceateRefund.run(createRefundRequest);
58    } catch (WXPayUtility.ApiException e) {
59      // 申请退款处理异常处理逻辑
60      if (e.getErrorCode() == "SYSTEM_ERROR") {
61        // 错误：系统错误
62        // 解决方式：稍后原单重试
63        // 描述：微信支付系统失败，一定要原单重试，系统失败直接立即重试大概率还会是系统失败，建议等1分钟后再重试
64      } else if (e.getErrorCode() == "FREQUENCY_LIMITED") {
65        // 错误：限频报错
66        // 解决方式：稍后原单重试
67        // 描述： 退款接口频率限制，一定要原单重试，直接立即重试大概率还会是系统失败，建议等1分钟后再重试
68      } else if (e.getErrorCode() == "USER_ACCOUNT_ABNORMAL") {
69        // 错误：用户账户异常
70        // 解决方式：退款受理失败，商户可以自行处理退款，也可以登录商户平台进入交易中心发起异常退款
71        // 描述：用户注销或者被管控了，这笔订单已经不能发起退款，这个错误就不需要重试了
72      } else if (e.getErrorCode() == "NOT_ENOUGH") {
73        // 错误：账户余额不足
74        // 解决方式：商户充值之后原单重试
75        // 描述：商户账户余额不足，导致退款失败，商户充值之后一定要原单重试
76      } else if (e.getErrorCode() == "NO_AUTH") {
77        // 错误：无退款权限
78        // 解决方式：检查商户是否是被处罚：登录商户平台进入账户中心-违约记录查询是否违约记录，如果有按照上面的指引解决违约记录之后原单重试
79        // 描述：商户被处罚
80      } else if (e.getErrorCode() == "SIGN_ERROR") {
81        // 错误：签名错误
82        // 解决方式：检查平台商户证书序列号，证书私钥文件，公钥ID，公钥文件，同时确认下签名过程是不是按照微信支付的签名方式
83        // 描述：签名报错，需要确认签名材料和签名流程是否正确
84      } else if (e.getErrorCode() == "PARAM_ERROR") {
85        // 错误：参数错误
86        // 解决方式：按照报错返回的message，重新输入请求参数
87        // 描述：参数的类型，长度，或者必填选项没有填写等
88      } else if (e.getErrorCode() == "INVALID_REQUEST") {
89        // 错误：请求非法，请求参数正确，但是不符合退款业务规则
90        // 解决方式：根据具体message查看具体哪里不符合业务规则，如果可以修改参数达到符合业务规则的修改请求符合业务规则之后再原单重试
91        // 描述：不符合业务规则的场景如：
92        //        - 交易时间超过365天，不允许发起退款
93        //        - 一笔订单退款次数已经超过50次了，这笔订单不允许发起新的退款
94        //        - 申请退款的金额超过了这笔订单剩余可退金额，不允许申请退款
95      } else {
96        // 其他类型错误：稍等一会后原单重试
97      }
98
99    }
100  }
101}

1package com.tencent.pay.refund;
2
3import com.java.demo.Create;  // 使用商户平台申请退款接口https://pay.weixin.qq.com/doc/v3/merchant/4013071036
4import com.java.demo.QueryByOutRefundNo;  // 使用商户平台查询单笔退款（按商户退款单号）接口，见：https://pay.weixin.qq.com/doc/v3/merchant/4013071041
5import com.java.demo.CreateAbnormalRefund;  // 使用商户平台发起异常退款接口，见：https://pay.weixin.qq.com/doc/v3/merchant/4013071193
6
7public class WXPayRefund {
8  
9  public static void main(String[] args) {
10    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/merchant/4013070756
11    QueryByOutRefundNo client = new QueryByOutRefundNo(
12        "19xxxxxxxx",                    // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756
13        "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053
14        "/path/to/apiclient_key.pem",    // 商户API证书私钥文件路径，本地文件路径
15        "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816
16        "/path/to/wxp_pub.pem",          // 微信支付公钥文件路径，本地文件路径
17    );
18
19    QueryByOutRefundNoRequest request = new QueryByOutRefundNoRequest();
20    request.outRefundNo = "4200000020202506035017900000_1";
21    
22    Refund refund = client.run(request);
23    switch (refund.status) {
24      case SUCCESS:
25        // 终态：退款成功（退款到账）
26        // 更新商户自己的业务单据状态为成功
27        UpdateRefund2Succ();
28        break;
29      case CLOSED:
30        // 终态：退款关闭
31        // 更新商户自己的业务单据状态为关闭
32        UpdateRefund2Closed();
33        // 如果还需要退款，需要换单（换outRefundNo）重新申请退款
34        Create refund = Create(
35            "19xxxxxxxx",                    // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756
36            "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053
37            "/path/to/apiclient_key.pem",    // 商户API证书私钥文件路径，本地文件路径
38            "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816
39            "/path/to/wxp_pub.pem",          // 微信支付公钥文件路径，本地文件路径
40        );
41    
42        CreateRequest createRefundRequest = new CreateRequest();
43        // 其他参数和之前申请退款参数一样，只改商户退款单号
44        createRefundRequest.outRefundNo = "4200000020202506035017900000_2";
45        refund.run(createRefundRequest);
46        
47        break;
48      case PROCESSING:
49        // 非终态：退款处理中 - 还未到账，需要隔一段时间再来查询
50        break;
51      case ABNORMAL:
52        // 非终态：退款异常 - 用户异常、用户被管控等原因不能原路退
53        // 可以用两种处理方式：
54        //  1. 商户登录商户平台进入交易中心发起异常退款，把钱退到用户指定的银行卡或者商户的银行
55        //  2. 请求异常退款API
56        // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/merchant/4013070756
57        CreateAbnormalRefund createAbnormalRefund = new CreateAbnormalRefund(
58            "19xxxxxxxx",                    // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756
59            "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053
60            "/path/to/apiclient_key.pem",    // 商户API证书私钥文件路径，本地文件路径
61            "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816
62            "/path/to/wxp_pub.pem",          // 微信支付公钥文件路径，本地文件路径
63        );
64        CreateAbnormalRefundRequest abnormalRefundRequest = new AbnormalRefundRequest();
65        abnormalRefundRequest.outRefundNo = "4200000020202506035017900000_1";
66        abnormalRefundRequest.type = AbnormalReceiveType.USER_BANK_CARD;
67        abnormalRefundRequest.bankType = "ICBC_DEBIT";
68        abnormalRefundRequest.bankAccount = createAbnormalRefund.encrypt("请填 用户的银行卡号");
69        abnormalRefundRequest.realName = createAbnormalRefund.encrypt("请填 收款用户姓名");
70        Refund refund = createAbnormalRefund.abnormalRefund(refund4Create.refundId, abnormalRefundRequest);
71        // 发起异常退款成功之后，退款单会进入退款中，还是需要通过查单接口查询退款单的状态
72        break;
73      default:
74        // 非法状态
75        throw new IllegalArgumentException("微信支付退款单状态非法");
76      }
77    } catch (WXPayUtility.ApiException e) {
78      // 查询退款处理异常处理逻辑
79      if (e.getErrorCode() == "RESOURCE_NOT_EXISTS") {
80        // 错误：退款单不存在
81        // 解决方式：原参数申请退款
82        // 描述：退款受理没成功，原参数发起退款申请即可
83      } else if (e.getErrorCode() == "SYSTEM_ERROR") {
84        // 错我：系统错误
85        // 解决方式：稍后原单重试
86        // 描述：微信支付系统失败，直接立即重试大概率还会是系统失败，建议等1分钟后再重试
87      } else if (e.getErrorCode() == "FREQUENCY_LIMITED") {
88        // 错误：限频报错
89        // 处理逻辑：稍后原单重试
90        // 描述： 退款接口频率限制，直接立即重试大概率还会是系统失败，建议等1分钟后再重试
91      } else if (e.getErrorCode() == "MCH_NOT_EXISTS") {
92        // 错误：二级子商户不存在
93        // 处理逻辑：检查输入的二级商户号是否填写正确，修改正确之后原单重试
94        // 描述：输入子商户账户不存在，需要填写存在的账户之后重试
95      } else if (e.getErrorCode() == "NO_AUTH") {
96        // 错误：无退款权限
97        // 处理逻辑：检查平台商户是否退款权限，平台商户和二级子商户是否有父子受理关系，需要开通平台商户的退款权限和添加二级子商户的父子受理权限才能发起退款
98        // 描述：平台商户无退款权限或者平台商户和二级子商户没有父子受理关系
99      } else if (e.getErrorCode() == "SIGN_ERROR") {
100        // 错误：签名错误
101        // 处理逻辑：检查平台商户证书序列号，证书私钥文件，公钥ID，公钥文件，同时确认下签名过程是不是按照微信支付的签名方式
102        // 描述：签名报错，需要确认签名材料和签名流程是否正确
103      } else if (e.getErrorCode() == "PARAM_ERROR") {
104        // 错误：参数错误
105        // 处理逻辑：按照报错返回的message，重新输入请求参数
106        // 描述：参数的类型，长度，或者必填选项没有填写等
107      } else {
108        // 其他类型错误：稍等一会后原单重试
109      }
110    }
111  }
112}

1RefundNotifyResult refundNotifyResult;
2try {
3  // 1. 解析微信支付回调包体，refundNotifyRawResult为商户接收到微信回调的原始信息
4  refundNotifyResult = refund.parseRefundNotify(refundNotifyRawResult);
5  // 2. 解析完回调包体之后，可以先返回给微信支付200或者204，表示回调成功
6  //    商户再异步处理包体逻辑，这样子能保证微信回调不会超时，微信支付超时多次之后不会再回调
7  //    处理方式如先吧refundNotifyResult抛到消息队列，然后返回微信支付成功，最后消息队列消费者可以异步处理退款回调信息
8  // 
9  send2MQ(refundNotifyResult);
10} catch (Exception e) {
11  // 处理回调异常
12}
13
14
15// 消费者处理逻辑
16public static bool handleRefundNotify(RefundNotifyResult refundNotifyResult) {
17  switch (refundNotifyResult.status) {
18   // 这里处理状态逻辑和上面的查询退款单的逻辑保持一致即可
19  }
20}