查询可用商户范围列表

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/webizpay/avail-mch-ranges?sp_mchid=12341234 \
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 QueryAvailMchRange {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/v3/webizpay/avail-mch-ranges";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    QueryAvailMchRange client = new QueryAvailMchRange(
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    QueryAvailMchRangeRequest request = new QueryAvailMchRangeRequest();
41    request.spMchid = "12341234";
42    try {
43      AvailMchRangeQueryResponse response = client.run(request);
44        // TODO: 请求成功，继续业务逻辑
45        System.out.println(response);
46    } catch (WXPayUtility.ApiException e) {
47        // TODO: 请求失败，根据状态码执行不同的逻辑
48        e.printStackTrace();
49    }
50  }
51
52  public AvailMchRangeQueryResponse run(QueryAvailMchRangeRequest request) {
53    String uri = PATH;
54    Map<String, Object> args = new HashMap<>();
55    args.put("sp_mchid", request.spMchid);
56    String queryString = WXPayUtility.urlEncode(args);
57    if (!queryString.isEmpty()) {
58        uri = uri + "?" + queryString;
59    }
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, null));
65    reqBuilder.method(METHOD, null);
66    Request httpRequest = reqBuilder.build();
67
68    // 发送HTTP请求
69    OkHttpClient client = new OkHttpClient.Builder().build();
70    try (Response httpResponse = client.newCall(httpRequest).execute()) {
71      String respBody = WXPayUtility.extractBody(httpResponse);
72      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
73        // 2XX 成功，验证应答签名
74        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
75            httpResponse.headers(), respBody);
76
77        // 从HTTP应答报文构建返回数据
78        return WXPayUtility.fromJson(respBody, AvailMchRangeQueryResponse.class);
79      } else {
80        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
81      }
82    } catch (IOException e) {
83      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
84    }
85  }
86
87  private final String mchid;
88  private final String certificateSerialNo;
89  private final PrivateKey privateKey;
90  private final String wechatPayPublicKeyId;
91  private final PublicKey wechatPayPublicKey;
92
93  public QueryAvailMchRange(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
94    this.mchid = mchid;
95    this.certificateSerialNo = certificateSerialNo;
96    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
97    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
98    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
99  }
100
101  public static class QueryAvailMchRangeRequest {
102    @SerializedName("sp_mchid")
103    @Expose(serialize = false)
104    public String spMchid;
105  }
106  
107  public static class AvailMchRangeQueryResponse {
108    @SerializedName("sp_mchid")
109    public String spMchid;
110  
111    @SerializedName("range_list")
112    public List<AvailMchRangeItem> rangeList;
113  }
114  
115  public static class AvailMchRangeItem {
116    @SerializedName("range_id")
117    public String rangeId;
118  
119    @SerializedName("identifier_type")
120    public MerchantIdentifierType identifierType;
121  }
122  
123  public enum MerchantIdentifierType {
124    @SerializedName("ORGANIZATION_CODE")
125    ORGANIZATION_CODE,
126    @SerializedName("TRANSACTION_ID")
127    TRANSACTION_ID
128  }
129  
130}
131

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)
10
11func main() {
12	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
13	config, err := wxpay_utility.CreateMchConfig(
14		"19xxxxxxxx",                 // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340
15		"1DDE55AD98Exxxxxxxxxx",      // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924
16		"/path/to/apiclient_key.pem", // 商户API证书私钥文件路径，本地文件路径
17		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
18		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
19	)
20	if err != nil {
21		fmt.Println(err)
22		return
23	}
24
25	request := &QueryAvailMchRangeRequest{
26		SpMchid: wxpay_utility.String("12341234"),
27	}
28
29	response, err := QueryAvailMchRange(config, request)
30	if err != nil {
31		fmt.Printf("请求失败: %+v\n", err)
32		// TODO: 请求失败，根据状态码执行不同的处理
33		return
34	}
35
36	// TODO: 请求成功，继续业务逻辑
37	fmt.Printf("请求成功: %+v\n", response)
38}
39
40func QueryAvailMchRange(config *wxpay_utility.MchConfig, request *QueryAvailMchRangeRequest) (response *AvailMchRangeQueryResponse, err error) {
41	const (
42		host   = "https://api.mch.weixin.qq.com"
43		method = "GET"
44		path   = "/v3/webizpay/avail-mch-ranges"
45	)
46
47	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
48	if err != nil {
49		return nil, err
50	}
51	query := reqUrl.Query()
52	if request.SpMchid != nil {
53		query.Add("sp_mchid", *request.SpMchid)
54	}
55	reqUrl.RawQuery = query.Encode()
56	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
57	if err != nil {
58		return nil, err
59	}
60	httpRequest.Header.Set("Accept", "application/json")
61	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
62	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
63	if err != nil {
64		return nil, err
65	}
66	httpRequest.Header.Set("Authorization", authorization)
67
68	client := &http.Client{}
69	httpResponse, err := client.Do(httpRequest)
70	if err != nil {
71		return nil, err
72	}
73	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
74	if err != nil {
75		return nil, err
76	}
77	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
78		// 2XX 成功，验证应答签名
79		err = wxpay_utility.ValidateResponse(
80			config.WechatPayPublicKeyId(),
81			config.WechatPayPublicKey(),
82			&httpResponse.Header,
83			respBody,
84		)
85		if err != nil {
86			return nil, err
87		}
88		response := &AvailMchRangeQueryResponse{}
89		if err := json.Unmarshal(respBody, response); err != nil {
90			return nil, err
91		}
92
93		return response, nil
94	} else {
95		return nil, wxpay_utility.NewApiException(
96			httpResponse.StatusCode,
97			httpResponse.Header,
98			respBody,
99		)
100	}
101}
102
103type QueryAvailMchRangeRequest struct {
104	SpMchid *string `json:"sp_mchid,omitempty"`
105}
106
107func (o *QueryAvailMchRangeRequest) MarshalJSON() ([]byte, error) {
108	type Alias QueryAvailMchRangeRequest
109	a := &struct {
110		SpMchid *string `json:"sp_mchid,omitempty"`
111		*Alias
112	}{
113		// 序列化时移除非 Body 字段
114		SpMchid: nil,
115		Alias:   (*Alias)(o),
116	}
117	return json.Marshal(a)
118}
119
120type AvailMchRangeQueryResponse struct {
121	SpMchid   *string             `json:"sp_mchid,omitempty"`
122	RangeList []AvailMchRangeItem `json:"range_list,omitempty"`
123}
124
125type AvailMchRangeItem struct {
126	RangeId        *string                 `json:"range_id,omitempty"`
127	IdentifierType *MerchantIdentifierType `json:"identifier_type,omitempty"`
128}
129
130type MerchantIdentifierType string
131
132func (e MerchantIdentifierType) Ptr() *MerchantIdentifierType {
133	return &e
134}
135
136const (
137	MERCHANTIDENTIFIERTYPE_ORGANIZATION_CODE MerchantIdentifierType = "ORGANIZATION_CODE"
138	MERCHANTIDENTIFIERTYPE_TRANSACTION_ID    MerchantIdentifierType = "TRANSACTION_ID"
139)
140