com.github.binarywang.wxpay.service

接口 MarketingBusiFavorService

所有已知实现类:

MarketingBusiFavorServiceImpl

public interface MarketingBusiFavorService

 微信支付营销商家券接口
 

作者:

yujam

方法概要

限定符和类型	方法和说明
String	buildBusiFavorCouponinfoUrl(BusiFavorCouponsUrlRequest request) 商家券接口-H5发券API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_4_1.shtml 接口链接：https://action.weixin.qq.com/busifavor/getcouponinfo
BusiFavorCallbacksResult	createBusiFavorCallbacks(BusiFavorCallbacksRequest request) 商家券接口-设置商家券事件通知地址 API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_7.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/callbacks
BusiFavorStocksCreateResult	createBusiFavorStocksV3(BusiFavorStocksCreateRequest request) 商家券接口-创建商家券API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_1.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks
BusiFavorCouponsDeactivateResult	deactiveBusiFavorCoupons(BusiFavorCouponsDeactivateRequest request) 商家券接口-使券失效API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_15.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/deactivate
BusiFavorStocksGetResult	getBusiFavorStocksV3(String stockId) 商家券接口-查询商家券详情API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_2.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}
BusiFavorNotifyResult	notifyBusiFavor(String url, BusiFavorNotifyRequest request) 商家券接口-领券事件回调通知API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_15.shtml
BusiFavorCallbacksResult	queryBusiFavorCallbacks(BusiFavorCallbacksRequest request) 商家券接口-查询商家券事件通知地址 API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_8.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/callbacks
BusiFavorCouponsAssociateResult	queryBusiFavorCouponsAssociate(BusiFavorCouponsAssociateRequest request) 商家券接口-关联订单信息 API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_9.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/associate
BusiFavorCouponsAssociateResult	queryBusiFavorCouponsDisAssociate(BusiFavorCouponsAssociateRequest request) 商家券接口-取消关联订单信息 API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_10.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/disassociate
BusiFavorSubsidyResult	queryBusiFavorSubsidyPayReceipts(String subsidyReceiptId) 商家券接口-查询营销补差付款单详情API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_17.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/pay-receipts/{subsidy_receipt_id}
BusiFavorQueryUserCouponsResult	queryBusiFavorUsersCoupons(BusiFavorQueryUserCouponsRequest request) 商家券接口-根据过滤条件查询用户券API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_4.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/{openid}/coupons
BusiFavorQueryOneUserCouponsResult	queryOneBusiFavorUsersCoupons(BusiFavorQueryOneUserCouponsRequest request) 商家券接口-查询用户单张券详情API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_5.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/{openid}/coupons/{coupon_code}/appids/{appid}
BusiFavorCouponsReturnResult	returnBusiFavorCoupons(BusiFavorCouponsReturnRequest request) 商家券接口-申请退款API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_13.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/return
BusiFavorSubsidyResult	subsidyBusiFavorPayReceipts(BusiFavorSubsidyRequest request) 商家券接口-营销补差付款API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_16.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/pay-receipts
BusiFavorStocksBudgetResult	updateBusiFavorStocksBudget(String stockId, BusiFavorStocksBudgetRequest request) 商家券接口-修改批次预算 API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_11.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}/budget
String	updateBusiFavorStocksV3(String stockId, BusiFavorStocksCreateRequest request) 商家券接口-创建商家券API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_12.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}
BusiFavorCouponCodeResult	uploadBusiFavorCouponCodes(String stockId, BusiFavorCouponCodeRequest request) 商家券接口-上传预存code API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_6.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}/couponcodes
BusiFavorCouponsUseResult	verifyBusiFavorCouponsUseV3(BusiFavorCouponsUseRequest request) 商家券接口-核销用户券API 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_3.shtml 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/use

方法详细资料

createBusiFavorStocksV3

BusiFavorStocksCreateResult createBusiFavorStocksV3(BusiFavorStocksCreateRequest request)
                                             throws WxPayException

 商家券接口-创建商家券API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_1.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks
 

参数:

request - 请求对象 BusiFavorStocksCreateRequest

返回:

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

抛出:

WxPayException - the wx pay exception

getBusiFavorStocksV3

BusiFavorStocksGetResult getBusiFavorStocksV3(String stockId)
                                       throws WxPayException

 商家券接口-查询商家券详情API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_2.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}
 

参数:

stockId - 微信为每个商家券批次分配的唯一ID

返回:

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

抛出:

WxPayException - the wx pay exception

verifyBusiFavorCouponsUseV3

BusiFavorCouponsUseResult verifyBusiFavorCouponsUseV3(BusiFavorCouponsUseRequest request)
                                               throws WxPayException

 商家券接口-核销用户券API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_3.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/use
 

参数:

request - 请求对象 BusiFavorCouponsUseRequest

返回:

BusiFavorCouponsUseResult 微信返回的信息。

抛出:

WxPayException - the wx pay exception

buildBusiFavorCouponinfoUrl

String buildBusiFavorCouponinfoUrl(BusiFavorCouponsUrlRequest request)
                            throws WxPayException

 商家券接口-H5发券API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_4_1.shtml
 接口链接：https://action.weixin.qq.com/busifavor/getcouponinfo
 

参数:

request - 请求对象 BusiFavorCouponsUrlRequest

返回:

String H5领券地址

抛出:

WxPayException - the wx pay exception

queryBusiFavorUsersCoupons

BusiFavorQueryUserCouponsResult queryBusiFavorUsersCoupons(BusiFavorQueryUserCouponsRequest request)
                                                    throws WxPayException

 商家券接口-根据过滤条件查询用户券API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_4.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/{openid}/coupons
 

参数:

request - 请求对象 BusiFavorQueryUserCouponsRequest

返回:

BusiFavorQueryUserCouponsResult

抛出:

WxPayException - the wx pay exception

queryOneBusiFavorUsersCoupons

BusiFavorQueryOneUserCouponsResult queryOneBusiFavorUsersCoupons(BusiFavorQueryOneUserCouponsRequest request)
                                                          throws WxPayException

 商家券接口-查询用户单张券详情API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_5.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/users/{openid}/coupons/{coupon_code}/appids/{appid}
 

参数:

request - 请求对象 BusiFavorQueryOneUserCouponsResult

返回:

BusiFavorQueryOneUserCouponsRequest

抛出:

WxPayException - the wx pay exception

uploadBusiFavorCouponCodes

BusiFavorCouponCodeResult uploadBusiFavorCouponCodes(String stockId,
                                                     BusiFavorCouponCodeRequest request)
                                              throws WxPayException

 商家券接口-上传预存code API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_6.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}/couponcodes
 

参数:

stockId - 批次号

request - 请求对象 BusiFavorCouponCodeRequest

返回:

BusiFavorCouponCodeResult

抛出:

WxPayException - the wx pay exception

createBusiFavorCallbacks

BusiFavorCallbacksResult createBusiFavorCallbacks(BusiFavorCallbacksRequest request)
                                           throws WxPayException

 商家券接口-设置商家券事件通知地址 API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_7.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/callbacks
 

参数:

request - 请求对象 BusiFavorCallbacksRequest

返回:

BusiFavorCallbacksResult

抛出:

WxPayException - the wx pay exception

queryBusiFavorCallbacks

BusiFavorCallbacksResult queryBusiFavorCallbacks(BusiFavorCallbacksRequest request)
                                          throws WxPayException

 商家券接口-查询商家券事件通知地址 API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_8.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/callbacks
 

参数:

request - 请求对象 BusiFavorCallbacksRequest

返回:

BusiFavorCallbacksResult

抛出:

WxPayException - the wx pay exception

queryBusiFavorCouponsAssociate

BusiFavorCouponsAssociateResult queryBusiFavorCouponsAssociate(BusiFavorCouponsAssociateRequest request)
                                                        throws WxPayException

 商家券接口-关联订单信息 API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_9.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/associate
 

参数:

request - 请求对象 BusiFavorCouponsAssociateRequest

返回:

BusiFavorCouponsAssociateResult

抛出:

WxPayException - the wx pay exception

queryBusiFavorCouponsDisAssociate

BusiFavorCouponsAssociateResult queryBusiFavorCouponsDisAssociate(BusiFavorCouponsAssociateRequest request)
                                                           throws WxPayException

 商家券接口-取消关联订单信息 API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_10.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/disassociate
 

参数:

request - 请求对象 BusiFavorCouponsAssociateRequest

返回:

BusiFavorCouponsAssociateResult

抛出:

WxPayException - the wx pay exception

updateBusiFavorStocksBudget

BusiFavorStocksBudgetResult updateBusiFavorStocksBudget(String stockId,
                                                        BusiFavorStocksBudgetRequest request)
                                                 throws WxPayException

 商家券接口-修改批次预算 API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_11.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}/budget
 

参数:

stockId - 批次号

request - 请求对象 BusiFavorStocksBudgetRequest

返回:

BusiFavorStocksBudgetResult

抛出:

WxPayException - the wx pay exception

updateBusiFavorStocksV3

String updateBusiFavorStocksV3(String stockId,
                               BusiFavorStocksCreateRequest request)
                        throws WxPayException

 商家券接口-创建商家券API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_12.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/{stock_id}
 

参数:

stockId - 批次号

request - 请求对象 BusiFavorStocksCreateRequest

返回:

String 处理成功 应答无内容。

抛出:

WxPayException - the wx pay exception

returnBusiFavorCoupons

BusiFavorCouponsReturnResult returnBusiFavorCoupons(BusiFavorCouponsReturnRequest request)
                                             throws WxPayException

 商家券接口-申请退款API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_13.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/return
 

参数:

request - 请求对象 BusiFavorCouponsReturnRequest

返回:

BusiFavorCouponsReturnResult

抛出:

WxPayException - the wx pay exception

deactiveBusiFavorCoupons

BusiFavorCouponsDeactivateResult deactiveBusiFavorCoupons(BusiFavorCouponsDeactivateRequest request)
                                                   throws WxPayException

 商家券接口-使券失效API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_15.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/deactivate
 

参数:

request - 请求对象 BusiFavorCouponsDeactivateRequest

返回:

BusiFavorCouponsDeactivateResult

抛出:

WxPayException - the wx pay exception

subsidyBusiFavorPayReceipts

BusiFavorSubsidyResult subsidyBusiFavorPayReceipts(BusiFavorSubsidyRequest request)
                                            throws WxPayException

 商家券接口-营销补差付款API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_16.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/pay-receipts
 

参数:

request - 请求对象 BusiFavorSubsidyResult

返回:

BusiFavorSubsidyRequest

抛出:

WxPayException - the wx pay exception

queryBusiFavorSubsidyPayReceipts

BusiFavorSubsidyResult queryBusiFavorSubsidyPayReceipts(String subsidyReceiptId)
                                                 throws WxPayException

 商家券接口-查询营销补差付款单详情API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_17.shtml
 接口链接：https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/pay-receipts/{subsidy_receipt_id}
 

参数:

subsidyReceiptId - 补差付款唯一单号

返回:

BusiFavorSubsidyRequest

抛出:

WxPayException - the wx pay exception

notifyBusiFavor

BusiFavorNotifyResult notifyBusiFavor(String url,
                                      BusiFavorNotifyRequest request)
                               throws WxPayException

 商家券接口-领券事件回调通知API
 文档详见: https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_2_15.shtml
 

参数:

url - 回调地址

request - 领券事件回调通知请求对象

返回:

BusiFavorNotifyResult

抛出:

WxPayException - the wx pay exception