使用token的领券接口,支持口碑客券和非口碑客券
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | koubei.advert.delivery.item.apply |
format | String | 否 | 40 | 仅支持JSON | JSON |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
auth_token | String | 是 | 40 | 针对用户授权接口,获取用户相关数据时,用于标识用户授权关系。详见用户信息授权 | |
app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
adv_id | String | 必须 | 32 | 领券时触发的id,在外投场景下,用的是广告id | 2016080200158002000000050098 |
tag | String | 可选 | 50 | 推广参与打标(无实际业务作用,后期可供ISV分析不同渠道的推广效能) | 渠道1 |
channel_code | String | 必须 | 50 | 渠道编号,适用于媒体类发券 | didi |
out_biz_no | String | 必须 | 128 | 外部流水号,用于区别每次请求的流水号 | 43246fashfdh345354y |
channel_id | String | 可选 | 32 | 适用于在推广者主站上注册的渠道编号 | 4324354 |
shop_id | String | 可选 | 32 | 领取优惠的门店id | 432456464565 |
recommend_id | String | 可选 | 128 | 券推荐时输出给合作伙伴的id,需要在领券的时候传回来 | 4gfhhdgdfgdh |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
benefit_id | String | 必填 | 32 | 广告id对应的权益id | 201703010000000000000 |
benefit_detail | String | 必填 | 1024 |
权益详细信息:
partnerId:商户ID(用于打开手机钱包券详情) |
{"partnerId":"2088202881342152"} |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | AlipayClient alipayClient = new DefaultAlipayClient( "https://openapi.alipay.com/gateway.do" , "app_id" , "your private_key" , "json" , "GBK" , "alipay_public_key" , "RSA2" ); KoubeiAdvertDeliveryItemApplyRequest request = new KoubeiAdvertDeliveryItemApplyRequest(); request.setBizContent( "{" + "\"adv_id\":\"2016080200158002000000050098\"," + "\"tag\":\"渠道1\"," + "\"channel_code\":\"didi\"," + "\"out_biz_no\":\"43246fashfdh345354y\"," + "\"channel_id\":\"4324354\"," + "\"shop_id\":\"432456464565\"," + "\"recommend_id\":\"4gfhhdgdfgdh\"" + " }" ); KoubeiAdvertDeliveryItemApplyResponse response = alipayClient.execute(request,accessToken); if (response.isSuccess()){ System.out.println( "调用成功" ); } else { System.out.println( "调用失败" ); } |
1 2 3 4 5 6 7 8 9 | { "sign" : "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" , "koubei_advert_delivery_item_apply_response" :{ "msg" : "Success" , "code" : "10000" , "benefit_detail" : "{\"partnerId\":\"2088202881342152\"}" , "benefit_id" : "201703010000000000000" } } |
1 2 3 4 5 6 7 8 9 | { "sign" : "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" , "koubei_advert_delivery_item_apply_response" :{ "msg" : "Service Currently Unavailable" , "code" : "20000" , "sub_msg" : "系统繁忙" , "sub_code" : "isp.unknow-error" } } |
错误码 | 错误描述 | 解决方案 |
---|---|---|
INVALID_PARAMETER | 参数有误 | 需要外围补全信息 |
BUYER_NOT_CERTIFIED | 你尚未实名认证,请认证后再领取优惠 | 未实名认证 |
VOUCHER_ALREADY_OBTAINED | 该优惠已领,详见使用须知 | 不能重复领券 |
VOUCHER_QUANTITY_LIMIT_EXCEED | 你还有5个优惠未使用,不能再领取了 | 使用优惠后再来领取 |
VOUCHER_DAILY_LIMIT_EXCEED | 今天你在该商家领取折扣次数达上限,请改天再来 | 当日领取超限 |
ITEM_INVENTORY_NOT_ENOUGH | 优惠领光了 | 优惠领光了 |
ITEM_NOT_IN_THIS_SHOP_SALES | 不是该商家的优惠,不能领取 | 检查门店和优惠的关系 |
VOUCHER_ACTIVITY_NOT_STARTED | 活动未开始 | 活动还未开始 |
VOUCHER_ACTIVITY_EXPIRED | 活动已结束 | 请检查活动时间 |
ITEM_NOT_AVAILABLE | 优惠不在领取时间内 | 请检查优惠上架时间 |
VOUCHER_WEEKLY_LIMIT_EXCEED | 本周你在该活动或该商家的优惠领取次数达上限 | 周领取次数超限 |
VOUCHER_MONTHLY_LIMIT_EXCEED | 本月你在该活动或该商家的优惠领取次数达上限 | 月领取次数超限 |
TRANS_BUYER_NOT_STUDENT | 该优惠仅限学生领取 | 学生专享优惠 |
VOUCHER_PERMANENTLY_LIMIT_EXCEED | 你在该活动或该商家的优惠领取次数超限,详见活动说明或商家使用须知 | 优惠整体次数超限 |
MOBILE_LIMIT_EXCEED | 你在该活动或该商家的优惠领取次数超限,详见活动说明或商家使用须知 | 手机设备领取超限 |
MOBILE_NO_LIMIT_EXCEED | 你在该活动或该商家的优惠领取次数超限,详见活动说明或商家使用须知 | 手机号领取超限 |
CERTIFY_NO_LIMIT_EXCEED | 你在该活动或该商家的优惠领取次数超限,详见活动说明或商家使用须知 | 证件号领取超限 |
CROWD_LIMIT_NOT_MATCH_ERROR | 暂无领取资格,详情请咨询商家 | 圈人券 |
BIZ_ERROR | 业务异常会员专属,请先注册会员 | 会员券 |
BIZ_ERROR | 业务异常很遗憾,该券限商家新会员专享 | 新人券 |
BIZ_ERROR | 业务异常领取失败 | 通用的领取失败 |
SYSTEM_ERROR | 系统繁忙 | 需要重试 |