java doc

README.md

@@ -24,6 +24,11 @@
 - 实现微信支付V3 微信支付分
 - 实现微信支付V3 先享卡
 
+## 核心API结构
+![](https://asset.felord.cn/blog/20210112211759.png)
+
+> 随着版本迭代会增加
+
 ## 开源协议
 **Apache 2.0**
 

payment-spring-boot-autoconfigure/src/main/java/cn/felord/payment/wechat/v3/model/CouponAvailableTime.java

@@ -21,7 +21,7 @@ package cn.felord.payment.wechat.v3.model;
 import lombok.Data;
 
 /**
- * The type Coupon available time.
+ * 代金券生效时间
  *
  * @author felord.cn
  * @since 1.0.0.RELEASE
@@ -29,15 +29,26 @@ import lombok.Data;
 @Data
 public class CouponAvailableTime {
     /**
-     * The Available time after receive.
+     * 领取后有效时间，【单位：分钟】
+     * <p>
+     * 领取后，券的结束时间为领取N天后，如设置领取后7天有效，那么7月1日领券，在7月7日23:59:59失效（在可用时间内计算失效时间，若券还未到领取后N天，但是已经到了可用结束时间，那么也会过期）
      */
     private Long availableTimeAfterReceive;
     /**
-     * The Fix available time.
+     * 固定时间段可用
      */
     private FixAvailableTime fixAvailableTime;
     /**
-     * The Second day available.
+     * 领取后N天有效
+     * <p>
+     * 领取后，券的开始时间为领券后第二天，如7月1日领券，那么在7月2日00:00:00开始。
+     * 当设置领取后N天有效时，不可设置固定时间段可用。枚举值：
+     *
+     * <ul>
+     *     <li>true：是</li>
+     *     <li>false：否</li>
+     * </ul>
+     *
      */
     private Boolean secondDayAvailable;
 }

payment-spring-boot-autoconfigure/src/main/java/cn/felord/payment/wechat/v3/model/CouponUseRule.java

@@ -30,32 +30,26 @@ import java.util.List;
 @Data
 public class CouponUseRule {
 
-
     /**
      * 可核销商品编码
      */
     private List<String> availableItems;
-
     /**
      * 可用商户
      */
     private List<String> availableMerchants;
-
     /**
      * 是否可以叠加使用
      */
     private Boolean combineUse;
-
     /**
-     * 券生效时间
+     * 券生效时间（暂时未开放，日期2021-1-12，请以微信官方通知为准）
      */
     private CouponAvailableTime couponAvailableTime;
-
     /**
      * 固定面额满减券使用规则
      */
     private FixedNormalCoupon fixedNormalCoupon;
-
     /**
      * 订单优惠标记
      */

payment-spring-boot-autoconfigure/src/main/java/cn/felord/payment/wechat/v3/model/Detail.java

@@ -23,7 +23,7 @@ import lombok.Data;
 import java.util.List;
 
 /**
- * The type Detail.
+ * 支付优惠功能.
  *
  * @author felord.cn
  * @since 1.0.0.RELEASE

payment-spring-boot-autoconfigure/src/main/java/cn/felord/payment/wechat/v3/model/DiscountTo.java

@@ -21,7 +21,7 @@ package cn.felord.payment.wechat.v3.model;
 import lombok.Data;
 
 /**
- * 减至优惠限定字段，仅减至优惠场景有返回
+ *  微信代金券核销通知参数-减至优惠限定字段，仅减至优惠场景有返回
  *
  * @author felord.cn
  * @since 1.0.0.RELEASE
@@ -30,11 +30,11 @@ import lombok.Data;
 public class DiscountTo {
 
     /**
-     * The Cut to price.
+     * 减至后优惠单价，单位：分。
      */
     private Long cutToPrice;
     /**
-     * The Max price.
+     * 可享受优惠的最高价格，单位：分。
      */
     private Long maxPrice;
 

payment-spring-boot-autoconfigure/src/main/java/cn/felord/payment/wechat/v3/model/FixAvailableTime.java

@@ -23,7 +23,9 @@ import lombok.Data;
 import java.util.List;
 
 /**
- * The type Fix available time.
+ * 固定时间段可用
+ * <p>
+ * 允许指定券在特殊时间段生效。当设置固定时间段可用时不可设置领取后N天有效
  *
  * @author felord.cn
  * @since 1.0.0.RELEASE
@@ -32,15 +34,21 @@ import java.util.List;
 public class FixAvailableTime {
 
     /**
-     * The Available week day.
+     * 可用星期数
+     *
+     * 允许指定每周固定星期数生效，0代表周日生效，1代表周一生效，以此类推；不填则代表在可用时间内周一至周日都生效。
      */
     private List<Long> availableWeekDay;
     /**
-     * The Begin time.
+     * 允许指定特殊生效星期数中的具体生效的时间段。
+     *
+     * 当天开始时间，单位：秒。
      */
     private Long beginTime;
     /**
-     * The End time.
+     * 允许指定特殊生效星期数中的具体生效的时间段。
+     *
+     * 当天结束时间，单位：秒，默认为23点59分59秒。
      */
     private Long endTime;
 

payment-spring-boot-autoconfigure/src/main/java/cn/felord/payment/wechat/v3/model/TransactionQueryParams.java

@@ -18,14 +18,26 @@
  */
 package cn.felord.payment.wechat.v3.model;
 
+import cn.felord.payment.wechat.v3.WechatDirectPayApi;
 import lombok.Data;
 
 /**
+ * 微信支付订单号查询API请求参数.
+ *
  * @author felord.cn
  * @since 1.0.0.RELEASE
  */
 @Data
 public class TransactionQueryParams {
+    /**
+     * 商户id
+     */
     private String mchId;
+    /**
+     * <ul>
+     *     <li>调用 {@link WechatDirectPayApi#queryTransactionByOutTradeNo(TransactionQueryParams)} 传递【商户侧订单号】</li>
+     *     <li>调用 {@link WechatDirectPayApi#queryTransactionById(TransactionQueryParams)} (TransactionQueryParams)} 传递【微信支付订单号】</li>
+     * </ul>
+     */
     private String transactionIdOrOutTradeNo;
 }