binarywang#476 微信支付部分接口增加“单品优惠”的支持

binarywang · binarywang · commit fe7a4705b712 · 2018-03-03T16:28:58.000+08:00
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayOrderNotifyResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayOrderNotifyResult.java
@@ -27,6 +27,19 @@
 public class WxPayOrderNotifyResult extends BaseWxPayResult {
   private static final long serialVersionUID = 5389718115223345496L;
 
+  /**
+   * <pre>
+   * 字段名：营销详情.
+   * 变量名：promotion_detail
+   * 是否必填：否，单品优惠才有
+   * 类型：String(6000)
+   * 示例值：[{"promotion_detail":[{"promotion_id":"109519","name":"单品惠-6","scope":"SINGLE","type":"DISCOUNT","amount":5,"activity_id":"931386","wxpay_contribute":0,"merchant_contribute":0,"other_contribute":5,"goods_detail":[{"goods_id":"a_goods1","goods_remark":"商品备注","quantity":7,"price":1,"discount_amount":4},{"goods_id":"a_goods2","goods_remark":"商品备注","quantity":1,"price":2,"discount_amount":1}]}]}
+   * 描述：单品优惠专用参数，详见https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_203&index=4
+   * </pre>
+   */
+  @XStreamAlias("promotion_detail")
+  private String promotionDetail;
+
   /**
    * <pre>
    * 字段名：设备号.
@@ -106,7 +119,6 @@ public class WxPayOrderNotifyResult extends BaseWxPayResult {
   @XStreamAlias("trade_type")
   private String tradeType;
 
-
   /**
    * <pre>
    * 字段名：付款银行.
@@ -245,6 +257,7 @@ public class WxPayOrderNotifyResult extends BaseWxPayResult {
    */
   @XStreamAlias("attach")
   private String attach;
+
   /**
    * <pre>
    * 字段名：支付完成时间.
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayMicropayRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayMicropayRequest.java
@@ -21,124 +21,147 @@
 public class WxPayMicropayRequest extends BaseWxPayRequest {
   /**
    * <pre>
-   * 商品描述
-   * body
-   * 是
-   * String(128)
-   * image形象店-深圳腾大- QQ公仔
-   * 商品简单描述，该字段须严格按照规范传递，具体请见参数规定
+   * 字段名：接口版本号.
+   * 变量名：version
+   * 是否必填：单品优惠必填
+   * 类型：String(32)
+   * 示例值：1.0
+   * 描述：单品优惠新增字段，区分原接口，固定填写1.0
+   * 更多信息，详见文档：https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_101&index=1
+   * </pre>
+   */
+  @XStreamAlias("version")
+  private String version;
+
+  /**
+   * <pre>
+   * 字段名：商品描述.
+   * 变量名：body
+   * 是否必填：是
+   * 类型：String(128)
+   * 示例值：image形象店-深圳腾大- QQ公仔
+   * 描述：商品简单描述，该字段须严格按照规范传递，具体请见参数规定
+   * </pre>
    **/
   @Required
   @XStreamAlias("body")
   private String body;
 
   /**
    * <pre>
-   * 商品详情
-   * detail
-   * 否
-   * String(6000)
-   *
-   * 单品优惠功能字段，需要接入请见详细说明
+   * 字段名：商品详情.
+   * 变量名：detail
+   * 是否必填：否
+   * 类型：String(6000)
+   * 示例值：
+   * 描述：单品优惠功能字段，需要接入请见详细说明</pre>
    **/
   @XStreamAlias("detail")
   private String detail;
 
   /**
    * <pre>
-   * 附加数据
-   * attach
-   * 否
-   * String(127)
-   * 说明
-   * 附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据
+   * 字段名：附加数据.
+   * 变量名：attach
+   * 是否必填：否
+   * 类型：String(127)
+   * 示例值：说明
+   * 描述：附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据
+   * </pre>
    **/
   @XStreamAlias("attach")
   private String attach;
 
   /**
    * <pre>
-   * 商户订单号
-   * out_trade_no
-   * 是
-   * String(32)
-   * 1217752501201407033233368018
-   * 商户系统内部的订单号,32个字符内、可包含字母,其他说明见商户订单号
+   * 字段名：商户订单号.
+   * 变量名：out_trade_no
+   * 是否必填：是
+   * 类型：String(32)
+   * 示例值：1217752501201407033233368018
+   * 描述：商户系统内部的订单号,32个字符内、可包含字母,其他说明见商户订单号
+   * </pre>
    **/
   @Required
   @XStreamAlias("out_trade_no")
   private String outTradeNo;
 
   /**
    * <pre>
-   * 订单金额
-   * total_fee
-   * 是
-   * Int
-   * 888
-   * 订单总金额，单位为分，只能为整数，详见支付金额
+   * 字段名：订单金额.
+   * 变量名：total_fee
+   * 是否必填：是
+   * 类型：Int
+   * 示例值：888
+   * 描述：订单总金额，单位为分，只能为整数，详见支付金额
+   * </pre>
    **/
   @Required
   @XStreamAlias("total_fee")
   private Integer totalFee;
 
   /**
    * <pre>
-   * 货币类型
-   * fee_type
-   * 否
-   * String(16)
-   * CNY
-   * 符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
+   * 字段名：货币类型.
+   * 变量名：fee_type
+   * 是否必填：否
+   * 类型：String(16)
+   * 示例值：CNY
+   * 描述：符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
+   * </pre>
    **/
   @XStreamAlias("fee_type")
   private String feeType;
 
   /**
    * <pre>
-   * 终端IP
-   * spbill_create_ip
-   * 是
-   * String(16)
-   * 8.8.8.8
-   * 调用微信支付API的机器IP
+   * 字段名：终端IP.
+   * 变量名：spbill_create_ip
+   * 是否必填：是
+   * 类型：String(16)
+   * 示例值：8.8.8.8
+   * 描述：调用微信支付API的机器IP
+   * </pre>
    **/
   @Required
   @XStreamAlias("spbill_create_ip")
   private String spbillCreateIp;
 
   /**
    * <pre>
-   * 商品标记
-   * goods_tag
-   * 否
-   * String(32)
-   * 1234
-   * 商品标记，代金券或立减优惠功能的参数，说明详见代金券或立减优惠
+   * 字段名：商品标记.
+   * 变量名：goods_tag
+   * 是否必填：否
+   * 类型：String(32)
+   * 示例值：1234
+   * 描述：商品标记，代金券或立减优惠功能的参数，说明详见代金券或立减优惠
+   * </pre>
    **/
   @XStreamAlias("goods_tag")
   private String goodsTag;
 
   /**
    * <pre>
-   * 指定支付方式
-   * limit_pay
-   * 否
-   * String(32)
-   * no_credit
-   * no_credit--指定不能使用信用卡支付
+   * 字段名：指定支付方式.
+   * 变量名：limit_pay
+   * 是否必填：否
+   * 类型：String(32)
+   * 示例值：no_credit
+   * 描述：no_credit--指定不能使用信用卡支付
+   * </pre>
    **/
   @XStreamAlias("limit_pay")
   private String limitPay;
 
   /**
    * <pre>
-   * 授权码
-   * auth_code
-   * 是
-   * String(128)
-   * 120061098828009406
-   * 扫码支付授权码，设备读取用户微信中的条码或者二维码信息注：用户刷卡条形码规则：18位纯数字，以10、11、12、13、14、15开头）
+   * 字段名：授权码.
+   * 变量名：auth_code
+   * 是否必填：是
+   * 类型：String(128)
+   * 示例值：120061098828009406
+   * 描述：扫码支付授权码，设备读取用户微信中的条码或者二维码信息注：用户刷卡条形码规则：18位纯数字，以10、11、12、13、14、15开头）
+   * </pre>
    **/
   @Required
   @XStreamAlias("auth_code")
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayOrderQueryRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayOrderQueryRequest.java
@@ -28,6 +28,21 @@
 @XStreamAlias("xml")
 public class WxPayOrderQueryRequest extends BaseWxPayRequest {
 
+  /**
+   * <pre>
+   * 字段名：接口版本号.
+   * 变量名：version
+   * 是否必填：单品优惠必填
+   * 类型：String(32)
+   * 示例值：1.0
+   * 描述：单品优惠新增字段，区分原接口，固定填写1.0，
+   * 查单接口上传version后查询结果才返回单品信息，不上传不返回单品信息。
+   * 更多信息，详见文档：https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_102&index=2
+   * </pre>
+   */
+  @XStreamAlias("version")
+  private String version;
+
   /**
    * <pre>
    * 微信订单号
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayUnifiedOrderRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayUnifiedOrderRequest.java
@@ -26,6 +26,21 @@
 public class WxPayUnifiedOrderRequest extends BaseWxPayRequest {
   private static final long serialVersionUID = 4611350167813931828L;
 
+  /**
+   * <pre>
+   * 字段名：接口版本号.
+   * 变量名：version
+   * 是否必填：单品优惠必填
+   * 类型：String(32)
+   * 示例值：1.0
+   * 描述：单品优惠新增字段，接口版本号，区分原接口，默认填写1.0。
+   * 入参新增version后，则支付通知接口也将返回单品优惠信息字段promotion_detail，请确保支付通知的签名验证能通过。
+   * 更多信息，详见文档：https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_102&index=2
+   * </pre>
+   */
+  @XStreamAlias("version")
+  private String version;
+
   /**
    * <pre>
    * 字段名：设备号.
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayOrderQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayOrderQueryResult.java
@@ -27,6 +27,19 @@
 @XStreamAlias("xml")
 public class WxPayOrderQueryResult extends BaseWxPayResult {
 
+  /**
+   * <pre>
+   * 字段名：营销详情.
+   * 变量名：promotion_detail
+   * 是否必填：否，单品优惠才有
+   * 类型：String(6000)
+   * 示例值：[{"promotion_detail":[{"promotion_id":"109519","name":"单品惠-6","scope":"SINGLE","type":"DISCOUNT","amount":5,"activity_id":"931386","wxpay_contribute":0,"merchant_contribute":0,"other_contribute":5,"goods_detail":[{"goods_id":"a_goods1","goods_remark":"商品备注","quantity":7,"price":1,"discount_amount":4},{"goods_id":"a_goods2","goods_remark":"商品备注","quantity":1,"price":2,"discount_amount":1}]}]}
+   * 描述：单品优惠专用参数，详见https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_201&index=3
+   * </pre>
+   */
+  @XStreamAlias("promotion_detail")
+  private String promotionDetail;
+
   /**
    * <pre>设备号
    * device_info
