通用场景
商户通过开放平台创建商户活动
公共请求参数
业务请求参数
coupon_name必选string(32)
【描述】红包名称,商户在查询列表、详情看到的名字,同时也会显示在商户付款页面。
【示例值】xxx周年庆红包
prize_type必选string(6)
【描述】现金红包的发放形式,。枚举支持：
*fixed：固定金额。
*random：随机金额。选择随机金额时，单个红包的金额在平均金额的0.5~1.5倍之间浮动。
*fixed：固定金额。
*random：随机金额。选择随机金额时，单个红包的金额在平均金额的0.5~1.5倍之间浮动。
【示例值】random
total_money必选string(12)
【描述】活动发放的现金总金额,最小金额1.00元,最大金额10000000.00元。每个红包的最大金额不允许超过200元,最小金额不得低于0.20元。 实际的金额限制可能会根据业务进行动态调整。
【示例值】10000000.00
total_num必选string(12)
【描述】红包发放个数，最小为 1 个，最大10000000个。
说明：不同的发放形式（即prize_type）会使得发放个数含义不同：
1. 若prize_type 为 fixed（固定金额），则每个用户领取的红包金额为total_money除以total_num得到固定金额。
2. 若prize_type为 random（随机金额），则每个用户领取的红包金额为total_money除以total_num得到的平均金额值的0.5~1.5倍。由于金额是随机的，在红包金额全部被领取完时，有可能total_num有所剩余、或者大于设置值的情况。
说明：不同的发放形式（即prize_type）会使得发放个数含义不同：
1. 若prize_type 为 fixed（固定金额），则每个用户领取的红包金额为total_money除以total_num得到固定金额。
2. 若prize_type为 random（随机金额），则每个用户领取的红包金额为total_money除以total_num得到的平均金额值的0.5~1.5倍。由于金额是随机的，在红包金额全部被领取完时，有可能total_num有所剩余、或者大于设置值的情况。
【示例值】1000
prize_msg必选string(64)
【描述】活动文案，用户在账单、红包中看到的账单描述、红包描述。
【示例值】xxx送您大红包
start_time必选string(19)
【描述】活动开始时间，必须大于活动创建的时间。入参支持如下两种形式：
1. 填入固定时间，时间格式为 yyyy-mm-dd hh:mm:ss，如 2020-12-10 22:28:30
2. 填字符串 nowtime，表示创建即生效。
1. 填入固定时间，时间格式为 yyyy-mm-dd hh:mm:ss，如 2020-12-10 22:28:30
2. 填字符串 nowtime，表示创建即生效。
【示例值】nowtime
end_time必选string(19)
【描述】活动结束时间,必须大于活动开始时间, 基本格式:yyyy-mm-dd hh:mm:ss,活动有效时间最长为6个月，过期后需要创建新的活动。
【示例值】2016-09-20 22:48:30
merchant_link可选string(64)
【描述】商户打款后的跳转链接，从支付宝收银台打款成功后的跳转链接。不填时，打款后停留在支付宝支付成功页。商户实际跳转会自动添加crowdno作为跳转参数。示例: http://www.yourhomepage.com?crowdno=xxx
【示例值】http://www.weibo.com
send_freqency可选string(20)
【描述】用户在当前活动参与次数、频率限制。支持日(d)、周(w)、月(m)、终身(l)维度的限制，整个字段不填时默认值为l1（即用户终生仅能参与1次）。
注意：
1. 终身(l)限制必选且最大值为 100。
2. 日(d)、周(w)、月(m)限制可选且最多只能选择一个（即限制日领取次数就不能再限制月领取次数），频率设置必须小于等于终身(l)的次数。
3. 多个配置之间使用"|"进行分隔。如 d3|l4（表示限制用户终生只能参与4次，单日只能参与3次）。
4. 允许多次领取时，活动触发接口需要传入out_biz_no来配合。
注意：
1. 终身(l)限制必选且最大值为 100。
2. 日(d)、周(w)、月(m)限制可选且最多只能选择一个（即限制日领取次数就不能再限制月领取次数），频率设置必须小于等于终身(l)的次数。
3. 多个配置之间使用"|"进行分隔。如 d3|l4（表示限制用户终生只能参与4次，单日只能参与3次）。
4. 允许多次领取时，活动触发接口需要传入out_biz_no来配合。
【示例值】d3|l10
常见请求示例
默认示例
alipayclient alipayclient = new defaultalipayclient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","gbk","alipay_public_key","rsa2");
alipaymarketingcampaigncashcreaterequest request = new alipaymarketingcampaigncashcreaterequest();
request.setbizcontent("{"
"\"coupon_name\":\"xxx周年庆红包\","
"\"prize_type\":\"random\","
"\"total_money\":\"10000000.00\","
"\"total_num\":\"1000\","
"\"prize_msg\":\"xxx送您大红包\","
"\"start_time\":\"nowtime\","
"\"end_time\":\"2016-09-20 22:48:30\","
"\"merchant_link\":\"http://www.weibo.com\","
"\"send_freqency\":\"d3|l10\""
" }");
alipaymarketingcampaigncashcreateresponse response = alipayclient.execute(request);
if(response.issuccess()){
system.out.println("调用成功");
} else {
system.out.println("调用失败");
}说明：本示例仅供参考。
公共响应参数
业务响应参数
crowd_no必选string(128)
【描述】生成的现金红包活动号
【示例值】epojzsbg3a-czoje4qlbauea7by4ojldweeyzlaianbmnsz96o-zxufklhp5cxmx
pay_url必选string(256)
【描述】活动创建后的付款链接，返回的是urlencode编码后的字符串。需要先进行urldecode解码，然后在浏览器中进行访问，会先进行支付宝登录引导，然后商户进行付款，付款有效期24小时。
【示例值】http://cashier.stable.alipay.net/standard/lightpay/lightpaycashier.htm?orderid=0826e2e3984d6fa7b92046.rz0nn4263%
origin_crowd_no必选string(64)
【描述】原始活动号,商户排查问题时提供的活动依据
【示例值】20160901109410190092922300444004
响应示例
正常示例
异常示例
{
"alipay_marketing_campaign_cash_create_response": {
"code": "10000",
"msg": "success",
"crowd_no": "epojzsbg3a-czoje4qlbauea7by4ojldweeyzlaianbmnsz96o-zxufklhp5cxmx",
"pay_url": "http://cashier.stable.alipay.net/standard/lightpay/lightpaycashier.htm?orderid=0826e2e3984d6fa7b92046.rz0nn4263%",
"origin_crowd_no": "20160901109410190092922300444004"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| unknow_system_error | 系统繁忙，请稍后再试 | 系统繁忙，请稍后再试 |
| sensitive_word_check_failed | 红包内容含有违反法律法规、公序良俗、社会公德以及侵犯第三人合法权益的内容. | 请上传合适的红包名称、红包留言信息 |
| cash_prize_type_error | 现金红包参数校验失败,不支持的发放形式 | 目前只支持random、fixed两种形式 |
| cash_time_check_failed | 现金红包参数校验失败,活动开始结束时间不合理或活动时间过长 | 请确保结束时间在开始时间之后，且开始时间大于当前时间 |
| cash_count_too_small | 现金红包参数校验失败,红包总个数过少 | 请填写合适的红包总个数 |
| cash_amount_too_much | 现金红包参数校验失败,红包总金额过大 | 请填写合适的红包总金额 |
| cash_per_amount_too_much | 现金红包参数校验失败,单个红包金额过大 | 请填写合适的红包总个数、总金额 |
| cash_count_too_much | 现金红包参数校验失败,红包总个数过多 | 请填写合适的红包总个数 |
| cash_amount_too_small | 现金红包参数校验失败,红包总金额过小 | 请填写合适的红包总金额 |
| cash_coupon_name_check_failed | 现金红包参数校验失败,红包名称格式不对 | 请填写正确格式的红包名称 |
| cash_prize_msg_check_failed | 现金红包参数校验失败,红包留言格式不对 | 请填写正确格式的红包留言信息 |
| biz_content_is_empty | 入参不合法，biz_content字段为空 | 在请求体中填充biz_content字段 |
| biz_content_format_error | 入参不合法，biz_content字段格式错误 | 修改biz_content字段格式，符合json的格式 |
| product_is_not_opened | 产品未签约 | 请进行产品签约 |
| call_too_frequency | 调用过于频繁 | 请不要调用太频繁 |
| creator_limit_error | 该用户不允许创建活动 | 该用户没有权限或者已被加入黑名单，请使用其他账户 |
| creator_not_realname | 创建者未经过实名认证 | 请先进行实名制验证后再进行调用 |
| system_limit_error | 系统当前不允许创建活动 | 系统当前不允许创建活动，请稍后再试 |
| cash_merchant_link_check_failed | 商户跳转链接格式不对 | 请填写合法的url连接 |
| cash_per_amount_too_small | 现金红包金额校验失败,单个红包金额过小 | 请填写合适的总金额、总个数 |
| cash_send_frequency_error | 参数校验失败,发放频率设置不符合要求 | 请检查入参中的send_frequency参数是否符合格式要求 |