查询单笔退款（通过商户退款单号）

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/refund/domestic/refunds/1217752501201407033233368018?sub_mchid=1900000109 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

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 QueryByOutRefundNo {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/v3/refund/domestic/refunds/{out_refund_no}";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    QueryByOutRefundNo client = new QueryByOutRefundNo(
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    QueryByOutRefundNoRequest request = new QueryByOutRefundNoRequest();
41    request.outRefundNo = "1217752501201407033233368018";
42    request.subMchid = "1900000109";
43    try {
44      Refund response = client.run(request);
45        // TODO: 请求成功，继续业务逻辑
46        System.out.println(response);
47    } catch (WXPayUtility.ApiException e) {
48        // TODO: 请求失败，根据状态码执行不同的逻辑
49        e.printStackTrace();
50    }
51  }
52
53  public Refund run(QueryByOutRefundNoRequest request) {
54    String uri = PATH;
55    uri = uri.replace("{out_refund_no}", WXPayUtility.urlEncode(request.outRefundNo));
56    Map<String, Object> args = new HashMap<>();
57    args.put("sub_mchid", request.subMchid);
58    String queryString = WXPayUtility.urlEncode(args);
59    if (!queryString.isEmpty()) {
60        uri = uri + "?" + queryString;
61    }
62
63    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
64    reqBuilder.addHeader("Accept", "application/json");
65    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
66    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo, privateKey, METHOD, uri, null));
67    reqBuilder.method(METHOD, null);
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 QueryByOutRefundNo(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 static class QueryByOutRefundNoRequest {
104    @SerializedName("out_refund_no")
105    @Expose(serialize = false)
106    public String outRefundNo;
107  
108    @SerializedName("sub_mchid")
109    @Expose(serialize = false)
110    public String subMchid;
111  }
112  
113  public static class Refund {
114    @SerializedName("refund_id")
115    public String refundId;
116  
117    @SerializedName("out_refund_no")
118    public String outRefundNo;
119  
120    @SerializedName("transaction_id")
121    public String transactionId;
122  
123    @SerializedName("out_trade_no")
124    public String outTradeNo;
125  
126    @SerializedName("channel")
127    public Channel channel;
128  
129    @SerializedName("user_received_account")
130    public String userReceivedAccount;
131  
132    @SerializedName("success_time")
133    public String successTime;
134  
135    @SerializedName("create_time")
136    public String createTime;
137  
138    @SerializedName("status")
139    public Status status;
140  
141    @SerializedName("funds_account")
142    public FundsAccount fundsAccount;
143  
144    @SerializedName("amount")
145    public Amount amount;
146  
147    @SerializedName("promotion_detail")
148    public List<Promotion> promotionDetail;
149  
150    @SerializedName("refund_account")
151    public RefundAccount refundAccount;
152  }
153  
154  public enum Channel {
155    @SerializedName("ORIGINAL")
156    ORIGINAL,
157    @SerializedName("BALANCE")
158    BALANCE,
159    @SerializedName("OTHER_BALANCE")
160    OTHER_BALANCE,
161    @SerializedName("OTHER_BANKCARD")
162    OTHER_BANKCARD
163  }
164  
165  public enum Status {
166    @SerializedName("SUCCESS")
167    SUCCESS,
168    @SerializedName("CLOSED")
169    CLOSED,
170    @SerializedName("PROCESSING")
171    PROCESSING,
172    @SerializedName("ABNORMAL")
173    ABNORMAL
174  }
175  
176  public enum FundsAccount {
177    @SerializedName("UNSETTLED")
178    UNSETTLED,
179    @SerializedName("AVAILABLE")
180    AVAILABLE,
181    @SerializedName("UNAVAILABLE")
182    UNAVAILABLE,
183    @SerializedName("OPERATION")
184    OPERATION,
185    @SerializedName("BASIC")
186    BASIC,
187    @SerializedName("ECNY_BASIC")
188    ECNY_BASIC
189  }
190  
191  public static class Amount {
192    @SerializedName("total")
193    public Long total;
194  
195    @SerializedName("refund")
196    public Long refund;
197  
198    @SerializedName("from")
199    public List<FundsFromItem> from;
200  
201    @SerializedName("payer_total")
202    public Long payerTotal;
203  
204    @SerializedName("payer_refund")
205    public Long payerRefund;
206  
207    @SerializedName("settlement_refund")
208    public Long settlementRefund;
209  
210    @SerializedName("settlement_total")
211    public Long settlementTotal;
212  
213    @SerializedName("discount_refund")
214    public Long discountRefund;
215  
216    @SerializedName("currency")
217    public String currency;
218  
219    @SerializedName("refund_fee")
220    public Long refundFee;
221  
222    @SerializedName("advance")
223    public Long advance;
224  }
225  
226  public static class Promotion {
227    @SerializedName("promotion_id")
228    public String promotionId;
229  
230    @SerializedName("scope")
231    public PromotionScope scope;
232  
233    @SerializedName("type")
234    public PromotionType type;
235  
236    @SerializedName("amount")
237    public Long amount;
238  
239    @SerializedName("refund_amount")
240    public Long refundAmount;
241  
242    @SerializedName("goods_detail")
243    public List<GoodsDetail> goodsDetail;
244  }
245  
246  public enum RefundAccount {
247    @SerializedName("REFUND_SOURCE_PARTNER_ADVANCE")
248    REFUND_SOURCE_PARTNER_ADVANCE,
249    @SerializedName("REFUND_SOURCE_SUB_MERCHANT")
250    REFUND_SOURCE_SUB_MERCHANT,
251    @SerializedName("REFUND_SOURCE_SUB_MERCHANT_ADVANCE")
252    REFUND_SOURCE_SUB_MERCHANT_ADVANCE
253  }
254  
255  public static class FundsFromItem {
256    @SerializedName("account")
257    public Account account;
258  
259    @SerializedName("amount")
260    public Long amount;
261  }
262  
263  public enum PromotionScope {
264    @SerializedName("GLOBAL")
265    GLOBAL,
266    @SerializedName("SINGLE")
267    SINGLE
268  }
269  
270  public enum PromotionType {
271    @SerializedName("COUPON")
272    COUPON,
273    @SerializedName("DISCOUNT")
274    DISCOUNT
275  }
276  
277  public static class GoodsDetail {
278    @SerializedName("merchant_goods_id")
279    public String merchantGoodsId;
280  
281    @SerializedName("wechatpay_goods_id")
282    public String wechatpayGoodsId;
283  
284    @SerializedName("goods_name")
285    public String goodsName;
286  
287    @SerializedName("unit_price")
288    public Long unitPrice;
289  
290    @SerializedName("refund_amount")
291    public Long refundAmount;
292  
293    @SerializedName("refund_quantity")
294    public Long refundQuantity;
295  }
296  
297  public enum Account {
298    @SerializedName("AVAILABLE")
299    AVAILABLE,
300    @SerializedName("UNAVAILABLE")
301    UNAVAILABLE
302  }
303  
304}
305

1package main
2
3import (
4	"demo/wxpay_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446
5	"encoding/json"
6	"fmt"
7	"net/http"
8	"net/url"
9	"strings"
10	"time"
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 := &QueryByOutRefundNoRequest{
28		OutRefundNo: wxpay_utility.String("1217752501201407033233368018"),
29		SubMchid:    wxpay_utility.String("1900000109"),
30	}
31
32	response, err := QueryByOutRefundNo(config, request)
33	if err != nil {
34		fmt.Printf("请求失败: %+v\n", err)
35		// TODO: 请求失败，根据状态码执行不同的处理
36		return
37	}
38
39	// TODO: 请求成功，继续业务逻辑
40	fmt.Printf("请求成功: %+v\n", response)
41}
42
43func QueryByOutRefundNo(config *wxpay_utility.MchConfig, request *QueryByOutRefundNoRequest) (response *Refund, err error) {
44	const (
45		host   = "https://api.mch.weixin.qq.com"
46		method = "GET"
47		path   = "/v3/refund/domestic/refunds/{out_refund_no}"
48	)
49
50	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
51	if err != nil {
52		return nil, err
53	}
54	reqUrl.Path = strings.Replace(reqUrl.Path, "{out_refund_no}", url.PathEscape(*request.OutRefundNo), -1)
55	query := reqUrl.Query()
56	if request.SubMchid != nil {
57		query.Add("sub_mchid", *request.SubMchid)
58	}
59	reqUrl.RawQuery = query.Encode()
60	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
61	if err != nil {
62		return nil, err
63	}
64	httpRequest.Header.Set("Accept", "application/json")
65	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
66	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
67	if err != nil {
68		return nil, 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 nil, err
76	}
77	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
78	if err != nil {
79		return nil, err
80	}
81	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
82		// 2XX 成功，验证应答签名
83		err = wxpay_utility.ValidateResponse(
84			config.WechatPayPublicKeyId(),
85			config.WechatPayPublicKey(),
86			&httpResponse.Header,
87			respBody,
88		)
89		if err != nil {
90			return nil, err
91		}
92		response := &Refund{}
93		if err := json.Unmarshal(respBody, response); err != nil {
94			return nil, err
95		}
96
97		return response, nil
98	} else {
99		return nil, wxpay_utility.NewApiException(
100			httpResponse.StatusCode,
101			httpResponse.Header,
102			respBody,
103		)
104	}
105}
106
107type QueryByOutRefundNoRequest struct {
108	OutRefundNo *string `json:"out_refund_no,omitempty"`
109	SubMchid    *string `json:"sub_mchid,omitempty"`
110}
111
112func (o *QueryByOutRefundNoRequest) MarshalJSON() ([]byte, error) {
113	type Alias QueryByOutRefundNoRequest
114	a := &struct {
115		OutRefundNo *string `json:"out_refund_no,omitempty"`
116		SubMchid    *string `json:"sub_mchid,omitempty"`
117		*Alias
118	}{
119		// 序列化时移除非 Body 字段
120		OutRefundNo: nil,
121		SubMchid:    nil,
122		Alias:       (*Alias)(o),
123	}
124	return json.Marshal(a)
125}
126
127type Refund struct {
128	RefundId            *string        `json:"refund_id,omitempty"`
129	OutRefundNo         *string        `json:"out_refund_no,omitempty"`
130	TransactionId       *string        `json:"transaction_id,omitempty"`
131	OutTradeNo          *string        `json:"out_trade_no,omitempty"`
132	Channel             *Channel       `json:"channel,omitempty"`
133	UserReceivedAccount *string        `json:"user_received_account,omitempty"`
134	SuccessTime         *time.Time     `json:"success_time,omitempty"`
135	CreateTime          *time.Time     `json:"create_time,omitempty"`
136	Status              *Status        `json:"status,omitempty"`
137	FundsAccount        *FundsAccount  `json:"funds_account,omitempty"`
138	Amount              *Amount        `json:"amount,omitempty"`
139	PromotionDetail     []Promotion    `json:"promotion_detail,omitempty"`
140	RefundAccount       *RefundAccount `json:"refund_account,omitempty"`
141}
142
143type Channel string
144
145func (e Channel) Ptr() *Channel {
146	return &e
147}
148
149const (
150	CHANNEL_ORIGINAL       Channel = "ORIGINAL"
151	CHANNEL_BALANCE        Channel = "BALANCE"
152	CHANNEL_OTHER_BALANCE  Channel = "OTHER_BALANCE"
153	CHANNEL_OTHER_BANKCARD Channel = "OTHER_BANKCARD"
154)
155
156type Status string
157
158func (e Status) Ptr() *Status {
159	return &e
160}
161
162const (
163	STATUS_SUCCESS    Status = "SUCCESS"
164	STATUS_CLOSED     Status = "CLOSED"
165	STATUS_PROCESSING Status = "PROCESSING"
166	STATUS_ABNORMAL   Status = "ABNORMAL"
167)
168
169type FundsAccount string
170
171func (e FundsAccount) Ptr() *FundsAccount {
172	return &e
173}
174
175const (
176	FUNDSACCOUNT_UNSETTLED   FundsAccount = "UNSETTLED"
177	FUNDSACCOUNT_AVAILABLE   FundsAccount = "AVAILABLE"
178	FUNDSACCOUNT_UNAVAILABLE FundsAccount = "UNAVAILABLE"
179	FUNDSACCOUNT_OPERATION   FundsAccount = "OPERATION"
180	FUNDSACCOUNT_BASIC       FundsAccount = "BASIC"
181	FUNDSACCOUNT_ECNY_BASIC  FundsAccount = "ECNY_BASIC"
182)
183
184type Amount struct {
185	Total            *int64          `json:"total,omitempty"`
186	Refund           *int64          `json:"refund,omitempty"`
187	From             []FundsFromItem `json:"from,omitempty"`
188	PayerTotal       *int64          `json:"payer_total,omitempty"`
189	PayerRefund      *int64          `json:"payer_refund,omitempty"`
190	SettlementRefund *int64          `json:"settlement_refund,omitempty"`
191	SettlementTotal  *int64          `json:"settlement_total,omitempty"`
192	DiscountRefund   *int64          `json:"discount_refund,omitempty"`
193	Currency         *string         `json:"currency,omitempty"`
194	RefundFee        *int64          `json:"refund_fee,omitempty"`
195	Advance          *int64          `json:"advance,omitempty"`
196}
197
198type Promotion struct {
199	PromotionId  *string         `json:"promotion_id,omitempty"`
200	Scope        *PromotionScope `json:"scope,omitempty"`
201	Type         *PromotionType  `json:"type,omitempty"`
202	Amount       *int64          `json:"amount,omitempty"`
203	RefundAmount *int64          `json:"refund_amount,omitempty"`
204	GoodsDetail  []GoodsDetail   `json:"goods_detail,omitempty"`
205}
206
207type RefundAccount string
208
209func (e RefundAccount) Ptr() *RefundAccount {
210	return &e
211}
212
213const (
214	REFUNDACCOUNT_REFUND_SOURCE_PARTNER_ADVANCE      RefundAccount = "REFUND_SOURCE_PARTNER_ADVANCE"
215	REFUNDACCOUNT_REFUND_SOURCE_SUB_MERCHANT         RefundAccount = "REFUND_SOURCE_SUB_MERCHANT"
216	REFUNDACCOUNT_REFUND_SOURCE_SUB_MERCHANT_ADVANCE RefundAccount = "REFUND_SOURCE_SUB_MERCHANT_ADVANCE"
217)
218
219type FundsFromItem struct {
220	Account *Account `json:"account,omitempty"`
221	Amount  *int64   `json:"amount,omitempty"`
222}
223
224type PromotionScope string
225
226func (e PromotionScope) Ptr() *PromotionScope {
227	return &e
228}
229
230const (
231	PROMOTIONSCOPE_GLOBAL PromotionScope = "GLOBAL"
232	PROMOTIONSCOPE_SINGLE PromotionScope = "SINGLE"
233)
234
235type PromotionType string
236
237func (e PromotionType) Ptr() *PromotionType {
238	return &e
239}
240
241const (
242	PROMOTIONTYPE_COUPON   PromotionType = "COUPON"
243	PROMOTIONTYPE_DISCOUNT PromotionType = "DISCOUNT"
244)
245
246type GoodsDetail struct {
247	MerchantGoodsId  *string `json:"merchant_goods_id,omitempty"`
248	WechatpayGoodsId *string `json:"wechatpay_goods_id,omitempty"`
249	GoodsName        *string `json:"goods_name,omitempty"`
250	UnitPrice        *int64  `json:"unit_price,omitempty"`
251	RefundAmount     *int64  `json:"refund_amount,omitempty"`
252	RefundQuantity   *int64  `json:"refund_quantity,omitempty"`
253}
254
255type Account string
256
257func (e Account) Ptr() *Account {
258	return &e
259}
260
261const (
262	ACCOUNT_AVAILABLE   Account = "AVAILABLE"
263	ACCOUNT_UNAVAILABLE Account = "UNAVAILABLE"
264)
265