MerchantExclusiveCouponService (service 0.2.11 API)

java.lang.Object
- com.wechat.pay.java.service.merchantexclusivecoupon.MerchantExclusiveCouponService

public class MerchantExclusiveCouponService
extends java.lang.Object

MerchantExclusiveCouponService服务

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MerchantExclusiveCouponService.Builder
MerchantExclusiveCouponService构造器

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateTradeInfoResponse`	`associateTradeInfo(AssociateTradeInfoRequest request)` 关联订单信息
`CouponCodeInfoResponse`	`couponCodeInfo(CouponCodeInfoRequest request)` 查询预存code详情
`CreateBusiFavorStockResponse`	`createBusifavorStock(CreateBusiFavorStockRequest request)` 创建商家券
`DeactivateCouponResponse`	`deactivateCoupon(DeactivateCouponRequest request)` 使券失效
`DeleteCouponCodeResponse`	`deleteCouponCode(DeleteCouponCodeRequest request)` 删除预存code
`DisassociateTradeInfoResponse`	`disassociateTradeInfo(DisassociateTradeInfoRequest request)` 取消关联订单信息
`GetCouponNotifyResponse`	`getCouponNotify(GetCouponNotifyRequest request)` 获取商家券事件通知地址
`CouponListResponse`	`listCouponsByFilter(ListCouponsByFilterRequest request)` 根据过滤条件查询用户的券
`ModifyBudgetResponse`	`modifyBudget(ModifyBudgetRequest request)` 修改批次预算
`void`	`modifyStockInfo(ModifyStockInfoRequest request)` 修改商家券基本信息
`SubsidyPayReceipt`	`payReceiptInfo(PayReceiptInfoRequest request)` 查询商家券营销补差付款单详情
`SubsidyPayReceiptListResponse`	`payReceiptList(PayReceiptListRequest request)` 查询商家券营销补差付款单列表
`CouponEntity`	`queryCoupon(QueryCouponRequest request)` 查询用户券详情
`CouponCodeListResponse`	`queryCouponCodeList(QueryCouponCodeListRequest request)` 查询预存code列表
`StockGetResponse`	`queryStock(QueryStockRequest request)` 查询商家券批次详情
`ReturnCouponResponse`	`returnCoupon(ReturnCouponRequest request)` 申请退券
`SubsidyReturnReceipt`	`returnReceiptInfo(ReturnReceiptInfoRequest request)` 查询商家券营销补差回退单详情
`SendCouponResponse`	`sendCoupon(SendCouponRequest request)` 向用户发券
`CouponSendGovCardResponse`	`sendGovCard(SendGovCardRequest request)` 发放政府消费卡
`SetCouponNotifyResponse`	`setCouponNotify(SetCouponNotifyRequest request)` 设置商家券事件通知地址
`SubsidyPayReceipt`	`subsidyPay(SubsidyPayRequest request)` 商家券营销补差付款
`SubsidyReturnReceipt`	`subsidyReturn(SubsidyReturnRequest request)` 商家券营销补差回退
`UploadCouponCodeResponse`	`uploadCouponCode(UploadCouponCodeRequest request)` 上传预存code
`UseCouponResponse`	`useCoupon(UseCouponRequest request)` 核销用户的券

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

- Method Detail
  - couponCodeInfo
```
public CouponCodeInfoResponse couponCodeInfo(CouponCodeInfoRequest request)
```
    查询预存code详情
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    CouponCodeInfoResponse
    
    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、解析返回体失败。
  - createBusifavorStock
```
public CreateBusiFavorStockResponse createBusifavorStock(CreateBusiFavorStockRequest request)
```
    创建商家券
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    CreateBusiFavorStockResponse
    
    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、解析返回体失败。
  - deleteCouponCode
```
public DeleteCouponCodeResponse deleteCouponCode(DeleteCouponCodeRequest request)
```
    删除预存code
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    DeleteCouponCodeResponse
    
    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、解析返回体失败。
  - modifyBudget
```
public ModifyBudgetResponse modifyBudget(ModifyBudgetRequest request)
```
    修改批次预算
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    ModifyBudgetResponse
    
    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、解析返回体失败。
  - modifyStockInfo
```
public void modifyStockInfo(ModifyStockInfoRequest request)
```
    修改商家券基本信息
    
    Parameters:
    
    request - 请求参数
    
    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、解析返回体失败。
  - queryCouponCodeList
```
public CouponCodeListResponse queryCouponCodeList(QueryCouponCodeListRequest request)
```
    查询预存code列表
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    CouponCodeListResponse
    
    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 StockGetResponse queryStock(QueryStockRequest request)
```
    查询商家券批次详情
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    StockGetResponse
    
    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、解析返回体失败。
  - uploadCouponCode
```
public UploadCouponCodeResponse uploadCouponCode(UploadCouponCodeRequest request)
```
    上传预存code
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    UploadCouponCodeResponse
    
    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、解析返回体失败。
  - getCouponNotify
```
public GetCouponNotifyResponse getCouponNotify(GetCouponNotifyRequest request)
```
    获取商家券事件通知地址
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    GetCouponNotifyResponse
    
    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、解析返回体失败。
  - setCouponNotify
```
public SetCouponNotifyResponse setCouponNotify(SetCouponNotifyRequest request)
```
    设置商家券事件通知地址
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    SetCouponNotifyResponse
    
    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、解析返回体失败。
  - associateTradeInfo
```
public AssociateTradeInfoResponse associateTradeInfo(AssociateTradeInfoRequest request)
```
    关联订单信息
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    AssociateTradeInfoResponse
    
    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、解析返回体失败。
  - deactivateCoupon
```
public DeactivateCouponResponse deactivateCoupon(DeactivateCouponRequest request)
```
    使券失效
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    DeactivateCouponResponse
    
    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、解析返回体失败。
  - disassociateTradeInfo
```
public DisassociateTradeInfoResponse disassociateTradeInfo(DisassociateTradeInfoRequest request)
```
    取消关联订单信息
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    DisassociateTradeInfoResponse
    
    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 CouponListResponse listCouponsByFilter(ListCouponsByFilterRequest request)
```
    根据过滤条件查询用户的券
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    CouponListResponse
    
    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 CouponEntity queryCoupon(QueryCouponRequest request)
```
    查询用户券详情
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    CouponEntity
    
    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、解析返回体失败。
  - returnCoupon
```
public ReturnCouponResponse returnCoupon(ReturnCouponRequest request)
```
    申请退券
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    ReturnCouponResponse
    
    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、解析返回体失败。
  - sendGovCard
```
public CouponSendGovCardResponse sendGovCard(SendGovCardRequest request)
```
    发放政府消费卡
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    CouponSendGovCardResponse
    
    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、解析返回体失败。
  - useCoupon
```
public UseCouponResponse useCoupon(UseCouponRequest request)
```
    核销用户的券
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    UseCouponResponse
    
    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、解析返回体失败。
  - payReceiptInfo
```
public SubsidyPayReceipt payReceiptInfo(PayReceiptInfoRequest request)
```
    查询商家券营销补差付款单详情
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    SubsidyPayReceipt
    
    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、解析返回体失败。
  - payReceiptList
```
public SubsidyPayReceiptListResponse payReceiptList(PayReceiptListRequest request)
```
    查询商家券营销补差付款单列表
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    SubsidyPayReceiptListResponse
    
    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、解析返回体失败。
  - returnReceiptInfo
```
public SubsidyReturnReceipt returnReceiptInfo(ReturnReceiptInfoRequest request)
```
    查询商家券营销补差回退单详情
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    SubsidyReturnReceipt
    
    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、解析返回体失败。
  - subsidyPay
```
public SubsidyPayReceipt subsidyPay(SubsidyPayRequest request)
```
    商家券营销补差付款
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    SubsidyPayReceipt
    
    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、解析返回体失败。
  - subsidyReturn
```
public SubsidyReturnReceipt subsidyReturn(SubsidyReturnRequest request)
```
    商家券营销补差回退
    
    Parameters:
    
    request - 请求参数
    
    Returns:
    
    SubsidyReturnReceipt
    
    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 MerchantExclusiveCouponService

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

couponCodeInfo

createBusifavorStock

deleteCouponCode

modifyBudget

modifyStockInfo

queryCouponCodeList

queryStock

uploadCouponCode

getCouponNotify

setCouponNotify

associateTradeInfo

deactivateCoupon

disassociateTradeInfo

listCouponsByFilter

queryCoupon

returnCoupon

sendCoupon

sendGovCard

useCoupon

payReceiptInfo

payReceiptList

returnReceiptInfo

subsidyPay

subsidyReturn