com.github.binarywang.wxpay.service

接口 SubscriptionBillingService

所有已知实现类:

SubscriptionBillingServiceImpl

public interface SubscriptionBillingService

微信支付-预约扣费服务 (连续包月功能)

   微信支付预约扣费功能，支持商户在用户授权的情况下，
   按照约定的时间和金额，自动从用户的支付账户中扣取费用。
   主要用于连续包月、订阅服务等场景。
   
   文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
 

作者:

Binary Wang created on 2024-08-31

方法概要

限定符和类型	方法和说明
SubscriptionCancelResult	cancelSubscription(SubscriptionCancelRequest request) 取消预约扣费 商户可以通过该接口取消已预约的扣费。
SubscriptionInstantBillingResult	instantBilling(SubscriptionInstantBillingRequest request) 立即扣费 商户可以通过该接口立即执行扣费操作。
SubscriptionQueryResult	querySubscription(String subscriptionId) 查询预约扣费 商户可以通过该接口查询已预约的扣费信息。
SubscriptionTransactionQueryResult	queryTransactions(SubscriptionTransactionQueryRequest request) 查询扣费记录 商户可以通过该接口查询扣费记录。
SubscriptionScheduleResult	scheduleSubscription(SubscriptionScheduleRequest request) 预约扣费 商户可以通过该接口预约未来某个时间点的扣费。

方法详细资料

scheduleSubscription

SubscriptionScheduleResult scheduleSubscription(SubscriptionScheduleRequest request)
                                         throws WxPayException

预约扣费

   商户可以通过该接口预约未来某个时间点的扣费。
   适用于连续包月、订阅服务等场景。
   
   文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
   请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule
   请求方式: POST
   是否需要证书: 是
 

参数:

request - 预约扣费请求参数

返回:

预约扣费结果

抛出:

WxPayException - 微信支付异常

querySubscription

SubscriptionQueryResult querySubscription(String subscriptionId)
                                   throws WxPayException

查询预约扣费

   商户可以通过该接口查询已预约的扣费信息。
   
   文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
   请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule/{subscription_id}
   请求方式: GET
 

参数:

subscriptionId - 预约扣费ID

返回:

预约扣费查询结果

抛出:

WxPayException - 微信支付异常

cancelSubscription

SubscriptionCancelResult cancelSubscription(SubscriptionCancelRequest request)
                                     throws WxPayException

取消预约扣费

   商户可以通过该接口取消已预约的扣费。
   
   文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
   请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule/{subscription_id}/cancel
   请求方式: POST
   是否需要证书: 是
 

参数:

request - 取消预约扣费请求参数

返回:

取消预约扣费结果

抛出:

WxPayException - 微信支付异常

instantBilling

SubscriptionInstantBillingResult instantBilling(SubscriptionInstantBillingRequest request)
                                         throws WxPayException

立即扣费

   商户可以通过该接口立即执行扣费操作。
   通常用于补扣失败的费用或者特殊情况下的即时扣费。
   
   文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
   请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/instant-billing
   请求方式: POST
   是否需要证书: 是
 

参数:

request - 立即扣费请求参数

返回:

立即扣费结果

抛出:

WxPayException - 微信支付异常

queryTransactions

SubscriptionTransactionQueryResult queryTransactions(SubscriptionTransactionQueryRequest request)
                                              throws WxPayException

查询扣费记录

   商户可以通过该接口查询扣费记录。
   
   文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
   请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/transactions
   请求方式: GET
 

参数:

request - 查询扣费记录请求参数

返回:

扣费记录查询结果

抛出:

WxPayException - 微信支付异常