🆕 #3066 【微信支付】增加服务商模式V3查询订单的接口支持

This commit is contained in:
Pursuer丶 2023-06-27 14:00:06 +08:00 committed by GitHub
parent 4ce392ddba
commit ef6a814a75
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 742 additions and 16 deletions

View File

@ -11,7 +11,7 @@ import java.util.List;
* 微信支付服务商下单回调
* 文档见https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_5.shtml
*
* @author Guo Shuai
* @author Pursuer
* @version 1.0
* @date 2023/3/2
*/

View File

@ -10,7 +10,7 @@ import java.io.Serializable;
* 微信支付服务商退款回调
* 文档见https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_11.shtml
*
* @author Guo Shuai
* @author Pursuer
* @version 1.0
* @date 2023/3/2
*/

View File

@ -11,9 +11,9 @@ import java.io.Serializable;
* 服务商关闭订单请求对象类
* 文档见https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_3.shtml
*
* @author Guo Shuai
* @author Pursuer
* @version 1.0
* @date 2023/3/2
* @date 2023/6/21
*/
@Data
@NoArgsConstructor

View File

@ -0,0 +1,76 @@
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;
/**
* 服务商查询订单请求对象类
* 文档见https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_2.shtml
*
* @author Pursuer
* @version 1.0
* @date 2023/6/25
*/
@Data
@NoArgsConstructor
@Accessors(chain = true)
public class WxPayPartnerOrderQueryV3Request implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名服务商商户号
* 变量名sp_mchid
* 是否必填
* 类型string[1,32]
* 描述
* 服务商商户号由微信支付生成并下发
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sp_mchid")
private String spMchId;
/**
* <pre>
* 字段名特约商户商户号
* 变量名sp_mchid
* 是否必填
* 类型string[1,32]
* 描述
* 特约商户商户号由微信支付生成并下发
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sub_mchid")
private String subMchId;
/**
* <pre>
* 字段名微信支付订单号
* 变量名transaction_id
* 是否必填
* 类型string[1,32]
* 描述
* 微信支付系统生成的订单号
* 示例值1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "transaction_id")
private String transactionId;
/**
* <pre>
* 字段名商户订单号
* 变量名out_trade_no
* 是否必填
* 类型string[1,32]
* 描述
* 商户系统内部订单号只能是数字大小写字母_-*且在同一个商户号下唯一
* 特殊规则最小字符长度为6
* 示例值1217752501201407033233368018
* </pre>
*/
@SerializedName(value = "out_trade_no")
private String outTradeNo;
}

View File

@ -12,7 +12,7 @@ import java.util.List;
* 微信支付服务商退款请求
* 文档见https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_9.shtml
*
* @author Guo Shuai
* @author Pursuer
* @version 1.0
* @date 2023/3/2
*/

View File

@ -11,7 +11,7 @@ import java.util.List;
/**
* 微信支付服务商下单请求对象
*
* @author Guo Shuai
* @author Pursuer
* @version 1.0
* @date 2023/3/2
*/

View File

@ -0,0 +1,555 @@
package com.github.binarywang.wxpay.bean.result;
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_2.shtml
*
* @author Pursuer
* @version 1.0
* @date 2023/6/25
*/
@Data
@NoArgsConstructor
public class WxPayPartnerOrderQueryV3Result implements Serializable {
private static final long serialVersionUID = 1L;
/**
* <pre>
* 字段名服务商应用ID
* 变量名appid
* 是否必填
* 类型string[1,32]
* 描述
* 服务商申请的公众号或移动应用appid
* 示例值wxd678efh567hg6787
* </pre>
*/
@SerializedName(value = "sp_appid")
private String spAppid;
/**
* <pre>
* 字段名服务商户号
* 变量名mchid
* 是否必填
* 类型string[1,32]
* 描述
* 服务商户号由微信支付生成并下发
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sp_mchid")
private String spMchId;
/**
* <pre>
* 字段名子商户应用ID
* 变量名appid
* 是否必填
* 类型string[1,32]
* 描述
* 子商户申请的公众号或移动应用appid
* 示例值wxd678efh567hg6787
* </pre>
*/
@SerializedName(value = "sub_appid")
private String subAppid;
/**
* <pre>
* 字段名子商户商户号
* 变量名mchid
* 是否必填
* 类型string[1,32]
* 描述
* 子商户的商户号由微信支付生成并下发
* 示例值1230000109
* </pre>
*/
@SerializedName(value = "sub_mchid")
private String subMchId;
/**
* <pre>
* 字段名商户订单号
* 变量名out_trade_no
* 是否必填
* 类型string[6,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>
* 字段名交易类型
* 变量名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支付失败(其他原因如银行返回失败)
* ACCEPT已接收等待扣款
* 示例值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]
* 描述
* 商户端设备号发起扣款请求的商户服务器设备号
* 示例值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

@ -14,19 +14,19 @@ public enum PartnerTradeTypeEnum {
/**
* APP
*/
APP("/v3/pay/partner/transactions/app", "/v3/combine-transactions/app"),
APP("/v3/pay/partner/transactions/app", "/v3/combine-transactions/app", TradeTypeEnum.APP),
/**
* JSAPI 小程序
*/
JSAPI("/v3/pay/partner/transactions/jsapi", "/v3/combine-transactions/jsapi"),
JSAPI("/v3/pay/partner/transactions/jsapi", "/v3/combine-transactions/jsapi", TradeTypeEnum.JSAPI),
/**
* NATIVE
*/
NATIVE("/v3/pay/partner/transactions/native", "/v3/combine-transactions/native"),
NATIVE("/v3/pay/partner/transactions/native", "/v3/combine-transactions/native", TradeTypeEnum.NATIVE),
/**
* H5
*/
H5("/v3/pay/partner/transactions/h5", "/v3/combine-transactions/h5");
H5("/v3/pay/partner/transactions/h5", "/v3/combine-transactions/h5", TradeTypeEnum.H5);
/**
* 单独下单url
@ -37,4 +37,9 @@ public enum PartnerTradeTypeEnum {
* 合并下单url
*/
private final String combineUrl;
/**
* 直连支付枚举
*/
private final TradeTypeEnum directConnTrade;
}

View File

@ -412,6 +412,53 @@ public interface WxPayService {
*/
WxPayOrderQueryV3Result queryOrderV3(WxPayOrderQueryV3Request request) throws WxPayException;
/**
* <pre>
* 服务商模式查询订单
* 详见 <a href="https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_2.shtml">https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_2.shtml</a>
* 商户可以通过查询订单接口主动查询订单状态完成下一步的业务逻辑查询订单状态可通过微信支付订单号或商户订单号两种方式查询
* 注意
* 查询订单可通过微信支付订单号和商户订单号两种方式查询两种查询方式返回结果相同
* 需要调用查询接口的情况
* 当商户后台网络服务器等出现异常商户系统最终未接收到支付通知
* 调用支付接口后返回系统错误或未知交易状态情况
* 调用付款码支付API返回USERPAYING的状态
* 调用关单或撤销接口API之前需确认支付状态
* 接口地址
* https://api.mch.weixin.qq.com/v3/pay/partner/transactions/id/{transaction_id}
* https://api.mch.weixin.qq.com/v3/pay/partner/transactions/out-trade-no/{out_trade_no}
* </pre>
*
* @param transactionId 微信订单号
* @param outTradeNo 商户系统内部的订单号当没提供transactionId时需要传这个
* @return the wx pay order query result
* @throws WxPayException the wx pay exception
*/
WxPayPartnerOrderQueryV3Result queryPartnerOrderV3(String transactionId, String outTradeNo) throws WxPayException;
/**
* <pre>
* 服务商模式查询订单
* 详见 <a href="https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_2.shtml">https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_2.shtml</a>
* 商户可以通过查询订单接口主动查询订单状态完成下一步的业务逻辑查询订单状态可通过微信支付订单号或商户订单号两种方式查询
* 注意
* 查询订单可通过微信支付订单号和商户订单号两种方式查询两种查询方式返回结果相同
* 需要调用查询接口的情况
* 当商户后台网络服务器等出现异常商户系统最终未接收到支付通知
* 调用支付接口后返回系统错误或未知交易状态情况
* 调用付款码支付API返回USERPAYING的状态
* 调用关单或撤销接口API之前需确认支付状态
* 接口地址
* https://api.mch.weixin.qq.com/v3/pay/partner/transactions/id/{transaction_id}
* https://api.mch.weixin.qq.com/v3/pay/partner/transactions/out-trade-no/{out_trade_no}
* </pre>
*
* @param request 查询订单请求对象
* @return the wx pay order query result
* @throws WxPayException the wx pay exception
*/
WxPayPartnerOrderQueryV3Result queryPartnerOrderV3(WxPayPartnerOrderQueryV3Request request) throws WxPayException;
/**
* <pre>
* 合单查询订单API
@ -602,7 +649,6 @@ public interface WxPayService {
* @param tradeType the trade type
* @param request 请求对象注意一些参数如spAppidspMchid等不用设置方法内会自动从配置对象中获取到前提是对应配置中已经设置
* @return the wx pay unified order result
* @throws WxPayException the wx pay exception
*/
WxPayUnifiedOrderV3Result unifiedPartnerOrderV3(PartnerTradeTypeEnum tradeType, WxPayPartnerUnifiedOrderV3Request request) throws WxPayException;

View File

@ -498,6 +498,31 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
return GSON.fromJson(response, WxPayOrderQueryV3Result.class);
}
@Override
public WxPayPartnerOrderQueryV3Result queryPartnerOrderV3(String transactionId, String outTradeNo) throws WxPayException {
WxPayPartnerOrderQueryV3Request request = new WxPayPartnerOrderQueryV3Request();
request.setOutTradeNo(StringUtils.trimToNull(outTradeNo));
request.setTransactionId(StringUtils.trimToNull(transactionId));
return this.queryPartnerOrderV3(request);
}
@Override
public WxPayPartnerOrderQueryV3Result queryPartnerOrderV3(WxPayPartnerOrderQueryV3Request request) throws WxPayException {
if (StringUtils.isBlank(request.getSpMchId())) {
request.setSpMchId(this.getConfig().getMchId());
}
if (StringUtils.isBlank(request.getSubMchId())) {
request.setSubMchId(this.getConfig().getSubMchId());
}
String url = String.format("%s/v3/pay/partner/transactions/out-trade-no/%s", this.getPayBaseUrl(), request.getOutTradeNo());
if (Objects.isNull(request.getOutTradeNo())) {
url = String.format("%s/v3/pay/partner/transactions/id/%s", this.getPayBaseUrl(), request.getTransactionId());
}
String query = String.format("?sp_mchid=%s&sub_mchid=%s", request.getSpMchId(), request.getSubMchId());
String response = this.getV3(url + query);
return GSON.fromJson(response, WxPayPartnerOrderQueryV3Result.class);
}
@Override
public CombineQueryResult queryCombine(String combineOutTradeNo) throws WxPayException {
String url = String.format("%s/v3/combine-transactions/out-trade-no/%s", this.getPayBaseUrl(), combineOutTradeNo);
@ -691,15 +716,34 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
WxPayUnifiedOrderV3Result result = this.unifiedPartnerOrderV3(tradeType, request);
//获取应用ID
String appId = StringUtils.isBlank(request.getSubAppid()) ? request.getSpAppid() : request.getSubAppid();
return result.getPartnerPayInfo(tradeType, appId, request.getSubMchId(), this.getConfig().getPrivateKey());
return result.getPayInfo(tradeType.getDirectConnTrade(), appId, request.getSubMchId(), this.getConfig().getPrivateKey());
}
@Override
public WxPayUnifiedOrderV3Result unifiedPartnerOrderV3(PartnerTradeTypeEnum tradeType, WxPayPartnerUnifiedOrderV3Request request) throws WxPayException {
WxPayUnifiedOrderV3Result result = this.unifiedPartnerOrderV3(tradeType, request);
//获取应用ID
String appId = StringUtils.isBlank(request.getSubAppid()) ? request.getSpAppid() : request.getSubAppid();
return result.getPartnerPayInfo(tradeType, appId, request.getSubMchId(), this.getConfig().getPrivateKey());
if (StringUtils.isBlank(request.getSpAppid())) {
request.setSpAppid(this.getConfig().getAppId());
}
if (StringUtils.isBlank(request.getSpMchId())) {
request.setSpMchId(this.getConfig().getMchId());
}
if (StringUtils.isBlank(request.getNotifyUrl())) {
request.setNotifyUrl(this.getConfig().getNotifyUrl());
}
if (StringUtils.isBlank(request.getSubAppid())) {
request.setSubAppid(this.getConfig().getSubAppId());
}
if (StringUtils.isBlank(request.getSubMchId())) {
request.setSubMchId(this.getConfig().getSubMchId());
}
String url = this.getPayBaseUrl() + tradeType.getPartnerUrl();
String response = this.postV3(url, GSON.toJson(request));
return GSON.fromJson(response, WxPayUnifiedOrderV3Result.class);
}
@Override