com.github.binarywang.wxpay.service

接口 MarketingFavorService

所有已知实现类:

MarketingFavorServiceImpl

public interface MarketingFavorService

 微信支付营销代金券接口
 

作者:

thinsstar

方法概要

限定符和类型	方法和说明
FavorCouponsCreateResult	createFavorCouponsV3(String openid, FavorCouponsCreateRequest request) 代金券接口-发放代金券API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_2.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons
FavorStocksCreateResult	createFavorStocksV3(FavorStocksCreateRequest request) 代金券接口-创建代金券批次API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_1.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/coupon-stocks
FavorCouponsUseResult	decryptNotifyDataResource(UseNotifyData data)
FavorCouponsGetResult	getFavorCouponsV3(String couponId, String appid, String openid) 代金券接口-查询代金券详情API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_6.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons/{coupon_id}
FavorStocksItemsGetResult	getFavorStocksItemsV3(String stockId, String stockCreatorMchid, Integer offset, Integer limit) 代金券接口-查询代金券可用单品API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_8.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/items
FavorStocksMerchantsGetResult	getFavorStocksMerchantsV3(String stockId, String stockCreatorMchid, Integer offset, Integer limit) 代金券接口-查询代金券可用商户API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_7.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/merchants
FavorStocksFlowGetResult	getFavorStocksRefundFlowV3(String stockId) 代金券接口-下载批次退款明细API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_11.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/refund-flow
FavorStocksFlowGetResult	getFavorStocksUseFlowV3(String stockId) 代金券接口-下载批次核销明细API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_10.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/use-flow
FavorStocksGetResult	getFavorStocksV3(String stockId, String stockCreatorMchid) 代金券接口-查询批次详情API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_5.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}
UseNotifyData	parseNotifyData(String data, SignatureHeader header)
FavorStocksPauseResult	pauseFavorStocksV3(String stockId, FavorStocksSetRequest request) 代金券接口-暂停代金券批次API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_13.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/pause
FavorCouponsQueryResult	queryFavorCouponsV3(FavorCouponsQueryRequest request) 代金券接口-根据商户号查用户的券API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_9.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons
FavorStocksQueryResult	queryFavorStocksV3(FavorStocksQueryRequest request) 代金券接口-条件查询代金券批次列表API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_4.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks
FavorStocksRestartResult	restartFavorStocksV3(String stockId, FavorStocksSetRequest request) 代金券接口-重启代金券批次API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_14.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/restart
FavorCallbacksSaveResult	saveFavorCallbacksV3(FavorCallbacksSaveRequest request) 代金券接口-设置消息通知地址API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_12.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/callbacks
FavorStocksStartResult	startFavorStocksV3(String stockId, FavorStocksSetRequest request) 代金券接口-激活代金券批次API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_3.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/start

方法详细资料

createFavorStocksV3

FavorStocksCreateResult createFavorStocksV3(FavorStocksCreateRequest request)
                                     throws WxPayException

 代金券接口-创建代金券批次API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_1.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/coupon-stocks
 

参数:

request - 请求对象

返回:

FavorStocksResult 微信返回的批次号信息。

抛出:

WxPayException - the wx pay exception

createFavorCouponsV3

FavorCouponsCreateResult createFavorCouponsV3(String openid,
                                              FavorCouponsCreateRequest request)
                                       throws WxPayException

 代金券接口-发放代金券API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_2.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons
 

参数:

openid - 用户openid

request - 请求对象

返回:

FavorStocksResult 微信返回的发放结果信息。

抛出:

WxPayException - the wx pay exception

startFavorStocksV3

FavorStocksStartResult startFavorStocksV3(String stockId,
                                          FavorStocksSetRequest request)
                                   throws WxPayException

 代金券接口-激活代金券批次API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_3.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/start
 

参数:

stockId - 批次号

request - 请求对象

返回:

FavorStocksStartResult 微信返回的激活信息。

抛出:

WxPayException - the wx pay exception

queryFavorStocksV3

FavorStocksQueryResult queryFavorStocksV3(FavorStocksQueryRequest request)
                                   throws WxPayException

 代金券接口-条件查询代金券批次列表API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_4.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks
 

参数:

request - 请求对象

返回:

FavorStocksQueryResult 微信返回的批次列表信息。

抛出:

WxPayException - the wx pay exception

getFavorStocksV3

FavorStocksGetResult getFavorStocksV3(String stockId,
                                      String stockCreatorMchid)
                               throws WxPayException

 代金券接口-查询批次详情API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_5.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}
 

参数:

stockId - 批次号

stockCreatorMchid - 创建批次的商户号

返回:

FavorStocksQueryResult 微信返回的批次详情信息。

抛出:

WxPayException - the wx pay exception

getFavorCouponsV3

FavorCouponsGetResult getFavorCouponsV3(String couponId,
                                        String appid,
                                        String openid)
                                 throws WxPayException

 代金券接口-查询代金券详情API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_6.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons/{coupon_id}
 

参数:

couponId - 代金券id

appid - 公众账号ID

openid - 用户openid

返回:

FavorCouponsGetResult 微信返回的代金券详情信息。

抛出:

WxPayException - the wx pay exception

getFavorStocksMerchantsV3

FavorStocksMerchantsGetResult getFavorStocksMerchantsV3(String stockId,
                                                        String stockCreatorMchid,
                                                        Integer offset,
                                                        Integer limit)
                                                 throws WxPayException

 代金券接口-查询代金券可用商户API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_7.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/merchants
 

参数:

stockId - 批次号

stockCreatorMchid - 创建批次的商户号

offset - 分页大小

limit - 创建批次的商户号

返回:

FavorStocksMerchantsGetResult 微信返回的代金券可用商户信息。

抛出:

WxPayException - the wx pay exception

getFavorStocksItemsV3

FavorStocksItemsGetResult getFavorStocksItemsV3(String stockId,
                                                String stockCreatorMchid,
                                                Integer offset,
                                                Integer limit)
                                         throws WxPayException

 代金券接口-查询代金券可用单品API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_8.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/items
 

参数:

stockId - 批次号

stockCreatorMchid - 创建批次的商户号

offset - 分页大小

limit - 创建批次的商户号

返回:

FavorStocksItemsGetResult 微信返回的代金券可用单品信息。

抛出:

WxPayException - the wx pay exception

queryFavorCouponsV3

FavorCouponsQueryResult queryFavorCouponsV3(FavorCouponsQueryRequest request)
                                     throws WxPayException

 代金券接口-根据商户号查用户的券API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_9.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/users/{openid}/coupons
 

参数:

request - 请求对象

返回:

FavorCouponsQueryResult 微信返回的用户的券信息。

抛出:

WxPayException - the wx pay exception

getFavorStocksUseFlowV3

FavorStocksFlowGetResult getFavorStocksUseFlowV3(String stockId)
                                          throws WxPayException

 代金券接口-下载批次核销明细API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_10.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/use-flow
 

参数:

stockId - 批次号

返回:

FavorStocksFlowGetResult 微信返回的下载信息。

抛出:

WxPayException - the wx pay exception

getFavorStocksRefundFlowV3

FavorStocksFlowGetResult getFavorStocksRefundFlowV3(String stockId)
                                             throws WxPayException

 代金券接口-下载批次退款明细API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_11.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/refund-flow
 

参数:

stockId - 批次号

返回:

FavorStocksFlowGetResult 微信返回的下载信息。

抛出:

WxPayException - the wx pay exception

saveFavorCallbacksV3

FavorCallbacksSaveResult saveFavorCallbacksV3(FavorCallbacksSaveRequest request)
                                       throws WxPayException

 代金券接口-设置消息通知地址API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_12.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/callbacks
 

参数:

request - 请求对象

返回:

FavorCallbacksSaveResult 微信返回的结果信息。

抛出:

WxPayException - the wx pay exception

pauseFavorStocksV3

FavorStocksPauseResult pauseFavorStocksV3(String stockId,
                                          FavorStocksSetRequest request)
                                   throws WxPayException

 代金券接口-暂停代金券批次API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_13.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/pause
 

参数:

request - 请求对象

返回:

FavorStocksPauseResult 微信返回的结果信息。

抛出:

WxPayException - the wx pay exception

restartFavorStocksV3

FavorStocksRestartResult restartFavorStocksV3(String stockId,
                                              FavorStocksSetRequest request)
                                       throws WxPayException

 代金券接口-重启代金券批次API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/marketing/convention/chapter3_14.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/restart
 

参数:

request - 请求对象

返回:

FavorStocksRestartResult 微信返回的结果信息。

抛出:

WxPayException - the wx pay exception

parseNotifyData

UseNotifyData parseNotifyData(String data,
                              SignatureHeader header)
                       throws WxPayException

抛出:

WxPayException

decryptNotifyDataResource

FavorCouponsUseResult decryptNotifyDataResource(UseNotifyData data)
                                         throws WxPayException

抛出:

WxPayException