com.github.binarywang.wxpay.bean.request.WxPayMicropayRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weixin-java-pay Show documentation
微信支付 Java SDK
The newest version!
package com.github.binarywang.wxpay.bean.request;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import lombok.*;
import me.chanjar.weixin.common.annotation.Required;

import java.util.Map;

/**
 *  *  提交付款码支付请求对象类
 * Created by Binary Wang on 2017-3-23.
 * 
 *
 * @author Binary Wang
 */
@Data
@EqualsAndHashCode(callSuper = true)
@Builder(builderMethodName = "newBuilder")
@NoArgsConstructor
@AllArgsConstructor
@XStreamAlias("xml")
public class WxPayMicropayRequest extends BaseWxPayRequest {
  private static final long serialVersionUID = 100577773033376092L;

  /**
   *    * 字段名：设备号.
   * 变量名：device_info
   * 是否必填：否
   * 类型：String(32)
   * 示例值：013467007045764
   * 描述：终端设备号(商户自定义，如门店编号)
   * 
   */
  @XStreamAlias("device_info")
  private String deviceInfo;

  /**
   *    * 字段名：接口版本号.
   * 变量名：version
   * 是否必填：单品优惠必填
   * 类型：String(32)
   * 示例值：1.0
   * 描述：单品优惠新增字段，区分原接口，固定填写1.0
   * 更多信息，详见文档：https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_101&index=1
   * 
   */
  @XStreamAlias("version")
  private String version;

  /**
   *    * 字段名：商品描述.
   * 变量名：body
   * 是否必填：是
   * 类型：String(128)
   * 示例值：image形象店-深圳腾大- QQ公仔
   * 描述：商品简单描述，该字段须严格按照规范传递，具体请见参数规定
   * 
   **/
  @Required
  @XStreamAlias("body")
  private String body;

  /**
   *    * 字段名：商品详情.
   * 变量名：detail
   * 是否必填：否
   * 类型：String(6000)
   * 示例值：
   * 描述：单品优惠功能字段，需要接入请见详细说明
   **/
  @XStreamAlias("detail")
  private String detail;

  /**
   *    * 字段名：附加数据.
   * 变量名：attach
   * 是否必填：否
   * 类型：String(127)
   * 示例值：说明
   * 描述：附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据
   * 
   **/
  @XStreamAlias("attach")
  private String attach;

  /**
   *    * 字段名：商户订单号.
   * 变量名：out_trade_no
   * 是否必填：是
   * 类型：String(32)
   * 示例值：1217752501201407033233368018
   * 描述：商户系统内部的订单号,32个字符内、可包含字母,其他说明见商户订单号
   * 
   **/
  @Required
  @XStreamAlias("out_trade_no")
  private String outTradeNo;

  /**
   *    * 字段名：订单金额.
   * 变量名：total_fee
   * 是否必填：是
   * 类型：Int
   * 示例值：888
   * 描述：订单总金额，单位为分，只能为整数，详见支付金额
   * 
   **/
  @Required
  @XStreamAlias("total_fee")
  private Integer totalFee;

  /**
   *    * 字段名：货币类型.
   * 变量名：fee_type
   * 是否必填：否
   * 类型：String(16)
   * 示例值：CNY
   * 描述：符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
   * 
   **/
  @XStreamAlias("fee_type")
  private String feeType;

  /**
   *    * 字段名：终端IP.
   * 变量名：spbill_create_ip
   * 是否必填：是
   * 类型：String(16)
   * 示例值：8.8.8.8
   * 描述：调用微信支付API的机器IP
   * 
   **/
  @Required
  @XStreamAlias("spbill_create_ip")
  private String spbillCreateIp;

  /**
   *    * 字段名：商品标记.
   * 变量名：goods_tag
   * 是否必填：否
   * 类型：String(32)
   * 示例值：1234
   * 描述：商品标记，代金券或立减优惠功能的参数，说明详见代金券或立减优惠
   * 
   **/
  @XStreamAlias("goods_tag")
  private String goodsTag;

  /**
   *    * 字段名：指定支付方式.
   * 变量名：limit_pay
   * 是否必填：否
   * 类型：String(32)
   * 示例值：no_credit
   * 描述：no_credit--指定不能使用信用卡支付
   * 
   **/
  @XStreamAlias("limit_pay")
  private String limitPay;

  /**
   *    * 字段名：交易起始时间.
   * 变量名：time_start
   * 是否必填：否
   * 类型：String(14)
   * 示例值：20091225091010
   * 描述：订单生成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则
   * 
   */
  @XStreamAlias("time_start")
  private String timeStart;

  /**
   *    * 字段名：交易结束时间.
   * 变量名：time_expire
   * 是否必填：否
   * 类型：String(14)
   * 示例值：20091227091010
   * 描述：订单失效时间，格式为yyyyMMddHHmmss，如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则
   * 注意：最短失效时间间隔必须大于5分钟
   * 
   */
  @XStreamAlias("time_expire")
  private String timeExpire;

  /**
   *    * 字段名：电子发票入口开放标识	.
   * 变量名：receipt
   * 是否必填：否
   * 类型：String(8)
   * 示例值：Y
   * 描述：Y，传入Y时，支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能，传此字段才可生效
   * 
   **/
  @XStreamAlias("receipt")
  private String receipt;

  /**
   *    * 字段名：授权码.
   * 变量名：auth_code
   * 是否必填：是
   * 类型：String(128)
   * 示例值：120061098828009406
   * 描述：扫码支付授权码，设备读取用户微信中的条码或者二维码信息注：用户刷卡条形码规则：18位纯数字，以10、11、12、13、14、15开头）
   * 
   **/
  @Required
  @XStreamAlias("auth_code")
  private String authCode;

  /**
   *    * 字段名：场景信息.
   * 变量名：scene_info
   * 是否必填：否
   * 类型：String(256)
   * 示例值：{"store_info" : {
   * "id": "SZTX001",
   * "name": "腾大餐厅",
   * "area_code": "440305",
   * "address": "科技园中一路腾讯大厦" }}
   * 描述：该字段用于上报场景信息，目前支持上报实际门店信息。该字段为JSON对象数据，对象格式为{"store_info":{"id": "门店ID","name": "名称","area_code": "编码","address": "地址" }}
   * 
   */
  @XStreamAlias("scene_info")
  private String sceneInfo;

  /**
   *    * 字段名：是否指定服务商分账.
   * 变量名：profit_sharing
   * 是否必填：否
   * 详情：Y-是，需要分账  N-否，不分账，字母要求大写，不传默认不分账
   * 详细参考 https://pay.weixin.qq.com/wiki/doc/api/allocation_sl.php?chapter=24_3&index=3
   * 
   */
  @XStreamAlias("profit_sharing")
  private String profitSharing;

  @Override
  protected void checkConstraints() {
    //do nothing
  }

  @Override
  protected void storeMap(Map map) {
    map.put("version", version);
    map.put("body", body);
    map.put("detail", detail);
    map.put("attach", attach);
    map.put("out_trade_no", outTradeNo);
    map.put("total_fee", totalFee.toString());
    map.put("fee_type", feeType);
    map.put("spbill_create_ip", spbillCreateIp);
    map.put("goods_tag", goodsTag);
    map.put("limit_pay", limitPay);
    map.put("time_start", timeStart);
    map.put("time_expire", timeExpire);
    map.put("auth_code", authCode);
    map.put("scene_info", sceneInfo);
    map.put("profit_sharing",profitSharing);
  }

}