public static class AliPayProperties.V1 extends Object
private static StringCERT_ALIAS CERT_ALIAS
+private static final String CERT_ALIAS+
public static class WechatPayProperties.V3 extends Object
public enum BankCode extends Enum<BankCode>
public enum WeChatServer extends Enum<WeChatServer>
private org.springframework.http.RequestEntity<?>billDownloadFunction(WechatPayV3Type type,
- String link) private org.springframework.http.RequestEntity<?>private org.springframework.http.RequestEntity<?>couponDetailFunction(WechatPayV3Type type,
- CouponDetailsQueryParams params) private org.springframework.http.RequestEntity<?>createStocksFunction(WechatPayV3Type type,
- StocksCreateParams params) private org.springframework.http.RequestEntity<?>downloadFlowFunction(WechatPayV3Type type,
- String stockId) private org.springframework.http.RequestEntity<?>marketingImageUploadFunction(WechatPayV3Type type,
- org.springframework.web.multipart.MultipartFile file) private org.springframework.http.RequestEntity<?>private org.springframework.http.RequestEntity<?>queryStocksFunction(WechatPayV3Type type,
- StocksQueryParams params) private org.springframework.http.RequestEntity<?>private org.springframework.http.RequestEntity<?>queryUserCouponsFunction(WechatPayV3Type type,
- UserCouponsQueryParams params) private org.springframework.http.RequestEntity<?>sendStocksFunction(WechatPayV3Type type,
- StocksSendParams params) private org.springframework.http.RequestEntity<?>setMarketingFavorCallbackFunction(WechatPayV3Type type,
- String notifyUrl) private org.springframework.http.RequestEntity<?>startAndRestartAndPauseStockFunction(WechatPayV3Type type,
- String stockId) private org.springframework.http.RequestEntity<?>stockDetailFunction(WechatPayV3Type type,
- String stockId) <M> WechatPayClient.Executor<M>private com.fasterxml.jackson.databind.ObjectMappermapper mapper
+private StringtenantId tenantId
+private WechatPayClientwechatPayClient wechatPayClient
+private voidapplyObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper) applyObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
+WechatPayClientprivate final com.fasterxml.jackson.databind.ObjectMapper mapper+
private final WechatPayClient wechatPayClient+
private final String tenantId+
private void applyObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)+
mapper - the mapperAllEncompassingFormHttpMessageConverterWechatMarketingFavorApi(WechatPayClient wechatPayClient,
- String tenantId) StringbillDownload(String link) billDownload(String link)
+private org.springframework.http.RequestEntity<?>billDownloadFunction(WechatPayV3Type type,
- String link) private org.springframework.http.RequestEntity<?>couponDetailFunction(WechatPayV3Type type,
- CouponDetailsQueryParams params) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>createStock(StocksCreateParams params)
-private org.springframework.http.RequestEntity<?>createStocksFunction(WechatPayV3Type type,
- StocksCreateParams params) private org.springframework.http.RequestEntity<?>downloadFlowFunction(WechatPayV3Type type,
- String stockId) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>downloadStockRefundFlow(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>downloadStockUseFlow(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>marketingImageUpload(org.springframework.web.multipart.MultipartFile file)
-private org.springframework.http.RequestEntity<?>marketingImageUploadFunction(WechatPayV3Type type,
- org.springframework.web.multipart.MultipartFile file) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>pauseStock(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryCouponDetails(CouponDetailsQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryMerchantsByStockId(StocksQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryStockDetail(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryStockItems(StocksQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryStocksByMch(StocksQueryParams params)
-private org.springframework.http.RequestEntity<?>queryStocksFunction(WechatPayV3Type type,
- StocksQueryParams params) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryUserCouponsByMchId(UserCouponsQueryParams params)
-private org.springframework.http.RequestEntity<?>queryUserCouponsFunction(WechatPayV3Type type,
- UserCouponsQueryParams params) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>restartStock(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>sendStock(StocksSendParams params)
-private org.springframework.http.RequestEntity<?>sendStocksFunction(WechatPayV3Type type,
- StocksSendParams params) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>setMarketingFavorCallback(String notifyUrl)
-private org.springframework.http.RequestEntity<?>setMarketingFavorCallbackFunction(WechatPayV3Type type,
- String notifyUrl) private org.springframework.http.RequestEntity<?>startAndRestartAndPauseStockFunction(WechatPayV3Type type,
- String stockId) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>startStock(String stockId)
-private org.springframework.http.RequestEntity<?>stockDetailFunction(WechatPayV3Type type,
- String stockId) public WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> createStock(StocksCreateParams params)-
+ 通过调用此接口可创建代金券批次，包括 预充值 和 免充值 类型。
params - the paramsprivate org.springframework.http.RequestEntity<?> createStocksFunction(WechatPayV3Type type, StocksCreateParams params)+
type - the typeparams - the paramspublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> startStock(String stockId)-
+ 制券成功后，通过调用此接口激活批次，如果是预充值代金券，激活时会从商户账户余额中锁定本批次的营销资金。
stockId - the stock idpublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> sendStock(StocksSendParams params)-
+ 商户平台/API完成制券后，可使用发放代金券接口发券。通过调用此接口可发放指定批次给指定用户，发券场景可以是小程序、H5、APP等。 +
+ 注意： + • 商户可在H5活动页面、商户小程序、商户APP等自有场景内调用该接口完成发券，商户默认只允许发放本商户号（调用发券接口的商户号）创建的代金券，如需发放其他商户商户创建的代金券，请参考常见问题Q1。
params - the paramsprivate org.springframework.http.RequestEntity<?> sendStocksFunction(WechatPayV3Type type, StocksSendParams params)+
type - the typeparams - the paramspublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> pauseStock(String stockId)-
+ 通过此接口可暂停指定代金券批次。暂停后，该代金券批次暂停发放，用户无法通过任何渠道再领取该批次的券。
stockId - the stock idpublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> restartStock(String stockId)-
+ 通过此接口可重启指定代金券批次。重启后，该代金券批次可以再次发放。
stockId - the stock idprivate org.springframework.http.RequestEntity<?> startAndRestartAndPauseStockFunction(WechatPayV3Type type, String stockId)+
type - the typestockId - the stock idpublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryStocksByMch(StocksQueryParams params)-
+ 通过此接口可查询多个批次的信息，包括批次的配置信息以及批次概况数据。
params - the paramsprivate org.springframework.http.RequestEntity<?> queryStocksFunction(WechatPayV3Type type, StocksQueryParams params)+
type - the typeparams - the paramspublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryStockDetail(String stockId)-
+ 通过此接口可查询批次信息，包括批次的配置信息以及批次概况数据。
stockId - the stock idprivate org.springframework.http.RequestEntity<?> stockDetailFunction(WechatPayV3Type type, String stockId)+
type - the typestockId - the stock idpublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryCouponDetails(CouponDetailsQueryParams params)-
+ 通过此接口可查询代金券信息，包括代金券的基础信息、状态。如代金券已核销，会包括代金券核销的订单信息（订单号、单品信息等）。
params - the paramsprivate org.springframework.http.RequestEntity<?> couponDetailFunction(WechatPayV3Type type, CouponDetailsQueryParams params)+
type - the typeparams - the paramspublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryMerchantsByStockId(StocksQueryParams params)-
+ 通过调用此接口可查询批次的可用商户号，判断券是否在某商户号可用，来决定是否展示。
params - the paramspublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryStockItems(StocksQueryParams params)-
+ 通过此接口可查询批次的可用商品编码，判断券是否可用于某些商品，来决定是否展示。
params - the paramspublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> queryUserCouponsByMchId(UserCouponsQueryParams params)-
+ 可通过该接口查询用户在某商户号可用的全部券，可用于商户的小程序/H5中，用户"我的代金券"或"提交订单页"展示优惠信息。无法查询到微信支付立减金。本接口查不到用户的微信支付立减金（又称“全平台通用券”），即在所有商户都可以使用的券，例如：摇摇乐红包；当按可用商户号查询时，无法查询用户已经核销的券
params - the paramsprivate org.springframework.http.RequestEntity<?> queryUserCouponsFunction(WechatPayV3Type type, UserCouponsQueryParams params)+
type - the typeparams - the paramspublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> downloadStockUseFlow(String stockId)-
+ 数据结果包含在响应体的 csv 字段中 +
+ 可获取到某批次的核销明细数据，包括订单号、单品信息、银行流水号等，用于对账/数据分析。
stockId - the stock idpublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> downloadStockRefundFlow(String stockId)-
+ 数据结果包含在响应体的 csv 字段中 +
+ 可获取到某批次的退款明细数据，包括订单号、单品信息、银行流水号等，用于对账/数据分析。
stockId - the stock idprivate org.springframework.http.RequestEntity<?> downloadFlowFunction(WechatPayV3Type type, String stockId)+
type - the typestockId - the stock idpublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> marketingImageUpload(org.springframework.web.multipart.MultipartFile file)-
+ 媒体图片只支持JPG、BMP、PNG格式，文件大小不能超过2M。 +
+ 通过本接口上传图片后可获得图片url地址。图片url可在微信支付营销相关的API使用，包括商家券、代金券、支付有礼等。
file - the fileprivate org.springframework.http.RequestEntity<?> marketingImageUploadFunction(WechatPayV3Type type, org.springframework.web.multipart.MultipartFile file)+
type - the typefile - the filepublic WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode> setMarketingFavorCallback(String notifyUrl)-
+ 设置核销回调通知的notifyUrl,notifyUrl需要设置应用白名单。开发者应该对代金券的核销结果进行流水记录。
notifyUrl - the notify urlWechatPayCallback.couponCallback(ResponseSignVerifyParams, Consumer)WechatPayCallback#couponCallback(ResponseSignVerifyParams, Consumer)WechatPayCallback#couponCallback(ResponseSignVerifyParams, Consumer)private org.springframework.http.RequestEntity<?> setMarketingFavorCallbackFunction(WechatPayV3Type type, String notifyUrl)+
type - the typenotifyUrl - the notify urlpublic String billDownload(String link)+
link - the link下载批次核销明细API,
+下载批次退款明细APIprivate org.springframework.http.RequestEntity<?> billDownloadFunction(WechatPayV3Type type, String link)+
type - the typelink - the linkstatic enum WechatPayCallback.EventType extends Enum<WechatPayCallback.EventType>
public static class WechatPayClient.Executor<M> extends Object
private Consumer<org.springframework.http.ResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>>responseBodyConsumer responseBodyConsumer
+private final Consumer<org.springframework.http.ResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>> responseBodyConsumer+
private Tbody body
+private inthttpStatus httpStatus
+private int httpStatus+
private T body+
private WechatPayClientwechatPayClient wechatPayClient
+private WechatPayClientWechatMarketingFavorApi(WechatPayClient wechatPayClient,
- String tenantId) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>createStock(StocksCreateParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>downloadStockRefundFlow(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>downloadStockUseFlow(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>marketingImageUpload(org.springframework.web.multipart.MultipartFile file)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>pauseStock(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryCouponDetails(CouponDetailsQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryMerchantsByStockId(StocksQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryStockDetail(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryStockItems(StocksQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryStocksByMch(StocksQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryUserCouponsByMchId(UserCouponsQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>restartStock(String stockId)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>sendStock(StocksSendParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>setMarketingFavorCallback(String notifyUrl)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>startStock(String stockId)
-private Stringcurrency currency
+private inttotal total
+private int total+
private String currency+
public static class CallbackParams.Resource extends Object+
private Stringalgorithm algorithm
+private StringassociatedData associatedData
+private Stringciphertext ciphertext
+private Stringnonce nonce
+private StringoriginalType originalType
+private String algorithm+
private String ciphertext+
private String associatedData+
private String nonce+
private String originalType+
public class CallbackParams extends Object+
static class CallbackParams.Resource CallbackParams.Resource
+private StringcreateTime createTime
+private StringeventType eventType
+private Stringid id
+private CallbackParams.Resourceresource resource
+private StringresourceType resourceType
+private Stringsummary summary
+private String id+
private String createTime+
private String eventType+
private String resourceType+
private String summary+
private CallbackParams.Resource resource+
public class ConsumeInformation extends Object
public class CouponAvailableTime extends Object+
private LongavailableTimeAfterReceive availableTimeAfterReceive
+private FixAvailableTimefixAvailableTime fixAvailableTime
+private BooleansecondDayAvailable secondDayAvailable
+private Long availableTimeAfterReceive+
private FixAvailableTime fixAvailableTime+
private Boolean secondDayAvailable+
public class CouponConsumeData extends Object
public class CouponUseRule extends Object
public class DiscountTo extends Object
public class FixAvailableTime extends Object+
private List<Long>availableWeekDay availableWeekDay
+private LongbeginTime beginTime
+private LongendTime endTime
+private List<Long> availableWeekDay+
private Long beginTime+
private Long endTime+
public class GoodsDetail extends Object
public class NormalCouponInformation extends Object
public class PayParams extends Object-
public static class PromotionDetail.GoodsDetail extends Object+
private LongdiscountAmount discountAmount
+private StringgoodsId goodsId
+private StringgoodsRemark goodsRemark
+private Longquantity quantity
+private LongunitPrice unitPrice
+private String goodsId+
private Long quantity+
private Long unitPrice+
private Long discountAmount+
private String goodsRemark+
public class PromotionDetail extends Object+
static class PromotionDetail.GoodsDetail PromotionDetail.GoodsDetail
+private Longamount amount
+private StringcouponId couponId
+private Stringcurrency currency
+private List<PromotionDetail.GoodsDetail>goodsDetail goodsDetail
+private LongmerchantContribute merchantContribute
+private Stringname name
+private LongotherContribute otherContribute
+private Stringscope scope
+private StringstockId stockId
+private Stringtype type
+private LongwechatpayContribute wechatpayContribute
+private Long amount+
private String couponId+
private String currency+
private List<PromotionDetail.GoodsDetail> goodsDetail+
private Long merchantContribute+
private String name+
private Long otherContribute+
private String scope+
private String stockId+
private String type+
private Long wechatpayContribute+
SignatureProvider.responseSignVerify(ResponseSignVerifyParams)SignatureProvider#responseSignVerify(ResponseSignVerifyParams)SignatureProvider#responseSignVerify(ResponseSignVerifyParams)public class SceneInfo extends Object+
public class SingleitemDiscountOff extends Object
private BooleannoCash
-private Boolean noCash-
+ ● 预充值代金券适用于第三方出资策划的活动，例如：满100减10. 指订单金额100元，用户实付90元，商户实收100元。设置为Boolean.FALSE
+
+ ● 免充值适用于商户策划的活动，例如：满100减10。 指订单金额100元，用户实付90元（用户领券后，在支付中直接核销10元），商户实收90元。设置为Boolean.TRUE
public class StocksSendParams extends Object+
private Stringprivate LongcouponMinimum
-private Stringprivate LongcouponValue
-private String couponValue-
private Long couponValue+
private String couponMinimum-
private Long couponMinimum+
public static class TransactionConsumeData.Amount extends Object+
private Stringcurrency currency
+private StringpayerCurrency payerCurrency
+private intpayerTotal payerTotal
+private inttotal total
+private int total+
private int payerTotal+
private String currency+
private String payerCurrency+
public static class TransactionConsumeData.Payer extends Object+
private Stringopenid openid
+private String openid+
public static class TransactionConsumeData.SceneInfo extends Object+
private StringdeviceId deviceId
+private String deviceId+
public class TransactionConsumeData extends Object+
static class TransactionConsumeData.Amount TransactionConsumeData.Amount
+static class TransactionConsumeData.Payer TransactionConsumeData.Payer
+static class TransactionConsumeData.SceneInfo TransactionConsumeData.SceneInfo
+private TransactionConsumeData.Amountamount amount
+private Stringappid appid
+private Stringattach attach
+private StringbankType bankType
+private Stringmchid mchid
+private StringoutTradeNo outTradeNo
+private TransactionConsumeData.Payerpayer payer
+private List<PromotionDetail>promotionDetail promotionDetail
+private TransactionConsumeData.SceneInfosceneInfo sceneInfo
+private StringsuccessTime successTime
+private StringtradeState tradeState
+private StringtradeStateDesc tradeStateDesc
+private StringtradeType tradeType
+private StringtransactionId transactionId
+private TransactionConsumeData.Amount amount+
private String appid+
private String attach+
private String bankType+
private String mchid+
private String outTradeNo+
private TransactionConsumeData.Payer payer+
private List<PromotionDetail> promotionDetail+
private TransactionConsumeData.SceneInfo sceneInfo+
private String successTime+
private String tradeState+
private String tradeStateDesc+
private String tradeType+
private String transactionId+
public static enum UserCouponsQueryParams.Status extends Enum<UserCouponsQueryParams.Status>+
SENDED SENDED
+USED USED
+public static final UserCouponsQueryParams.Status SENDED+
public static final UserCouponsQueryParams.Status USED+
public class UserCouponsQueryParams extends Object+
static class UserCouponsQueryParams.Status UserCouponsQueryParams.Status
+private CallbackParams.Resourceresource resource
+private org.springframework.http.RequestEntity<?>couponDetailFunction(WechatPayV3Type type,
- CouponDetailsQueryParams params) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryCouponDetails(CouponDetailsQueryParams params)
-private FixAvailableTimefixAvailableTime fixAvailableTime
+private List<PromotionDetail.GoodsDetail>goodsDetail goodsDetail
+private List<PromotionDetail>promotionDetail promotionDetail
+WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>createStock(StocksCreateParams params)
-private org.springframework.http.RequestEntity<?>createStocksFunction(WechatPayV3Type type,
- StocksCreateParams params) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryMerchantsByStockId(StocksQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryStockItems(StocksQueryParams params)
-WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryStocksByMch(StocksQueryParams params)
-private org.springframework.http.RequestEntity<?>queryStocksFunction(WechatPayV3Type type,
- StocksQueryParams params) WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>sendStock(StocksSendParams params)
-private org.springframework.http.RequestEntity<?>sendStocksFunction(WechatPayV3Type type,
- StocksSendParams params) private TransactionConsumeData.Amountamount amount
+private TransactionConsumeData.Payerpayer payer
+private TransactionConsumeData.SceneInfosceneInfo sceneInfo
+WechatResponseEntity<com.fasterxml.jackson.databind.node.ObjectNode>queryUserCouponsByMchId(UserCouponsQueryParams params)
-private org.springframework.http.RequestEntity<?>queryUserCouponsFunction(WechatPayV3Type type,
- UserCouponsQueryParams params)