Package com.foxinmy.weixin4j.pay.api

Class CouponApi

java.lang.Object

com.foxinmy.weixin4j.api.BaseApi

com.foxinmy.weixin4j.pay.api.MchApi

com.foxinmy.weixin4j.pay.api.CouponApi

public class CouponApi
extends MchApi

代金券API

Since:

JDK 1.6

Author:

jinyu(foxinmy@gmail.com)

See Also:

代金券

Field Summary

Fields inherited from class com.foxinmy.weixin4j.pay.api.MchApi

weixinAccount, weixinSignature

Fields inherited from class com.foxinmy.weixin4j.api.BaseApi

weixinExecutor

Constructor Summary

Constructors

Constructor	Description
CouponApi(WeixinPayAccount weixinAccount)

Method Summary

Modifier and Type	Method	Description
CouponDetail	queryCouponDetail(String openId, String couponId, String stockId)	查询代金券详细
CouponStock	queryCouponStock(String couponStockId)	查询代金券批次
CouponResult	sendCoupon(String couponStockId, String partnerTradeNo, String openId, String opUserId)	发放代金券(需要证书)

Methods inherited from class com.foxinmy.weixin4j.pay.api.MchApi

createBaseRequestMap, declareMerchant, getWeixinSignature, getWeixinSSLExecutor, weixinBundle

Methods inherited from class com.foxinmy.weixin4j.api.BaseApi

getRequestUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CouponApi

public CouponApi(WeixinPayAccount weixinAccount)

Method Detail

sendCoupon

public CouponResult sendCoupon(String couponStockId,
                               String partnerTradeNo,
                               String openId,
                               String opUserId)
                        throws WeixinException

发放代金券(需要证书)

Parameters:

couponStockId - 代金券批次id

partnerTradeNo - 商户发放凭据号（格式：商户id+日期+流水号），商户侧需保持唯一性

openId - 用户的openid

opUserId - 操作员帐号, 默认为商户号 可在商户平台配置操作员对应的api权限 可为空

Returns:

发放结果

Throws:

WeixinException

See Also:

CouponResult, 发放代金券接口

queryCouponStock

public CouponStock queryCouponStock(String couponStockId)
                             throws WeixinException

查询代金券批次

Parameters:

couponStockId - 代金券批次ID

Returns:

代金券批次信息

Throws:

WeixinException

See Also:

CouponStock, 查询代金券批次信息接口

queryCouponDetail

public CouponDetail queryCouponDetail(String openId,
                                      String couponId,
                                      String stockId)
                               throws WeixinException

查询代金券详细

Parameters:

openId - 用户ID

couponId - 代金券ID

stockId - 代金劵对应的批次号

Returns:

代金券详细信息

Throws:

WeixinException

See Also:

CouponDetail, 查询代金券详细信息接口