@@ -2,7 +2,7 @@
<!-- NewPage -->
< html lang = "zh" >
< head >
<!-- Generated by javadoc (1.8.0_252) on Sun Dec 13 00:16:3 6 CST 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Sun Dec 13 11:04:4 6 CST 2020 -->
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< title > 类 cn.felord.payment.wechat.v3.WechatResponseEntity的使用 (payment-spring-boot 1.0.0.RELEASE API)< / title >
< meta name = "date" content = "2020-12-13" >
@@ -118,19 +118,29 @@
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#createStock-cn.felord.payment.wechat.v3.model.StocksCreateParams-" > createStock< / a > < / span > (< a href = "../../../../../../cn/felord/payment/wechat/v3/model/StocksCreateParams.html" title = "cn.felord.payment.wechat.v3.model中的类" > StocksCreateParams< / a > params)< / code >
< div class = "block" > 创建代金券批次API< / div >
< div class = "block" > 创建代金券批次API
通过调用此接口可创建代金券批次,包括 < strong > 预充值< / strong > 和 < strong > 免充值< / strong > 类型。< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#downloadStockRefundFlow-java.lang.String-" > downloadStockRefundFlow< / a > < / span > (< a href = "https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title = "java.lang中的类或接口" > String< / a > stockId)< / code >
< div class = "block" > 下载批次退款明细API< / div >
< div class = "block" > 下载批次退款明细API
数据结果包含在响应体的 < strong > csv< / strong > 字段中
可获取到某批次的退款明细数据,包括订单号、单品信息、银行流水号等,用于对账/数据分析。< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#downloadStockUseFlow-java.lang.String-" > downloadStockUseFlow< / a > < / span > (< a href = "https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title = "java.lang中的类或接口" > String< / a > stockId)< / code >
< div class = "block" > 下载批次核销明细API< / div >
< div class = "block" > 下载批次核销明细API
数据结果包含在响应体的 < strong > csv< / strong > 字段中
可获取到某批次的核销明细数据,包括订单号、单品信息、银行流水号等,用于对账/数据分析。< / div >
< / td >
< / tr >
< tr class = "rowColor" >
@@ -148,7 +158,9 @@
< tr class = "rowColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#marketingImageUpload-org.springframework.web.multipart.MultipartFile-" > marketingImageUpload< / a > < / span > (org.springframework.web.multipart.MultipartFile file)< / code >
< div class = "block" > 营销图片上传API< / div >
< div class = "block" > 营销图片上传API
媒体图片只支持JPG、BMP、PNG格式, 文件大小不能超过2M。< / div >
< / td >
< / tr >
< tr class = "altColor" >
@@ -160,37 +172,49 @@
< tr class = "rowColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#pauseStock-java.lang.String-" > pauseStock< / a > < / span > (< a href = "https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title = "java.lang中的类或接口" > String< / a > stockId)< / code >
< div class = "block" > 暂停代金券批次API< / div >
< div class = "block" > 暂停代金券批次API
通过此接口可暂停指定代金券批次。< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#queryCouponDetails-cn.felord.payment.wechat.v3.model.CouponDetailsQueryParams-" > queryCouponDetails< / a > < / span > (< a href = "../../../../../../cn/felord/payment/wechat/v3/model/CouponDetailsQueryParams.html" title = "cn.felord.payment.wechat.v3.model中的类" > CouponDetailsQueryParams< / a > params)< / code >
< div class = "block" > 查询代金券详情API< / div >
< div class = "block" > 查询代金券详情API
通过此接口可查询代金券信息,包括代金券的基础信息、状态。< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#queryMerchantsByStockId-cn.felord.payment.wechat.v3.model.StocksQueryParams-" > queryMerchantsByStockId< / a > < / span > (< a href = "../../../../../../cn/felord/payment/wechat/v3/model/StocksQueryParams.html" title = "cn.felord.payment.wechat.v3.model中的类" > StocksQueryParams< / a > params)< / code >
< div class = "block" > 查询代金券可用商户API< / div >
< div class = "block" > 查询代金券可用商户API
通过调用此接口可查询批次的可用商户号,判断券是否在某商户号可用,来决定是否展示。< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#queryStockDetail-java.lang.String-" > queryStockDetail< / a > < / span > (< a href = "https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title = "java.lang中的类或接口" > String< / a > stockId)< / code >
< div class = "block" > 查询批次详情API< / div >
< div class = "block" > 查询批次详情API
通过此接口可查询批次信息,包括批次的配置信息以及批次概况数据。< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#queryStockItems-cn.felord.payment.wechat.v3.model.StocksQueryParams-" > queryStockItems< / a > < / span > (< a href = "../../../../../../cn/felord/payment/wechat/v3/model/StocksQueryParams.html" title = "cn.felord.payment.wechat.v3.model中的类" > StocksQueryParams< / a > params)< / code >
< div class = "block" > 查询代金券可用单品API< / div >
< div class = "block" > 查询代金券可用单品API
通过此接口可查询批次的可用商品编码,判断券是否可用于某些商品,来决定是否展示。< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#queryStocksByMch-cn.felord.payment.wechat.v3.model.StocksQueryParams-" > queryStocksByMch< / a > < / span > (< a href = "../../../../../../cn/felord/payment/wechat/v3/model/StocksQueryParams.html" title = "cn.felord.payment.wechat.v3.model中的类" > StocksQueryParams< / a > params)< / code >
< div class = "block" > 条件查询批次列表API< / div >
< div class = "block" > 条件查询批次列表API
通过此接口可查询多个批次的信息,包括批次的配置信息以及批次概况数据。< / div >
< / td >
< / tr >
< tr class = "rowColor" >
@@ -208,31 +232,39 @@
< tr class = "rowColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#queryUserCouponsByMchId-cn.felord.payment.wechat.v3.model.UserCouponsQueryParams-" > queryUserCouponsByMchId< / a > < / span > (< a href = "../../../../../../cn/felord/payment/wechat/v3/model/UserCouponsQueryParams.html" title = "cn.felord.payment.wechat.v3.model中的类" > UserCouponsQueryParams< / a > params)< / code >
< div class = "block" > 根据商户号查用户的券API< / div >
< div class = "block" > 根据商户号查用户的券API
可通过该接口查询用户在某商户号可用的全部券,可用于商户的小程序/H5中, 用户"我的代金券"或"提交订单页"展示优惠信息。< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#restartStock-java.lang.String-" > restartStock< / a > < / span > (< a href = "https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title = "java.lang中的类或接口" > String< / a > stockId)< / code >
< div class = "block" > 重启代金券批次API< / div >
< div class = "block" > 重启代金券批次API
通过此接口可重启指定代金券批次。< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#sendStock-cn.felord.payment.wechat.v3.model.StocksSendParams-" > sendStock< / a > < / span > (< a href = "../../../../../../cn/felord/payment/wechat/v3/model/StocksSendParams.html" title = "cn.felord.payment.wechat.v3.model中的类" > StocksSendParams< / a > params)< / code >
< div class = "block" > 发放代金券API< / div >
< div class = "block" > 发放代金券API
商户平台/API完成制券后, 可使用发放代金券接口发券。< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#setMarketingFavorCallback-java.lang.String-" > setMarketingFavorCallback< / a > < / span > (< a href = "https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title = "java.lang中的类或接口" > String< / a > notifyUrl)< / code >
< div class = "block" > 代金券核销回调通知API< / div >
< div class = "block" > 代金券核销回调通知API。 < / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatResponseEntity.html" title = "cn.felord.payment.wechat.v3中的类" > WechatResponseEntity< / a > < com.fasterxml.jackson.databind.node.ObjectNode> < / code > < / td >
< td class = "colLast" > < span class = "typeNameLabel" > WechatMarketingFavorApi.< / span > < code > < span class = "memberNameLink" > < a href = "../../../../../../cn/felord/payment/wechat/v3/WechatMarketingFavorApi.html#startStock-java.lang.String-" > startStock< / a > < / span > (< a href = "https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title = "java.lang中的类或接口" > String< / a > stockId)< / code >
< div class = "block" > 激活代金券批次API< / div >
< div class = "block" > 激活代金券批次API
制券成功后,通过调用此接口激活批次,如果是预充值代金券,激活时会从商户账户余额中锁定本批次的营销资金。< / div >
< / td >
< / tr >
< / tbody >