com.github.binarywang.wxpay.bean.request.WxPayUnifiedOrderRequest Maven / Gradle / Ivy
package com.github.binarywang.wxpay.bean.request;
import com.github.binarywang.wxpay.config.WxPayConfig;
import com.github.binarywang.wxpay.exception.WxPayException;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import me.chanjar.weixin.common.annotation.Required;
import org.apache.commons.lang3.StringUtils;
/**
*
* 统一下单请求参数对象
* 参考文档：https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1
*
* Created by Binary Wang on 2016/9/25.
*
* @author binarywang (https://github.com/binarywang)
*/
@XStreamAlias("xml")
public class WxPayUnifiedOrderRequest extends WxPayBaseRequest {
private static final String[] TRADE_TYPES = new String[]{"JSAPI", "NATIVE", "APP", "MWEB"};
/**
*
* 字段名：设备号
* 变量名：device_info
* 是否必填：否
* 类型：String(32)
* 示例值：013467007045764
* 描述：终端设备号(门店号或收银设备Id)，注意：PC网页或公众号内支付请传"WEB"
*
*/
@XStreamAlias("device_info")
private String deviceInfo;
/**
*
* 字段名：商品描述
* 变量名：body
* 是否必填：是
* 类型：String(128)
* 示例值： 腾讯充值中心-QQ会员充值
* 描述：商品简单描述，该字段须严格按照规范传递，具体请见参数规定
*
*/
@Required
@XStreamAlias("body")
private String body;
/**
*
* 字段名：商品详情
* 变量名：detail
* 是否必填：否
* 类型：String(6000)
* 示例值： { "goods_detail":[
* {
* "goods_id":"iphone6s_16G",
* "wxpay_goods_id":"1001",
* "goods_name":"iPhone6s 16G",
* "goods_num":1,
* "price":528800,
* "goods_category":"123456",
* "body":"苹果手机"
* },
* {
* "goods_id":"iphone6s_32G",
* "wxpay_goods_id":"1002",
* "goods_name":"iPhone6s 32G",
* "quantity":1,
* "price":608800,
* "goods_category":"123789",
* "body":"苹果手机"
* }
* ]
* }
* 描述：商品详细列表，使用Json格式，传输签名前请务必使用CDATA标签将JSON文本串保护起来。
* goods_detail []：
* └ goods_id String 必填 32 商品的编号
* └ wxpay_goods_id String 可选 32 微信支付定义的统一商品编号
* └ goods_name String 必填 256 商品名称
* └ goods_num Int 必填 商品数量
* └ price Int 必填 商品单价，单位为分
* └ goods_category String 可选 32 商品类目Id
* └ body String 可选 1000 商品描述信息
*
*/
@XStreamAlias("detail")
private String detail;
/**
*
* 字段名：附加数据
* 变量名：attach
* 是否必填：否
* 类型：String(127)
* 示例值： 深圳分店
* 描述： 附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据
*
*/
@XStreamAlias("attach")
private String attach;
/**
*
* 字段名：商户订单号
* 变量名：out_trade_no
* 是否必填：是
* 类型：String(32)
* 示例值：20150806125346
* 描述：商户系统内部的订单号,32个字符内、可包含字母, 其他说明见商户订单号
*
*/
@Required
@XStreamAlias("out_trade_no")
private String outTradeNo;
/**
*
* 字段名：货币类型
* 变量名：fee_type
* 是否必填：否
* 类型：String(16)
* 示例值：CNY
* 描述： 符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型
*
*/
@XStreamAlias("fee_type")
private String feeType;
/**
*
* 字段名：总金额
* 变量名：total_fee
* 是否必填：是
* 类型：Int
* 示例值： 888
* 描述：订单总金额，单位为分，详见支付金额
*
*/
@Required
@XStreamAlias("total_fee")
private Integer totalFee;
/**
*
* 字段名：终端IP
* 变量名：spbill_create_ip
* 是否必填：是
* 类型：String(16)
* 示例值：123.12.12.123
* 描述：APP和网页支付提交用户端ip，Native支付填调用微信支付API的机器IP。
*
*/
@Required
@XStreamAlias("spbill_create_ip")
private String spbillCreateIp;
/**
*
* 字段名：交易起始时间
* 变量名：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;
/**
*
* 字段名：商品标记
* 变量名：goods_tag
* 是否必填：否
* 类型：String(32)
* 示例值：WXG
* 描述：商品标记，代金券或立减优惠功能的参数，说明详见代金券或立减优惠
*
*/
@XStreamAlias("goods_tag")
private String goodsTag;
/**
*
* 字段名：通知地址
* 变量名：notify_url
* 是否必填：是
* 类型：String(256)
* 示例值：http://www.weixin.qq.com/wxpay/pay.php
* 描述：接收微信支付异步通知回调地址，通知url必须为直接可访问的url，不能携带参数。
*
*/
@Required
@XStreamAlias("notify_url")
private String notifyURL;
/**
*
* 字段名：交易类型
* 变量名：trade_type
* 是否必填：是
* 类型：String(16)
* 示例值： JSAPI
* 描述： 取值如下：JSAPI，NATIVE，APP，详细说明见参数规定:
* JSAPI--公众号支付、NATIVE--原生扫码支付、APP--app支付，统一下单接口trade_type的传参可参考这里
*
*/
@Required
@XStreamAlias("trade_type")
private String tradeType;
/**
*
* 字段名：商品Id
* 变量名：product_id
* 是否必填：否
* 类型：String(32)
* 示例值：12235413214070356458058
* 描述：trade_type=NATIVE，此参数必传。此id为二维码中包含的商品Id，商户自行定义。
*
*/
@XStreamAlias("product_id")
private String productId;
/**
*
* 字段名：指定支付方式
* 变量名：limit_pay
* 是否必填：否
* 类型：String(32)
* 示例值：no_credit
* 描述：no_credit--指定不能使用信用卡支付
*
*/
@XStreamAlias("limit_pay")
private String limitPay;
/**
*
* 字段名：用户标识
* 变量名：openid
* 是否必填：否
* 类型：String(128)
* 示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
* 描述：trade_type=JSAPI，此参数必传，用户在商户appid下的唯一标识。
* openid如何获取，可参考【获取openid】。
* 企业号请使用【企业号OAuth2.0接口】获取企业号内成员userid，再调用【企业号userid转openid接口】进行转换
*
*/
@XStreamAlias("openid")
private String openid;
/**
*
* 字段名：用户子标识
* 变量名：sub_openid
* 是否必填：否
* 类型：String(128)
* 示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
* 描述：trade_type=JSAPI，此参数必传，用户在子商户appid下的唯一标识。
* openid和sub_openid可以选传其中之一，如果选择传sub_openid,则必须传sub_appid。
* 下单前需要调用【网页授权获取用户信息】接口获取到用户的Openid。
*
*/
@XStreamAlias("sub_openid")
private String subOpenid;
/**
*
* 字段名：场景信息
* 变量名：scene_info
* 是否必填：否，对H5支付来说是必填
* 类型：String(256)
* 示例值：{
* "store_id": "SZT10000",
* "store_name":"腾讯大厦腾大餐厅"
* }
* 描述：该字段用于统一下单时上报场景信息，目前支持上报实际门店信息。
* {
* "store_id": "", //门店唯一标识，选填，String(32)
* "store_name":"”//门店名称，选填，String(64)
* }
*
*/
@XStreamAlias("scene_info")
private String sceneInfo;
/**
*
* 字段名：浏览器指纹
* 变量名：fingerprint
* 是否必填：否
* 详细参考 https://pay.weixin.qq.com/wiki/doc/api/H5.php?chapter=15_7&index=6
*
*/
@XStreamAlias("fingerprint")
private String fingerprint;
public WxPayUnifiedOrderRequest() {
}
private WxPayUnifiedOrderRequest(Builder builder) {
setDeviceInfo(builder.deviceInfo);
setAppid(builder.appid);
setBody(builder.body);
setMchId(builder.mchId);
setSubAppId(builder.subAppId);
setSubMchId(builder.subMchId);
setNonceStr(builder.nonceStr);
setSign(builder.sign);
setDetail(builder.detail);
setAttach(builder.attach);
setOutTradeNo(builder.outTradeNo);
setFeeType(builder.feeType);
setTotalFee(builder.totalFee);
setSpbillCreateIp(builder.spbillCreateIp);
setTimeStart(builder.timeStart);
setTimeExpire(builder.timeExpire);
setGoodsTag(builder.goodsTag);
setNotifyURL(builder.notifyURL);
setTradeType(builder.tradeType);
setProductId(builder.productId);
setLimitPay(builder.limitPay);
setOpenid(builder.openid);
setSubOpenid(builder.subOpenid);
setSceneInfo(builder.sceneInfo);
fingerprint = builder.fingerprint;
}
public static Builder newBuilder() {
return new Builder();
}
public String getDeviceInfo() {
return this.deviceInfo;
}
public void setDeviceInfo(String deviceInfo) {
this.deviceInfo = deviceInfo;
}
public String getBody() {
return this.body;
}
public void setBody(String body) {
this.body = body;
}
public String getDetail() {
return this.detail;
}
public void setDetail(String detail) {
this.detail = detail;
}
public String getAttach() {
return this.attach;
}
public void setAttach(String attach) {
this.attach = attach;
}
public String getOutTradeNo() {
return this.outTradeNo;
}
public void setOutTradeNo(String outTradeNo) {
this.outTradeNo = outTradeNo;
}
public String getFeeType() {
return this.feeType;
}
public void setFeeType(String feeType) {
this.feeType = feeType;
}
public Integer getTotalFee() {
return this.totalFee;
}
public void setTotalFee(Integer totalFee) {
this.totalFee = totalFee;
}
public String getSpbillCreateIp() {
return this.spbillCreateIp;
}
public void setSpbillCreateIp(String spbillCreateIp) {
this.spbillCreateIp = spbillCreateIp;
}
public String getTimeStart() {
return this.timeStart;
}
public void setTimeStart(String timeStart) {
this.timeStart = timeStart;
}
public String getTimeExpire() {
return this.timeExpire;
}
public void setTimeExpire(String timeExpire) {
this.timeExpire = timeExpire;
}
public String getGoodsTag() {
return this.goodsTag;
}
public void setGoodsTag(String goodsTag) {
this.goodsTag = goodsTag;
}
public String getNotifyURL() {
return this.notifyURL;
}
/**
* 如果配置中已经设置，可以不设置值
*
* @param notifyURL
*/
public void setNotifyURL(String notifyURL) {
this.notifyURL = notifyURL;
}
public String getTradeType() {
return this.tradeType;
}
/**
* 如果配置中已经设置，可以不设置值
*
* @param tradeType 交易类型
*/
public void setTradeType(String tradeType) {
this.tradeType = tradeType;
}
public String getProductId() {
return this.productId;
}
public void setProductId(String productId) {
this.productId = productId;
}
public String getLimitPay() {
return this.limitPay;
}
public void setLimitPay(String limitPay) {
this.limitPay = limitPay;
}
public String getOpenid() {
return this.openid;
}
public void setOpenid(String openid) {
this.openid = openid;
}
public String getSubOpenid() {
return this.subOpenid;
}
public void setSubOpenid(String subOpenid) {
this.subOpenid = subOpenid;
}
public String getSceneInfo() {
return this.sceneInfo;
}
public void setSceneInfo(String sceneInfo) {
this.sceneInfo = sceneInfo;
}
@Override
protected void checkConstraints() throws WxPayException {
// if (!ArrayUtils.contains(TRADE_TYPES, this.getTradeType())) {
// throw new WxPayException(String.format("trade_type目前必须为%s其中之一,实际值：%s",
// Arrays.toString(TRADE_TYPES), this.getTradeType()));
// }
if ("JSAPI".equals(this.getTradeType()) && this.getOpenid() == null) {
throw new WxPayException("当 trade_type是'JSAPI'时未指定openid");
}
if ("NATIVE".equals(this.getTradeType()) && this.getProductId() == null) {
throw new WxPayException("当 trade_type是'NATIVE'时未指定product_id");
}
}
@Override
public void checkAndSign(WxPayConfig config) throws WxPayException {
if (StringUtils.isBlank(this.getNotifyURL())) {
this.setNotifyURL(config.getNotifyUrl());
}
if (StringUtils.isBlank(this.getTradeType())) {
this.setTradeType(config.getTradeType());
}
super.checkAndSign(config);
}
public static final class Builder {
private String appid;
private String mchId;
private String subAppId;
private String subMchId;
private String nonceStr;
private String sign;
private String deviceInfo;
private String body;
private String detail;
private String attach;
private String outTradeNo;
private String feeType;
private Integer totalFee;
private String spbillCreateIp;
private String timeStart;
private String timeExpire;
private String goodsTag;
private String notifyURL;
private String tradeType;
private String productId;
private String limitPay;
private String openid;
private String subOpenid;
private String sceneInfo;
private String fingerprint;
private Builder() {
}
public Builder appid(String appid) {
this.appid = appid;
return this;
}
public Builder mchId(String mchId) {
this.mchId = mchId;
return this;
}
public Builder subAppId(String subAppId) {
this.subAppId = subAppId;
return this;
}
public Builder subMchId(String subMchId) {
this.subMchId = subMchId;
return this;
}
public Builder nonceStr(String nonceStr) {
this.nonceStr = nonceStr;
return this;
}
public Builder sign(String sign) {
this.sign = sign;
return this;
}
public Builder deviceInfo(String deviceInfo) {
this.deviceInfo = deviceInfo;
return this;
}
public Builder body(String body) {
this.body = body;
return this;
}
public Builder detail(String detail) {
this.detail = detail;
return this;
}
public Builder attach(String attach) {
this.attach = attach;
return this;
}
public Builder outTradeNo(String outTradeNo) {
this.outTradeNo = outTradeNo;
return this;
}
public Builder feeType(String feeType) {
this.feeType = feeType;
return this;
}
public Builder totalFee(Integer totalFee) {
this.totalFee = totalFee;
return this;
}
public Builder spbillCreateIp(String spbillCreateIp) {
this.spbillCreateIp = spbillCreateIp;
return this;
}
public Builder timeStart(String timeStart) {
this.timeStart = timeStart;
return this;
}
public Builder timeExpire(String timeExpire) {
this.timeExpire = timeExpire;
return this;
}
public Builder goodsTag(String goodsTag) {
this.goodsTag = goodsTag;
return this;
}
public Builder notifyURL(String notifyURL) {
this.notifyURL = notifyURL;
return this;
}
public Builder tradeType(String tradeType) {
this.tradeType = tradeType;
return this;
}
public Builder productId(String productId) {
this.productId = productId;
return this;
}
public Builder limitPay(String limitPay) {
this.limitPay = limitPay;
return this;
}
public Builder openid(String openid) {
this.openid = openid;
return this;
}
public Builder subOpenid(String subOpenid) {
this.subOpenid = subOpenid;
return this;
}
public Builder sceneInfo(String sceneInfo) {
this.sceneInfo = sceneInfo;
return this;
}
public Builder fingerprint(String fingerprint) {
this.fingerprint = fingerprint;
return this;
}
public WxPayUnifiedOrderRequest build() {
return new WxPayUnifiedOrderRequest(this);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy