Package com.foxinmy.weixin4j.mp.api

Class CardApi

  • public class CardApi
extends MpApi
    卡券API
    Since:
    JDK 1.6
    Author:
    jinyu(foxinmy@gmail.com)
    See Also:
    卡券说明

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.foxinmy.weixin4j.token.TokenManager tokenManager  

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

        weixinExecutor

    • Constructor Summary

      Constructors 
      Constructor Description
      CardApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.foxinmy.weixin4j.http.weixin.ApiResult activateMemberCard​(com.foxinmy.weixin4j.model.card.MemberInitInfo memberInitInfo)
      激活方式说明 接口激活通常需要开发者开发用户填写资料的网页。通常有两种激活流程： 1.
      String addGiftCardPage​(com.foxinmy.weixin4j.model.card.GiftCardPage page)
      创建一个礼品卡货架
      String addGiftCardPayWhitelist​(String subMchId)
      申请礼品卡的微信支付权限
      com.foxinmy.weixin4j.http.weixin.ApiResult bindGiftCardPaySubMch​(String wxaAppid, String subMchId)
      绑定商户号到礼品卡小程序
      com.foxinmy.weixin4j.http.weixin.ApiResult consumeGiftCard​(String code, String cardId)
      当礼品卡被使用完毕或者发生转存、绑定等操作后，开发者可以通过该接口核销用户的礼品卡，使礼品卡在列表中沉底并不再被使用。
      String createCardCoupon​(com.foxinmy.weixin4j.model.card.CardCoupon cardCoupon)
      创建卡券:创建卡券接口是微信卡券的基础接口，用于创建一类新的卡券，获取card_id，创建成功并通过审核后， 商家可以通过文档提供的其他接口将卡券下发给用户，每次成功领取，库存数量相应扣除。 1.需自定义Code码的商家必须在创建卡券时候，设定use_custom_code为true，且在调用投放卡券接口时填入指定的Code码。 指定OpenID同理。特别注意：在公众平台创建的卡券均为非自定义Code类型。 2.can_share字段指领取卡券原生页面是否可分享，建议指定Code码、指定OpenID等强限制条件的卡券填写false。 3.创建成功后该卡券会自动提交审核 ，审核结果将通过事件通知商户。开发者可调用设置白名单接口设置用户白名单，领取未通过审核的卡券，测试整个卡券的使用流程。
      com.foxinmy.weixin4j.model.qr.QRResult createCardQR​(Integer expireSeconds, com.foxinmy.weixin4j.model.card.CardQR... cardQRs)
      创建卡券二维码： 开发者可调用该接口生成一张卡券二维码供用户扫码后添加卡券到卡包。
      com.alibaba.fastjson.JSONObject getCardInfo​(String cardId)
      查询某个card_id的创建信息、审核状态以及库存数量。
      com.alibaba.fastjson.JSONObject getGiftCardInfo​(String code, String cardId)
      开发者可以通过该接口查询到code对应的信息，如余额、有效期、订单号等，主要用于防止在交易完成后丢单的情况下，用于核销/余额变动时兜底处理。 注意：需在礼品卡核销前调用，否则会报40099 已核销的错误
      com.alibaba.fastjson.JSONObject getGiftCardPage​(String pageId)
      查询礼品卡货架信息
      String[] getGiftCardPageIdList()
      查询当前商户下所有的礼品卡货架id
      com.foxinmy.weixin4j.model.card.MemberUserInfo getMemberUserInfo​(String cardId, String code)
      拉取会员信息接口。
      com.alibaba.fastjson.JSONObject getOrderInfo​(String orderId)
      查询某个订单号对应的订单详情
      com.alibaba.fastjson.JSONObject getOrders​(long beginTime, long endTime, String sortType, int offset, int limit)
      批量查询礼品卡订单信息接口
      com.foxinmy.weixin4j.http.weixin.ApiResult maintainAllGiftCardPage()
      下架所有礼品卡货架
      com.foxinmy.weixin4j.http.weixin.ApiResult maintainGiftCardPage​(String pageId)
      下架礼品卡货架
      com.foxinmy.weixin4j.http.weixin.ApiResult orderRefund​(String orderId)
      对一笔礼品卡订单操作退款
      com.foxinmy.weixin4j.type.card.CardStatus queryCardStatus​(String cardId)
      查看获取卡券的审核状态
      com.foxinmy.weixin4j.http.weixin.ApiResult setActivateUserForm​(com.foxinmy.weixin4j.model.card.MemberUserForm memberUserForm)
      设置开卡字段接口 开发者在创建时填入wx_activate字段后， 需要调用该接口设置用户激活时需要填写的选项，否则一键开卡设置不生效。
      com.foxinmy.weixin4j.http.weixin.ApiResult setCardPayCell​(String cardId, boolean isOpen)
      设置卡券买单：创建卡券之后，开发者可以通过设置微信买单接口设置该card_id支持微信买单功能。值得开发者注意的是， 设置买单的card_id必须已经配置了门店，否则会报错。
      com.foxinmy.weixin4j.http.weixin.ApiResult setCardSelfConsumeCell​(String cardId, boolean isOpen)
      设置自助核销:创建卡券之后，开发者可以通过设置微信买单接口设置该card_id支持自助核销功能。值得开发者注意的是， 设置自助核销的card_id必须已经配置了门店，否则会报错。
      com.foxinmy.weixin4j.http.weixin.ApiResult setGiftCardWxaCode​(String wxaAppid, String pageId)
      上传礼品卡小程序代码 （提供小程序APPID及货架ID，由微信平台为你小程序帐号上传一套现成的礼品卡小程序，直接用于礼品卡售卖）
      com.foxinmy.weixin4j.http.weixin.ApiResult setTestWhiteList​(List<String> openIds, List<String> userNames)
      由于卡券有审核要求，为方便公众号调试，可以设置一些测试帐号，这些帐号可领取未通过审核的卡券，体验整个流程。 1.同时支持“openid”、“username”两种字段设置白名单，总数上限为10个。 2.设置测试白名单接口为全量设置，即测试名单发生变化时需调用该接口重新传入所有测试人员的ID.
      Boolean updateCardCoupon​(String cardId, com.foxinmy.weixin4j.model.card.CardCoupon card)
      支持更新所有卡券类型的部分通用字段及特殊卡券（会员卡、飞机票、电影票、会议门票）中特定字段的信息。
      com.foxinmy.weixin4j.http.weixin.ApiResult updateGiftCardPage​(com.foxinmy.weixin4j.model.card.GiftCardPage page)
      更新礼品卡货架
      com.alibaba.fastjson.JSONObject updateGiftCardUserBalance​(com.foxinmy.weixin4j.model.card.CardInfo cardInfo)
      更新用户礼品卡信息 当礼品卡被使用后，可以通过该接口变更某个礼品卡的余额信息。
      com.alibaba.fastjson.JSONObject updateMemberUserInfo​(com.foxinmy.weixin4j.model.card.MemberUpdateInfo updateInfo)
      更新会员 result_bonus 当前用户积分总额 result_balance 当前用户预存总金额 openid 用户openid

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

        getRequestUri

    • Field Detail

      • tokenManager

        protected final com.foxinmy.weixin4j.token.TokenManager tokenManager

    • Constructor Detail

      • CardApi

        public CardApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)

    • Method Detail

      • createCardCoupon

        public String createCardCoupon​(com.foxinmy.weixin4j.model.card.CardCoupon cardCoupon)
                        throws com.foxinmy.weixin4j.exception.WeixinException
        创建卡券:创建卡券接口是微信卡券的基础接口，用于创建一类新的卡券，获取card_id，创建成功并通过审核后， 商家可以通过文档提供的其他接口将卡券下发给用户，每次成功领取，库存数量相应扣除。
      • 1.需自定义Code码的商家必须在创建卡券时候，设定use_custom_code为true，且在调用投放卡券接口时填入指定的Code码。 指定OpenID同理。特别注意：在公众平台创建的卡券均为非自定义Code类型。
      • 2.can_share字段指领取卡券原生页面是否可分享，建议指定Code码、指定OpenID等强限制条件的卡券填写false。
      • 3.创建成功后该卡券会自动提交审核 ，审核结果将通过事件通知商户。开发者可调用设置白名单接口设置用户白名单，领取未通过审核的卡券，测试整个卡券的使用流程。
Parameters:
cardCoupon - 卡券对象
Returns:
卡券ID
Throws:
com.foxinmy.weixin4j.exception.WeixinException
See Also:
创建卡券, CardCoupons, MediaApi.uploadImage(java.io.InputStream, String)