🎨 #3056 【微信支付】优化支付/退款结果解析,增加对V3版本服务商的下单/退款支持

This commit is contained in:
Pursuer丶
2023-06-16 16:22:59 +08:00
committed by Binary Wang
parent 211f4c7f74
commit 21a95e15df
10 changed files with 1609 additions and 30 deletions

View File

@@ -0,0 +1,30 @@
package com.github.binarywang.wxpay.bean.notify;
/**
* 微信支付公用回调
*
* @author Pursuer
* @version 1.0
* @date 2023/6/15
*/
public interface WxPayBaseNotifyV3Result<T> {
/**
* 设置原始数据
*
* @param rawData 原始数据
* @author Pursuer
* @date 2023/6/15
* @since 1.0
**/
void setRawData(OriginNotifyResponse rawData);
/**
* 解密后的数据
*
* @param data 解密后的数据
* @author Pursuer
* @date 2023/6/15
* @since 1.0
**/
void setResult(T data);
}

View File

@@ -15,7 +15,7 @@ import java.util.List;
*/
@Data
@NoArgsConstructor
public class WxPayOrderNotifyV3Result implements Serializable {
public class WxPayNotifyV3Result implements Serializable, WxPayBaseNotifyV3Result<WxPayNotifyV3Result.DecryptNotifyResult> {
private static final long serialVersionUID = -1L;
/**
* 源数据

View File

@@ -0,0 +1,568 @@
package com.github.binarywang.wxpay.bean.notify;
import com.google.gson.annotations.SerializedName;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.util.List;
/**
* 微信支付服务商下单回调
* 文档见https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_5.shtml
*
* @author Guo Shuai
* @version 1.0
* @date 2023/3/2
*/
@Data
@NoArgsConstructor
public class WxPayPartnerNotifyV3Result implements Serializable, WxPayBaseNotifyV3Result<WxPayPartnerNotifyV3Result.DecryptNotifyResult> {
private static final long serialVersionUID = -1L;
/**
* 源数据
*/
private OriginNotifyResponse rawData;
/**
* 解密后的数据
*/
private DecryptNotifyResult result;
@Data
@NoArgsConstructor
public static class DecryptNotifyResult implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名服务商应用ID
* 变量名spAppid
* 是否必填:是
* 类型string[1,32]
* 描述:
* 由微信生成的应用ID全局唯一。请求统一下单接口时请注意APPID的应用属性例如公众号场景下需使用应用属性为公众号的APPID
* 示例值wxd678efh567hg6787
* </pre>
*/
@SerializedName(value = "sp_appid")
protected String spAppid;
/**
* <pre>
* 字段名:服务商商户号
* 变量名spMchid
* 是否必填:是
* 类型string[1,32]
* 描述:
* 服务商商户号,由微信支付生成并下发。
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sp_mchid")
protected String spMchid;
/**
* <pre>
* 字段名子商户应用ID
* 变量名subAppid
* 是否必填:否
* 类型string[1,32]
* 描述:
* 由微信生成的应用ID全局唯一。请求统一下单接口时请注意APPID的应用属性例如公众号场景下需使用应用属性为公众号的APPID
* 示例值wxd678efh567hg6787
* </pre>
*/
@SerializedName(value = "sub_appid")
protected String subAppid;
/**
* <pre>
* 字段名:子商户商户号
* 变量名subMchid
* 是否必填:是
* 类型string[1,32]
* 描述:
* 子商户商户号,由微信支付生成并下发。
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sub_mchid")
protected String subMchid;
/**
* <pre>
* 字段名:商户订单号
* 变量名out_trade_no
* 是否必填:是
* 类型string[6,32]
* 描述:
* 商户系统内部订单号只能是数字、大小写字母_-*且在同一个商户号下唯一。
* 特殊规则最小字符长度为6
* 示例值1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "out_trade_no")
private String outTradeNo;
/**
* <pre>
* 字段名:微信支付订单号
* 变量名transaction_id
* 是否必填:是
* 类型string[1,32]
* 描述:
* 微信支付系统生成的订单号。
* 示例值1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "transaction_id")
private String transactionId;
/**
* <pre>
* 字段名:交易类型
* 变量名trade_type
* 是否必填:是
* 类型string[1,16]
* 描述:
* 交易类型,枚举值:
* JSAPI公众号支付
* NATIVE扫码支付
* APPAPP支付
* MICROPAY付款码支付
* MWEBH5支付
* FACEPAY刷脸支付
* 示例值MICROPAY
* </pre>
*/
@SerializedName(value = "trade_type")
private String tradeType;
/**
* <pre>
* 字段名:交易状态
* 变量名trade_state
* 是否必填:是
* 类型string[1,32]
* 描述:
* 交易状态,枚举值:
* SUCCESS支付成功
* REFUND转入退款
* NOTPAY未支付
* CLOSED已关闭
* REVOKED已撤销付款码支付
* USERPAYING用户支付中付款码支付
* PAYERROR支付失败(其他原因,如银行返回失败)
* 示例值SUCCESS
* </pre>
*/
@SerializedName(value = "trade_state")
private String tradeState;
/**
* <pre>
* 字段名:交易状态描述
* 变量名trade_state_desc
* 是否必填:是
* 类型string[1,256]
* 描述:
* 交易状态描述
* 示例值:支付成功
* </pre>
*/
@SerializedName(value = "trade_state_desc")
private String tradeStateDesc;
/**
* <pre>
* 字段名:付款银行
* 变量名bank_type
* 是否必填:是
* 类型string[1,16]
* 描述:
* 银行类型采用字符串类型的银行标识。银行标识请参考《银行类型对照表》https://pay.weixin.qq.com/wiki/doc/apiv3/terms_definition/chapter1_1_3.shtml#part-6
* 示例值CMC
* </pre>
*/
@SerializedName(value = "bank_type")
private String bankType;
/**
* <pre>
* 字段名:附加数据
* 变量名attach
* 是否必填:否
* 类型string[1,128]
* 描述:
* 附加数据在查询API和支付通知中原样返回可作为自定义参数使用
* 示例值:自定义数据
* </pre>
*/
@SerializedName(value = "attach")
private String attach;
/**
* <pre>
* 字段名:支付完成时间
* 变量名success_time
* 是否必填:是
* 类型string[1,64]
* 描述:
* 支付完成时间遵循rfc3339标准格式格式为YYYY-MM-DDTHH:mm:ss+TIMEZONEYYYY-MM-DD表示年月日T出现在字符串中表示time元素的开头HH:mm:ss表示时分秒TIMEZONE表示时区+08:00表示东八区时间领先UTC 8小时即北京时间。例如2015-05-20T13:29:35+08:00表示北京时间2015年5月20日 13点29分35秒。
* 示例值2018-06-08T10:34:56+08:00
* </pre>
*/
@SerializedName(value = "success_time")
private String successTime;
/**
* <pre>
* 字段名:支付者
* 变量名payer
* 是否必填:是
* 类型object
* 描述:
* 支付者信息
* </pre>
*/
private Payer payer;
/**
* <pre>
* 字段名:订单金额
* 变量名amount
* 是否必填:否
* 类型object
* 描述:
* 订单金额信息
* </pre>
*/
@SerializedName(value = "amount")
private Amount amount;
/**
* <pre>
* 字段名:场景信息
* 变量名scene_info
* 是否必填:否
* 类型object
* 描述:
* 支付场景信息描述
* </pre>
*/
@SerializedName(value = "scene_info")
private SceneInfo sceneInfo;
/**
* <pre>
* 字段名:优惠功能
* 变量名promotion_detail
* 是否必填:否
* 类型array
* 描述:
* 优惠功能,享受优惠时返回该字段。
* </pre>
*/
@SerializedName(value = "promotion_detail")
private List<PromotionDetail> promotionDetails;
}
@Data
@NoArgsConstructor
public static class Payer implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名:用户标识
* 变量名openid
* 是否必填:是
* 类型string[1,128]
* 描述:
* 用户在直连商户appid下的唯一标识。
* 示例值oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
* </pre>
*/
@SerializedName(value = "openid")
private String openid;
}
@Data
@NoArgsConstructor
public static class Amount implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名:总金额
* 变量名total
* 是否必填:否
* 类型int
* 描述:
* 订单总金额,单位为分。
* 示例值100
* </pre>
*/
@SerializedName(value = "total")
private Integer total;
/**
* <pre>
* 字段名:用户支付金额
* 变量名payer_total
* 是否必填:否
* 类型int
* 描述:
* 用户支付金额,单位为分。
* 示例值100
* </pre>
*/
@SerializedName(value = "payer_total")
private Integer payerTotal;
/**
* <pre>
* 字段名:货币类型
* 变量名currency
* 是否必填:否
* 类型string[1,16]
* 描述:
* CNY人民币境内商户号仅支持人民币。
* 示例值CNY
* </pre>
*/
@SerializedName(value = "currency")
private String currency;
/**
* <pre>
* 字段名:用户支付币种
* 变量名payer_currency
* 是否必填:否
* 类型string[1,16]
* 描述:
* 用户支付币种
* 示例值: CNY
* </pre>
*/
@SerializedName(value = "payer_currency")
private String payerCurrency;
}
@Data
@NoArgsConstructor
public static class SceneInfo implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名:商户端设备号
* 变量名device_id
* 是否必填:否
* 类型string[1,32]
* 描述:
* 终端设备号门店号或收银设备ID
* 示例值013467007045764
* </pre>
*/
@SerializedName(value = "device_id")
private String deviceId;
}
@Data
@NoArgsConstructor
public static class PromotionDetail implements Serializable {
/**
* <pre>
* 字段名券ID
* 变量名coupon_id
* 是否必填:是
* 类型string[1,32]
* 描述:
* 券ID
* 示例值109519
* </pre>
*/
@SerializedName(value = "coupon_id")
private String couponId;
/**
* <pre>
* 字段名:优惠名称
* 变量名name
* 是否必填:否
* 类型string[1,64]
* 描述:
* 优惠名称
* 示例值:单品惠-6
* </pre>
*/
@SerializedName(value = "name")
private String name;
/**
* <pre>
* 字段名:优惠范围
* 变量名scope
* 是否必填:否
* 类型string[1,32]
* 描述:
* GLOBAL全场代金券
* SINGLE单品优惠
* 示例值GLOBAL
* </pre>
*/
@SerializedName(value = "scope")
private String scope;
/**
* <pre>
* 字段名:优惠类型
* 变量名type
* 是否必填:否
* 类型string[1,32]
* 描述:
* CASH充值
* NOCASH预充值
* 示例值CASH
* </pre>
*/
@SerializedName(value = "type")
private String type;
/**
* <pre>
* 字段名:优惠券面额
* 变量名amount
* 是否必填:是
* 类型int
* 描述:
* 优惠券面额
* 示例值100
* </pre>
*/
@SerializedName(value = "amount")
private Integer amount;
/**
* <pre>
* 字段名活动ID
* 变量名stock_id
* 是否必填:否
* 类型string[1,32]
* 描述:
* 活动ID
* 示例值931386
* </pre>
*/
@SerializedName(value = "stock_id")
private String stockId;
/**
* <pre>
* 字段名:微信出资
* 变量名wechatpay_contribute
* 是否必填:否
* 类型int
* 描述:
* 微信出资,单位为分
* 示例值0
* </pre>
*/
@SerializedName(value = "wechatpay_contribute")
private Integer wechatpayContribute;
/**
* <pre>
* 字段名:商户出资
* 变量名merchant_contribute
* 是否必填:否
* 类型int
* 描述:
* 商户出资,单位为分
* 示例值0
* </pre>
*/
@SerializedName(value = "merchant_contribute")
private Integer merchantContribute;
/**
* <pre>
* 字段名:其他出资
* 变量名other_contribute
* 是否必填:否
* 类型int
* 描述:
* 其他出资,单位为分
* 示例值0
* </pre>
*/
@SerializedName(value = "other_contribute")
private Integer otherContribute;
/**
* <pre>
* 字段名:优惠币种
* 变量名currency
* 是否必填:否
* 类型string[1,16]
* 描述:
* CNY人民币境内商户号仅支持人民币。
* 示例值CNY
* </pre>
*/
@SerializedName(value = "currency")
private String currency;
/**
* <pre>
* 字段名:单品列表
* 变量名goods_detail
* 是否必填:否
* 类型array
* 描述:
* 单品列表信息
* </pre>
*/
@SerializedName(value = "goods_detail")
private List<GoodsDetail> goodsDetails;
}
@Data
@NoArgsConstructor
public static class GoodsDetail implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名:商品编码
* 变量名goods_id
* 是否必填:是
* 类型string[1,32]
* 描述:
* 商品编码
* 示例值M1006
* </pre>
*/
@SerializedName(value = "goods_id")
private String goodsId;
/**
* <pre>
* 字段名:商品数量
* 变量名quantity
* 是否必填:是
* 类型int
* 描述:
* 用户购买的数量
* 示例值1
* </pre>
*/
@SerializedName(value = "quantity")
private Integer quantity;
/**
* <pre>
* 字段名:商品单价
* 变量名unit_price
* 是否必填:是
* 类型int
* 描述:
* 商品单价,单位为分
* 示例值100
* </pre>
*/
@SerializedName(value = "unit_price")
private Integer unitPrice;
/**
* <pre>
* 字段名:商品优惠金额
* 变量名discount_amount
* 是否必填:是
* 类型int
* 描述:
* 商品优惠金额
* 示例值0
* </pre>
*/
@SerializedName(value = "discount_amount")
private Integer discountAmount;
/**
* <pre>
* 字段名:商品备注
* 变量名goods_remark
* 是否必填:否
* 类型string[1,128]
* 描述:
* 商品备注信息
* 示例值:商品备注信息
* </pre>
*/
@SerializedName(value = "goods_remark")
private String goodsRemark;
}
}

View File

@@ -0,0 +1,230 @@
package com.github.binarywang.wxpay.bean.notify;
import com.google.gson.annotations.SerializedName;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
/**
* 微信支付服务商退款回调
* 文档见https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_11.shtml
*
* @author Guo Shuai
* @version 1.0
* @date 2023/3/2
*/
@Data
@NoArgsConstructor
public class WxPayPartnerRefundNotifyV3Result implements Serializable, WxPayBaseNotifyV3Result<WxPayPartnerRefundNotifyV3Result.DecryptNotifyResult> {
private static final long serialVersionUID = -1L;
/**
* 源数据
*/
private OriginNotifyResponse rawData;
/**
* 解密后的数据
*/
private DecryptNotifyResult result;
@Data
@NoArgsConstructor
public static class DecryptNotifyResult implements Serializable {
private static final long serialVersionUID = -1L;
/**
* <pre>
* 字段名:服务商的商户号
* 变量名sub_mchid
* 是否必填:是
* 类型string[1, 32]
* 描述:
* 服务商的商户号,由微信支付生成并下发。
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sp_mchid")
private String spMchId;
/**
* <pre>
* 字段名:子商户的商户号
* 变量名sub_mchid
* 是否必填:是
* 类型string[1, 32]
* 描述:
* 子商户商户号,由微信支付生成并下发。
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sub_mchid")
private String subMchId;
/**
* <pre>
* 字段名:商户订单号
* 变量名out_trade_no
* 是否必填:是
* 类型string[1,32]
* 描述:
* 返回的商户订单号
* 示例值: 1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "out_trade_no")
private String outTradeNo;
/**
* <pre>
* 字段名:微信支付订单号
* 变量名transaction_id
* 是否必填:是
* 类型string[1,32]
* 描述:
* 微信支付订单号
* 示例值: 1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "transaction_id")
private String transactionId;
/**
* <pre>
* 字段名:商户退款单号
* 变量名out_refund_no
* 是否必填:是
* 类型string[1,64]
* 描述:
* 商户退款单号
* 示例值: 1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "out_refund_no")
private String outRefundNo;
/**
* <pre>
* 字段名:微信支付退款号
* 变量名refund_id
* 是否必填:是
* 类型string[1,32]
* 描述:
* 微信退款单号
* 示例值: 1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "refund_id")
private String refundId;
/**
* <pre>
* 字段名:退款状态
* 变量名refund_status
* 是否必填:是
* 类型string[1,16]
* 描述:
* 退款状态,枚举值:
* SUCCESS退款成功
* CLOSE退款关闭
* ABNORMAL退款异常退款到银行发现用户的卡作废或者冻结了导致原路退款银行卡失败可前往【商户平台—>交易中心】,手动处理此笔退款
* 示例值SUCCESS
* </pre>
*/
@SerializedName(value = "refund_status")
private String refundStatus;
/**
* <pre>
* 字段名:退款成功时间
* 变量名success_time
* 是否必填:否
* 类型string[1,64]
* 描述:
* 1、退款成功时间遵循rfc3339标准格式格式为YYYY-MM-DDTHH:mm:ss+TIMEZONEYYYY-MM-DD表示年月日T出现在字符串中表示time元素的开头HH:mm:ss表示时分秒TIMEZONE表示时区+08:00表示东八区时间领先UTC 8小时即北京时间。例如2015-05-20T13:29:35+08:00表示北京时间2015年5月20日13点29分35秒。
* 2、当退款状态为退款成功时返回此参数。
* 示例值2018-06-08T10:34:56+08:00
* </pre>
*/
@SerializedName(value = "success_time")
private String successTime;
/**
* <pre>
* 字段名:退款入账账户
* 变量名user_received_account
* 是否必填:是
* 类型string[1,64]
* 描述:
* 取当前退款单的退款入账方。
* 1、退回银行卡{银行名称}{卡类型}{卡尾号}
* 2、退回支付用户零钱: 支付用户零钱
* 3、退还商户: 商户基本账户、商户结算银行账户
* 4、退回支付用户零钱通支付用户零钱通
* 示例值招商银行信用卡0403
* </pre>
*/
@SerializedName(value = "user_received_account")
private String userReceivedAccount;
/**
* <pre>
* 字段名:金额信息
* 变量名amount
* 是否必填:是
* 类型object
* 描述:
* 金额信息
* </pre>
*/
@SerializedName(value = "amount")
private Amount amount;
}
@Data
@NoArgsConstructor
public static class Amount implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名:订单金额
* 变量名total
* 是否必填:是
* 类型int
* 描述:
* 订单总金额,单位为分,只能为整数,详见支付金额
* 示例值999
* </pre>
*/
@SerializedName(value = "total")
private Integer total;
/**
* <pre>
* 字段名:退款金额
* 变量名refund
* 是否必填:是
* 类型int
* 描述:
* 退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额,如果有使用券,后台会按比例退。
* 示例值999
* </pre>
*/
@SerializedName(value = "refund")
private Integer refund;
/**
* <pre>
* 字段名:用户支付金额
* 变量名payer_total
* 是否必填:是
* 类型int
* 描述:
* 用户实际支付金额,单位为分,只能为整数,详见支付金额
* 示例值999
* </pre>
*/
@SerializedName(value = "payer_total")
private Integer payerTotal;
/**
* <pre>
* 字段名:用户退款金额
* 变量名payer_refund
* 是否必填:是
* 类型int
* 描述:
* 退款给用户的金额,不包含所有优惠券金额
* 示例值999
* </pre>
*/
@SerializedName(value = "payer_refund")
private Integer payerRefund;
}
}

View File

@@ -14,7 +14,7 @@ import java.io.Serializable;
*/
@Data
@NoArgsConstructor
public class WxPayRefundNotifyV3Result implements Serializable {
public class WxPayRefundNotifyV3Result implements Serializable, WxPayBaseNotifyV3Result<WxPayRefundNotifyV3Result.DecryptNotifyResult> {
private static final long serialVersionUID = -1L;
/**
* 源数据

View File

@@ -0,0 +1,55 @@
package com.github.binarywang.wxpay.bean.request;
import com.google.gson.annotations.SerializedName;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import java.io.Serializable;
import java.util.List;
/**
* 微信支付服务商退款请求
* 文档见https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_9.shtml
*
* @author Guo Shuai
* @version 1.0
* @date 2023/3/2
*/
@Data
@NoArgsConstructor
@Accessors(chain = true)
public class WxPayPartnerRefundV3Request extends WxPayRefundV3Request implements Serializable {
private static final long serialVersionUID = -1L;
/**
* <pre>
* 字段名:子商户的商户号
* 变量名sub_mchid
* 是否必填:是
* 类型string[1, 32]
* 描述:
* 子商户商户号,由微信支付生成并下发。
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sub_mchid")
private String subMchId;
/**
* <pre>
* 字段名:退款资金来源
* 变量名funds_account
* 是否必填:否
* 类型string[1, 32]
* 描述:
* 若传递此参数则使用对应的资金账户退款,否则默认使用未结算资金退款(仅对老资金流商户适用)
* 示例值:
* UNSETTLED : 未结算资金
* AVAILABLE : 可用余额
* UNAVAILABLE : 不可用余额
* OPERATION : 运营户
* BASIC : 基本账户(含可用余额和不可用余额)
* </pre>
*/
@SerializedName(value = "funds_account")
private String fundsAccount;
}

View File

@@ -0,0 +1,610 @@
package com.github.binarywang.wxpay.bean.request;
import com.google.gson.annotations.SerializedName;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import java.io.Serializable;
import java.util.List;
/**
* 微信支付服务商下单请求对象
*
* @author Guo Shuai
* @version 1.0
* @date 2023/3/2
*/
@Data
@NoArgsConstructor
@Accessors(chain = true)
public class WxPayPartnerUnifiedOrderV3Request implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名服务商应用ID
* 变量名spAppid
* 是否必填:是
* 类型string[1,32]
* 描述:
* 由微信生成的应用ID全局唯一。请求统一下单接口时请注意APPID的应用属性例如公众号场景下需使用应用属性为公众号的APPID
* 示例值wxd678efh567hg6787
* </pre>
*/
@SerializedName(value = "sp_appid")
protected String spAppid;
/**
* <pre>
* 字段名:服务商商户号
* 变量名spMchid
* 是否必填:是
* 类型string[1,32]
* 描述:
* 服务商商户号,由微信支付生成并下发。
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sp_mchid")
protected String spMchId;
/**
* <pre>
* 字段名子商户应用ID
* 变量名subAppid
* 是否必填:否
* 类型string[1,32]
* 描述:
* 由微信生成的应用ID全局唯一。请求统一下单接口时请注意APPID的应用属性例如公众号场景下需使用应用属性为公众号的APPID
* 示例值wxd678efh567hg6787
* </pre>
*/
@SerializedName(value = "sub_appid")
protected String subAppid;
/**
* <pre>
* 字段名:子商户商户号
* 变量名subMchid
* 是否必填:是
* 类型string[1,32]
* 描述:
* 子商户商户号,由微信支付生成并下发。
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sub_mchid")
protected String subMchId;
/**
* <pre>
* 字段名:商品描述
* 变量名description
* 是否必填:是
* 类型string[1,127]
* 描述:
* 商品描述
* 示例值Image形象店-深圳腾大-QQ公仔
* </pre>
*/
@SerializedName(value = "description")
protected String description;
/**
* <pre>
* 字段名:商户订单号
* 变量名out_trade_no
* 是否必填:是
* 类型string[6,32]
* 描述:
* 商户系统内部订单号只能是数字、大小写字母_-*且在同一个商户号下唯一
* 示例值1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "out_trade_no")
protected String outTradeNo;
/**
* <pre>
* 字段名:交易结束时间
* 变量名time_expire
* 是否必填:是
* 类型string[1,64]
* 描述:
* 订单失效时间遵循rfc3339标准格式格式为YYYY-MM-DDTHH:mm:ss+TIMEZONEYYYY-MM-DD表示年月日T出现在字符串中表示time元素的开头HH:mm:ss表示时分秒TIMEZONE表示时区+08:00表示东八区时间领先UTC 8小时即北京时间。例如2015-05-20T13:29:35+08:00表示北京时间2015年5月20日 13点29分35秒。
* 示例值2018-06-08T10:34:56+08:00
* </pre>
*/
@SerializedName(value = "time_expire")
protected String timeExpire;
/**
* <pre>
* 字段名:附加数据
* 变量名attach
* 是否必填:否
* 类型string[1,128]
* 描述:
* 附加数据在查询API和支付通知中原样返回可作为自定义参数使用
* 示例值:自定义数据
* </pre>
*/
@SerializedName(value = "attach")
protected String attach;
/**
* <pre>
* 字段名:通知地址
* 变量名notify_url
* 是否必填:是
* 类型string[1,256]
* 描述:
* 通知URL必须为直接可访问的URL不允许携带查询串要求必须为https地址。
* 格式URL
* 示例值https://www.weixin.qq.com/wxpay/pay.php
* </pre>
*/
@SerializedName(value = "notify_url")
private String notifyUrl;
/**
* <pre>
* 字段名:订单优惠标记
* 变量名goods_tag
* 是否必填:否
* 类型string[1,256]
* 描述:
* 订单优惠标记
* 示例值WXG
* </pre>
*/
@SerializedName(value = "goods_tag")
private String goodsTag;
/**
* <pre>
* 字段名:电子发票入口开放标识
* 变量名support_fapiao
* 是否必填:否
* 类型boolean
* 描述传入true时支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能传此字段才可生效。
* </pre>
*/
@SerializedName(value = "support_fapiao")
private Boolean supportFapiao;
/**
* <pre>
* 字段名:订单金额
* 变量名amount
* 是否必填:是
* 类型object
* 描述:
* 订单金额信息
* </pre>
*/
@SerializedName(value = "amount")
private Amount amount;
/**
* <pre>
* 字段名:支付者
* 变量名payer
* 是否必填:是
* 类型object
* 描述:
* 支付者信息
* </pre>
*/
@SerializedName(value = "payer")
private Payer payer;
/**
* <pre>
* 字段名:优惠功能
* 变量名detail
* 是否必填:否
* 类型object
* 描述:
* 优惠功能
* </pre>
*/
@SerializedName(value = "detail")
private Discount detail;
/**
* <pre>
* 字段名:场景信息
* 变量名scene_info
* 是否必填:否
* 类型object
* 描述:
* 支付场景描述
* </pre>
*/
@SerializedName(value = "scene_info")
private SceneInfo sceneInfo;
/**
* <pre>
* 字段名:结算信息
* 变量名settle_info
* 是否必填:否
* 类型Object
* 描述:结算信息
* </pre>
*/
@SerializedName(value = "settle_info")
private SettleInfo settleInfo;
@Data
@NoArgsConstructor
public static class Amount implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名:总金额
* 变量名total
* 是否必填:是
* 类型int
* 描述:
* 订单总金额,单位为分。
* 示例值100
* </pre>
*/
@SerializedName(value = "total")
private Integer total;
/**
* <pre>
* 字段名:币类型
* 变量名currency
* 是否必填:否
* 类型string[1,16]
* 描述:
* CNY人民币境内商户号仅支持人民币。
* 示例值CNY
* </pre>
*/
@SerializedName(value = "currency")
private String currency;
}
@Data
@NoArgsConstructor
public static class Payer implements Serializable {
private static final long serialVersionUID = -1L;
/**
* <pre>
* spOpenid 和 subOpenid二选一 参考官网
* 字段名:服务商用户标识
* 变量名spOpenid
* 是否必填:是
* 类型string[1,128]
* 描述:
* 用户在服务商appid下的唯一标识。
* 示例值oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
* </pre>
*/
@SerializedName(value = "sp_openid")
private String spOpenid;
/**
* <pre>
* 字段名:子商户应用用户标识
* 变量名subOpenid
* 是否必填:是
* 类型string[1,128]
* 描述:
* 用户在子商户appid下的唯一标识。
* 示例值oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
* </pre>
*/
@SerializedName(value = "sub_openid")
private String subOpenid;
}
@Data
@NoArgsConstructor
public static class Discount implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名:订单原价
* 变量名cost_price
* 是否必填:否
* 类型int
* 描述:
* 1、商户侧一张小票订单可能被分多次支付订单原价用于记录整张小票的交易金额。
* 2、当订单原价与支付金额不相等则不享受优惠。
* 3、该字段主要用于防止同一张小票分多次支付以享受多次优惠的情况正常支付订单不必上传此参数。
* 示例值608800
* </pre>
*/
@SerializedName(value = "cost_price")
private Integer costPrice;
/**
* <pre>
* 字段名商品小票ID
* 变量名invoice_id
* 是否必填:否
* 类型string[1,32]
* 描述:
* 商品小票ID
* 示例值微信123
* </pre>
*/
@SerializedName(value = "invoice_id")
private String invoiceId;
/**
* <pre>
* 字段名:单品列表
* 变量名goods_detail
* 是否必填:否
* 类型array
* 描述:
* 单品列表信息
* 条目个数限制【16000】
* </pre>
*/
@SerializedName(value = "goods_detail")
private List<GoodsDetail> goodsDetails;
}
@Data
@NoArgsConstructor
public static class GoodsDetail implements Serializable {
private static final long serialVersionUID = -1L;
/**
* <pre>
* 字段名:商户侧商品编码
* 变量名merchant_goods_id
* 是否必填:是
* 类型string[1,32]
* 描述:
* 由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。
* 示例值:商品编码
* </pre>
*/
@SerializedName(value = "merchant_goods_id")
private String merchantGoodsId;
/**
* <pre>
* 字段名:微信侧商品编码
* 变量名wechatpay_goods_id
* 是否必填:否
* 类型string[1,32]
* 描述:
* 微信支付定义的统一商品编号(没有可不传)
* 示例值1001
* </pre>
*/
@SerializedName(value = "wechatpay_goods_id")
private String wechatpayGoodsId;
/**
* <pre>
* 字段名:商品名称
* 变量名goods_name
* 是否必填:否
* 类型string[1,256]
* 描述:
* 商品的实际名称
* 示例值iPhoneX 256G
* </pre>
*/
@SerializedName(value = "goods_name")
private String goodsName;
/**
* <pre>
* 字段名:商品数量
* 变量名quantity
* 是否必填:是
* 类型int
* 描述:
* 用户购买的数量
* 示例值1
* </pre>
*/
@SerializedName(value = "quantity")
private Integer quantity;
/**
* <pre>
* 字段名:商品单价
* 变量名unit_price
* 是否必填:是
* 类型int
* 描述:
* 商品单价,单位为分
* 示例值828800
* </pre>
*/
@SerializedName(value = "unit_price")
private Integer unitPrice;
}
@Data
@NoArgsConstructor
public static class SceneInfo implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名用户终端IP
* 变量名payer_client_ip
* 是否必填:是
* 类型string[1,45]
* 描述:
* 用户的客户端IP支持IPv4和IPv6两种格式的IP地址。
* 示例值14.23.150.211
* </pre>
*/
@SerializedName(value = "payer_client_ip")
private String payerClientIp;
/**
* <pre>
* 字段名:商户端设备号
* 变量名device_id
* 是否必填:否
* 类型string[1,32]
* 描述:
* 商户端设备号门店号或收银设备ID
* 示例值013467007045764
* </pre>
*/
@SerializedName(value = "device_id")
private String deviceId;
/**
* <pre>
* 字段名:商户门店信息
* 变量名store_info
* 是否必填:否
* 类型object
* 描述:
* 商户门店信息
* </pre>
*/
@SerializedName(value = "store_info")
private StoreInfo storeInfo;
/**
* <pre>
* 字段名H5场景信息
* 变量名h5_info
* 是否必填:否(H5支付必填)
* 类型object
* 描述:
* H5场景信息
* </pre>
*/
@SerializedName(value = "h5_info")
private H5Info h5Info;
}
@Data
@NoArgsConstructor
public static class StoreInfo implements Serializable {
private static final long serialVersionUID = -1L;
/**
* <pre>
* 字段名:门店编号
* 变量名id
* 是否必填:是
* 类型string[1,32]
* 描述:
* 商户侧门店编号
* 示例值0001
* </pre>
*/
@SerializedName(value = "id")
private String id;
/**
* <pre>
* 字段名:门店名称
* 变量名name
* 是否必填:否
* 类型string[1,256]
* 描述:
* 商户侧门店名称
* 示例值:腾讯大厦分店
* </pre>
*/
@SerializedName(value = "name")
private String name;
/**
* <pre>
* 字段名:地区编码
* 变量名area_code
* 是否必填:否
* 类型string[1,32]
* 描述: 地区编码, <a href="https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/applyments/chapter4_1.shtml">详细请见省市区编号对照表</a>。
* 示例值440305
* </pre>
*/
@SerializedName(value = "area_code")
private String areaCode;
/**
* <pre>
* 字段名:详细地址
* 变量名address
* 是否必填:是
* 类型string[1,512]
* 描述:
* 详细的商户门店地址
* 示例值广东省深圳市南山区科技中一道10000号
* </pre>
*/
@SerializedName(value = "address")
private String address;
}
@Data
@NoArgsConstructor
public static class H5Info implements Serializable {
private static final long serialVersionUID = -1L;
/**
* <pre>
* 字段名:场景类型
* 变量名type
* 是否必填:是
* 类型string[1,32]
* 描述:
* 场景类型
* 示例值iOS, Android, Wap
* </pre>
*/
@SerializedName(value = "type")
private String type;
/**
* <pre>
* 字段名:应用名称
* 变量名app_name
* 是否必填:否
* 类型string[1,64]
* 描述:
* 应用名称
* 示例值:王者荣耀
* </pre>
*/
@SerializedName(value = "app_name")
private String appName;
/**
* <pre>
* 字段名网站URL
* 变量名app_url
* 是否必填:否
* 类型string[1,128]
* 描述:
* 网站URL
* 示例值https://pay.qq.com
* </pre>
*/
@SerializedName(value = "app_url")
private String appUrl;
/**
* <pre>
* 字段名iOS平台BundleID
* 变量名bundle_id
* 是否必填:否
* 类型string[1,128]
* 描述:
* iOS平台BundleID
* 示例值com.tencent.wzryiOS
* </pre>
*/
@SerializedName(value = "bundle_id")
private String bundleId;
/**
* <pre>
* 字段名Android平台PackageName
* 变量名package_name
* 是否必填:否
* 类型string[1,128]
* 描述:
* Android平台PackageName
* 示例值com.tencent.tmgp.sgame
* </pre>
*/
@SerializedName(value = "package_name")
private String packageName;
}
@Data
@NoArgsConstructor
public static class SettleInfo implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名:是否指定分账
* 变量名profit_sharing
* 是否必填:否
* 类型boolean
* 描述:
* 是否指定分账
* 示例值false
* </pre>
*/
@SerializedName(value = "profit_sharing")
private Boolean profitSharing;
}
}