分页查询子商户名下的交易拦截记录

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/transaction-block/transaction-block-records/sub-mchid/123000110?limit=5&offset=10 \
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 ListTransactionBlockRecords {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/v3/transaction-block/transaction-block-records/sub-mchid/{sub_mchid}";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    ListTransactionBlockRecords client = new ListTransactionBlockRecords(
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      ,
37      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
38      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径，本地文件路径
39    );
40
41    ListTransactionBlockRecordsRequest request = new ListTransactionBlockRecordsRequest();
42    request.subMchid = "123000110";
43    request.limit = 5L;
44    request.offset = 10L;
45    try {
46      ListTransactionBlockRecordsResponse response = client.run(request);
47        // TODO: 请求成功，继续业务逻辑
48        System.out.println(response);
49    } catch (WXPayUtility.ApiException e) {
50        // TODO: 请求失败，根据状态码执行不同的逻辑
51        e.printStackTrace();
52    }
53  }
54
55  public ListTransactionBlockRecordsResponse run(ListTransactionBlockRecordsRequest request) {
56    String uri = PATH;
57    uri = uri.replace("{sub_mchid}", WXPayUtility.urlEncode(request.subMchid));
58    Map<String, Object> args = new HashMap<>();
59    args.put("limit", request.limit);
60    args.put("offset", request.offset);
61    uri = uri + "?" + WXPayUtility.urlEncode(args);
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, ListTransactionBlockRecordsResponse.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 ListTransactionBlockRecords(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 ListTransactionBlockRecordsRequest {
104    @SerializedName("sub_mchid")
105    @Expose(serialize = false)
106    public String subMchid;
107  
108    @SerializedName("limit")
109    @Expose(serialize = false)
110    public Long limit;
111  
112    @SerializedName("offset")
113    @Expose(serialize = false)
114    public Long offset;
115  }
116  
117  public static class ListTransactionBlockRecordsResponse {
118    @SerializedName("data")
119    public List<TransactionBlockRecordsEntity> data;
120  
121    @SerializedName("offset")
122    public Long offset;
123  
124    @SerializedName("limit")
125    public Long limit;
126  
127    @SerializedName("total_count")
128    public Long totalCount;
129  }
130  
131  public static class TransactionBlockRecordsEntity {
132    @SerializedName("block_record_id")
133    public String blockRecordId;
134  
135    @SerializedName("block_time")
136    public String blockTime;
137  
138    @SerializedName("block_reason")
139    public String blockReason;
140  
141    @SerializedName("number_of_block")
142    public EnumTypeNumberOfBlockDesc numberOfBlock;
143  
144    @SerializedName("recover_way")
145    public EnumTypeRecoverWay recoverWay;
146  
147    @SerializedName("requested_item_info")
148    public String requestedItemInfo;
149  }
150  
151  public enum EnumTypeNumberOfBlockDesc {
152    @SerializedName("LESS_THAN_TWENTY")
153    LESS_THAN_TWENTY,
154    @SerializedName("LESS_THAN_ONE_HUNDRED")
155    LESS_THAN_ONE_HUNDRED,
156    @SerializedName("LESS_THAN_ONE_THOUSAND")
157    LESS_THAN_ONE_THOUSAND,
158    @SerializedName("OVER_ONE_THOUSAND")
159    OVER_ONE_THOUSAND
160  }
161  
162  public enum EnumTypeRecoverWay {
163    @SerializedName("SUBMIT_INFORMATION")
164    SUBMIT_INFORMATION
165  }
166  
167}
168

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)
11
12func main() {
13	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/partner/4013080340
14	config, err := wxpay_utility.CreateMchConfig(
15		"19xxxxxxxx",                 // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340
16		"1DDE55AD98Exxxxxxxxxx",      // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924
17		"/path/to/apiclient_key.pem", // 商户API证书私钥文件路径，本地文件路径
18		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589
19		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
20	)
21	if err != nil {
22		fmt.Println(err)
23		return
24	}
25
26	request := &ListTransactionBlockRecordsRequest{
27		SubMchid: wxpay_utility.String("123000110"),
28		Limit:    wxpay_utility.Int64(5),
29		Offset:   wxpay_utility.Int64(10),
30	}
31
32	response, err := ListTransactionBlockRecords(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 ListTransactionBlockRecords(config *wxpay_utility.MchConfig, request *ListTransactionBlockRecordsRequest) (response *ListTransactionBlockRecordsResponse, err error) {
44	const (
45		host   = "https://api.mch.weixin.qq.com"
46		method = "GET"
47		path   = "/v3/transaction-block/transaction-block-records/sub-mchid/{sub_mchid}"
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, "{sub_mchid}", url.PathEscape(*request.SubMchid), -1)
55	query := reqUrl.Query()
56	query.Add("limit", fmt.Sprintf("%v", *request.Limit))
57	query.Add("offset", fmt.Sprintf("%v", *request.Offset))
58	reqUrl.RawQuery = query.Encode()
59	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
60	if err != nil {
61		return nil, err
62	}
63	httpRequest.Header.Set("Accept", "application/json")
64	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
65	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
66	if err != nil {
67		return nil, err
68	}
69	httpRequest.Header.Set("Authorization", authorization)
70
71	client := &http.Client{}
72	httpResponse, err := client.Do(httpRequest)
73	if err != nil {
74		return nil, err
75	}
76	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
77	if err != nil {
78		return nil, err
79	}
80	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
81		// 2XX 成功，验证应答签名
82		err = wxpay_utility.ValidateResponse(
83			config.WechatPayPublicKeyId(),
84			config.WechatPayPublicKey(),
85			&httpResponse.Header,
86			respBody,
87		)
88		if err != nil {
89			return nil, err
90		}
91		response := &ListTransactionBlockRecordsResponse{}
92		if err := json.Unmarshal(respBody, response); err != nil {
93			return nil, err
94		}
95
96		return response, nil
97	} else {
98		return nil, wxpay_utility.NewApiException(
99			httpResponse.StatusCode,
100			httpResponse.Header,
101			respBody,
102		)
103	}
104}
105
106type ListTransactionBlockRecordsRequest struct {
107	SubMchid *string `json:"sub_mchid,omitempty"`
108	Limit    *int64  `json:"limit,omitempty"`
109	Offset   *int64  `json:"offset,omitempty"`
110}
111
112func (o *ListTransactionBlockRecordsRequest) MarshalJSON() ([]byte, error) {
113	type Alias ListTransactionBlockRecordsRequest
114	a := &struct {
115		SubMchid *string `json:"sub_mchid,omitempty"`
116		Limit    *int64  `json:"limit,omitempty"`
117		Offset   *int64  `json:"offset,omitempty"`
118		*Alias
119	}{
120		// 序列化时移除非 Body 字段
121		SubMchid: nil,
122		Limit:    nil,
123		Offset:   nil,
124		Alias:    (*Alias)(o),
125	}
126	return json.Marshal(a)
127}
128
129type ListTransactionBlockRecordsResponse struct {
130	Data       []TransactionBlockRecordsEntity `json:"data,omitempty"`
131	Offset     *int64                          `json:"offset,omitempty"`
132	Limit      *int64                          `json:"limit,omitempty"`
133	TotalCount *int64                          `json:"total_count,omitempty"`
134}
135
136type TransactionBlockRecordsEntity struct {
137	BlockRecordId     *string                    `json:"block_record_id,omitempty"`
138	BlockTime         *string                    `json:"block_time,omitempty"`
139	BlockReason       *string                    `json:"block_reason,omitempty"`
140	NumberOfBlock     *EnumTypeNumberOfBlockDesc `json:"number_of_block,omitempty"`
141	RecoverWay        *EnumTypeRecoverWay        `json:"recover_way,omitempty"`
142	RequestedItemInfo *string                    `json:"requested_item_info,omitempty"`
143}
144
145type EnumTypeNumberOfBlockDesc string
146
147func (e EnumTypeNumberOfBlockDesc) Ptr() *EnumTypeNumberOfBlockDesc {
148	return &e
149}
150
151const (
152	ENUMTYPENUMBEROFBLOCKDESC_LESS_THAN_TWENTY       EnumTypeNumberOfBlockDesc = "LESS_THAN_TWENTY"
153	ENUMTYPENUMBEROFBLOCKDESC_LESS_THAN_ONE_HUNDRED  EnumTypeNumberOfBlockDesc = "LESS_THAN_ONE_HUNDRED"
154	ENUMTYPENUMBEROFBLOCKDESC_LESS_THAN_ONE_THOUSAND EnumTypeNumberOfBlockDesc = "LESS_THAN_ONE_THOUSAND"
155	ENUMTYPENUMBEROFBLOCKDESC_OVER_ONE_THOUSAND      EnumTypeNumberOfBlockDesc = "OVER_ONE_THOUSAND"
156)
157
158type EnumTypeRecoverWay string
159
160func (e EnumTypeRecoverWay) Ptr() *EnumTypeRecoverWay {
161	return &e
162}
163
164const (
165	ENUMTYPERECOVERWAY_SUBMIT_INFORMATION EnumTypeRecoverWay = "SUBMIT_INFORMATION"
166)
167