CashCouponsService (service 0.2.12 API)

java.lang.Object
- com.wechat.pay.java.service.cashcoupons.CashCouponsService

public class CashCouponsService
extends java.lang.Object

CashCouponsService服务

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CashCouponsService.Builder
CashCouponsService构造器

Nested Classes
Modifier and Type	Class and Description
`static class`	`CashCouponsService.Builder` CashCouponsService构造器

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateCouponStockResponse`	`createCouponStock(CreateCouponStockRequest request)` 创建代金券批次
`AvailableMerchantCollection`	`listAvailableMerchants(ListAvailableMerchantsRequest request)` 查询代金券可用商户
`AvailableSingleitemCollection`	`listAvailableSingleitems(ListAvailableSingleitemsRequest request)` 查询可核销商品编码
`CouponCollection`	`listCouponsByFilter(ListCouponsByFilterRequest request)` 根据过滤条件查询用户的券
`StockCollection`	`listStocks(ListStocksRequest request)` 条件查询批次列表
`PauseStockResponse`	`pauseStock(PauseStockRequest request)` 暂停批次
`Callback`	`queryCallback(QueryCallbackRequest request)` 查询代金券消息通知地址
`Coupon`	`queryCoupon(QueryCouponRequest request)` 查询代金券详情
`Stock`	`queryStock(QueryStockRequest request)` 查询批次详情
`RefundFlowResponse`	`refundFlow(RefundFlowRequest request)` 下载批次退款明细
`RestartStockResponse`	`restartStock(RestartStockRequest request)` 重启批次
`SendCouponResponse`	`sendCoupon(SendCouponRequest request)` 发放指定批次的代金券
`SetCallbackResponse`	`setCallback(SetCallbackRequest request)` 设置代金券消息通知地址
`StartStockResponse`	`startStock(StartStockRequest request)` 激活开启批次
`StopStockResponse`	`stopStock(StopStockRequest request)` 终止批次
`UseFlowResponse`	`useFlow(UseFlowRequest request)` 下载批次核销明细

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - queryCallback
```
public Callback queryCallback(QueryCallbackRequest request)
```
    查询代金券消息通知地址
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    Callback
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - setCallback
```
public SetCallbackResponse setCallback(SetCallbackRequest request)
```
    设置代金券消息通知地址
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    SetCallbackResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - listCouponsByFilter
```
public CouponCollection listCouponsByFilter(ListCouponsByFilterRequest request)
```
    根据过滤条件查询用户的券
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    CouponCollection
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - queryCoupon
```
public Coupon queryCoupon(QueryCouponRequest request)
```
    查询代金券详情
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    Coupon
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - sendCoupon
```
public SendCouponResponse sendCoupon(SendCouponRequest request)
```
    发放指定批次的代金券
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    SendCouponResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - createCouponStock
```
public CreateCouponStockResponse createCouponStock(CreateCouponStockRequest request)
```
    创建代金券批次
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    CreateCouponStockResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - listAvailableMerchants
```
public AvailableMerchantCollection listAvailableMerchants(ListAvailableMerchantsRequest request)
```
    查询代金券可用商户
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    AvailableMerchantCollection
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - listAvailableSingleitems
```
public AvailableSingleitemCollection listAvailableSingleitems(ListAvailableSingleitemsRequest request)
```
    查询可核销商品编码
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    AvailableSingleitemCollection
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - listStocks
```
public StockCollection listStocks(ListStocksRequest request)
```
    条件查询批次列表
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    StockCollection
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - pauseStock
```
public PauseStockResponse pauseStock(PauseStockRequest request)
```
    暂停批次
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    PauseStockResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - queryStock
```
public Stock queryStock(QueryStockRequest request)
```
    查询批次详情
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    Stock
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - refundFlow
```
public RefundFlowResponse refundFlow(RefundFlowRequest request)
```
    下载批次退款明细
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    RefundFlowResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - restartStock
```
public RestartStockResponse restartStock(RestartStockRequest request)
```
    重启批次
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    RestartStockResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - startStock
```
public StartStockResponse startStock(StartStockRequest request)
```
    激活开启批次
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    StartStockResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - stopStock
```
public StopStockResponse stopStock(StopStockRequest request)
```
    终止批次
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    StopStockResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。
  - useFlow
```
public UseFlowResponse useFlow(UseFlowRequest request)
```
    下载批次核销明细
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    UseFlowResponse
    
    Throws:
    
    com.wechat.pay.java.core.exception.HttpException - 发送HTTP请求失败。例如构建请求参数失败、发送请求失败、I/O错误等。包含请求信息。
    
    com.wechat.pay.java.core.exception.ValidationException - 发送HTTP请求成功，验证微信支付返回签名失败。
    
    com.wechat.pay.java.core.exception.ServiceException - 发送HTTP请求成功，服务返回异常。例如返回状态码小于200或大于等于300。
    
    com.wechat.pay.java.core.exception.MalformedMessageException - 服务返回成功，content-type不为application/json、解析返回体失败。

Class CashCouponsService

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

queryCallback

setCallback

listCouponsByFilter

queryCoupon

sendCoupon

createCouponStock

listAvailableMerchants

listAvailableSingleitems

listStocks

pauseStock

queryStock

refundFlow

restartStock

startStock

stopStock

useFlow