用户通过开放平台参与现金活动
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | alipay.marketing.campaign.cash.trigger |
format | String | 否 | 40 | 仅支持JSON | JSON |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 256 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
user_id | String | 特殊可选 | 20 | 用户唯一标识userId。user_id与login_id至少有一个非空;都非空时,以user_id为准。 | 2088102164186692 |
crowd_no | String | 必须 | 128 | 现金活动号 | 3DpriXtAGxmDPi7QyeoKeX8wwS3qbKCcnigowys220Lxs |
login_id | String | 特殊可选 | 150 | 用户登录账号名:邮箱或手机号。user_id与login_id至少有一个非空,都非空时,以user_id为准。 | username@gmail.com |
order_price | String | 可选 | 20 | 发奖金额 | 100,单位为分,代表1元 |
out_biz_no | String | 可选 | 96 | 领取红包的外部业务号,只由可由字母、数字、下划线组成。同一个活动中不可重复,相同的外部业务号会被幂等并返回之前的结果。不填时,系统会生成一个默认固定的外部业务号。 | 201702101356 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
trigger_result | String | 必填 | 5 | 是否中奖结果状态,取值为true或false。如果为true表示发奖成功,这时返回的结果中的其他字段非空;如果为false表示发奖失败,这时返回的其他字段为空 | true |
prize_amount | String | 选填 | 20 | 现金红包金额,发奖成功时非空,单位为元,保留两位小数 | 234.40 |
repeat_trigger_flag | String | 选填 | 5 | 用户是否重复领取,如果重复领取,返回的是之前的中奖结果,如果是首次领取,则走发奖流程 | true或false |
partner_id | String | 选填 | 20 | 发送红包商户签约pid,发奖成功时非空 | 2088123456789012 |
error_msg | String | 选填 | 200 | 用户领取失败的错误信息描述 | 用户实名验证不通过 |
coupon_name | String | 选填 | 32 | 红包名称,创建活动时设置,用于账单列表和详情、红包列表和详情的展示 | ***周年庆红包 |
prize_msg | String | 选填 | 64 | 活动文案,用于账单的备注展示、红包详情页的文案展示 | XXX送您大红包,祝您中秋快乐 |
merchant_logo | String | 选填 | 200 | 商户头像logo的图片url地址,用于账单和红包列表、详情的展示 | http://tfs.alipay.com/images/partner/1111111xxxxxxx_160x160 |
biz_no | String | 选填 | 96 | 支付宝业务号,发奖成功时返回,调用者可提供此字符串进行问题排查与核对等 | 20170117110070001502640004976114 |
out_biz_no | String | 选填 | 96 | 外部业务号,回填请求中的out_biz_no,请求参数中传了out_biz_no就会回传回去,如果不传就回传默认的"default_out_biz_no",请求者可用于日志记录与核对等 | 2017021319450001 |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); AlipayMarketingCampaignCashTriggerRequest request = new AlipayMarketingCampaignCashTriggerRequest(); request.setBizContent("{" + "\"user_id\":\"2088102164186692\"," + "\"crowd_no\":\"3DpriXtAGxmDPi7QyeoKeX8wwS3qbKCcnigowys220Lxs\"," + "\"login_id\":\"username@gmail.com\"," + "\"order_price\":\"100,单位为分,代表1元\"," + "\"out_biz_no\":\"201702101356\"" + "}"); AlipayMarketingCampaignCashTriggerResponse response = alipayClient.execute(request); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "alipay_marketing_campaign_cash_trigger_response":{ "msg":"Success", "code":"10000", "partner_id":"2088123456789012", "error_msg":"用户实名验证不通过", "prize_msg":"XXX送您大红包,祝您中秋快乐", "biz_no":"20170117110070001502640004976114", "prize_amount":"234.40", "merchant_logo":"http://tfs.alipay.com/images/partner/1111111xxxxxxx_160x160", "repeat_trigger_flag":"true或false", "out_biz_no":"2017021319450001", "trigger_result":"true", "coupon_name":"***周年庆红包" }, "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" }
{ "alipay_marketing_campaign_cash_trigger_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" }, "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" }
错误码 | 错误描述 | 解决方案 |
---|---|---|
BIZ_CONTENT_IS_EMPTY | 参数有误。入参不合法,biz_content字段为空 | 在请求体中填充biz_content字段 |
BIZ_CONTENT_FORMAT_ERROR | 参数有误。入参不合法,biz_content字段格式错误 | 修改biz_content字段格式,符合json的格式 |
PRODUCT_IS_NOT_OPENED | 产品未签约 | 提示商户签约该开放接口需要的产品 |
CASH_CROWD_NO_ILLEGAL | 入参不合法,现金活动号为空或非法 | 在请求中传入符合要求的现金活动号 |
CASH_CAMPAIGN_NOT_EXIST | 现金活动不存在 | 在请求中传入有效的现金活动号 |
CASH_CAMPAIGN_NOT_START | 现金活动未开始 | 确认请求中的活动配置是否正确,包括起始时间、活动状态 |
CASH_CAMPAIGN_IS_OVER | 现金活动已结束 | 确认请求中的活动配置是否正确,包括起始时间、活动状态 |
CASH_CAMP_BUDGET_INSUFFICIENT | 现金活动预算不足 | 确认活动预算是否已用完 |
CASH_CAMP_NOT_ALLOW_TRIGGER_OWN | 不能领取自己创建的现金红包 | 检查领取活动的用户userId 和 活动创建商户partnerId,不允许相同 |
CASH_CAMPAIGN_SEND_LOG_ILLEGAL | 现金活动发奖流水异常 | 上次参与活动的流水状态没有更新完成,请稍后再试 |
UNKNOW_SYSTEM_ERROR | 系统繁忙,请稍后再试 | 系统繁忙,请稍后再试 |
USER_ID_ILLEGAL | 入参不合法,user_id为空或者不合法 | 请求中传入正确的user_id |
USER_NOT_EXIST | 入参不合法,用户信息不存在 | 请传入正确的用户信息 |
ENTERPRISE_USER_NOT_SUPPORT | 企业账户不能参与活动 | 请求入参中传入个人类型的账户 |
CASH_CAMPAIGN_EMERGENCY_STOP | 现金活动暂时停止 | 业务紧急处理,暂时关停,请稍后再试 |
CAMP_OPERATOR_ILLEGAL | 非法的入参,活动创建人与调用者不一致 | 检查请求中商户partnerId是否是当前活动的创建者 |
CTU_HAS_RISK | 账号异常,请拨打支付宝客服热线95188 | 用户账户存在异常风险,提示用户拨打支付宝客服热线95188 |
USER_ACCESS_TOTAL_LIMIT | 用户总参与次数受限 | 请检查活动配置并更换用户请求 |
USER_ACCESS_FREQUENCY_LIMIT | 用户参与频率受限 | 请检查活动配置并更换用户请求 |
OUT_BIZ_NO_ILLEGAL | 外部业务号格式不正确 | 请检查out_biz_no参数的格式 |
CALL_TOO_FREQUENCY | 接口调用过于频繁 | 您已达到接口调用频率限制,请稍后再试 |
USER_CERT_NOT_PASS | 用户认证信息不符合监管要求 | 提示用户进行实名认证符合监管要求 |