淘宝开放平台

请求地址：

环境	HTTPS请求地址
正式环境	https://openapi.alipay.com/gateway.do

公共请求参数：

参数	类型	是否必填	最大长度	描述	示例值
app_id	String	是	32	支付宝分配给开发者的应用ID	2014072300007148
method	String	是	128	接口名称	alipay.marketing.campaign.cash.create
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	是	-	请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

参数	类型	是否必填	最大长度	描述	示例值
coupon_name	String	必须	32	红包名称,商户在查询列表、详情看到的名字,同时也会显示在商户付款页面。	XXX周年庆红包
prize_type	String	必须	6	现金红包的发放形式, 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选择为固定金额，每个用户领取的红包金额为total_money除以total_num得到固定金额。 (2) 若prize_type选择为随机金额，每个用户领取的红包金额为total_money除以total_num得到的平均金额值的0.5~1.5倍。由于金额是随机的，在红包金额全部被领取完时，有可能total_num有所剩余、或者大于设置值的情况。	1000
prize_msg	String	必须	64	活动文案,用户在账单、红包中看到的账单描述、红包描述	XXX送您大红包
start_time	String	必须	19	活动开始时间,必须大于活动创建的时间. (1) 填固定时间:2016-08-10 22:28:30, 基本格式:yyyy-MM-dd HH:mm:ss (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)维度的限制。其中日(D)、周(W)、月(M)最多只能选择一个,终身(L)为必填项。多个配置之间使用"\|"进行分隔。终身(L)次数限制最大为100，日(D)、周(W)、月(M)频率设置必须小于等于终身(L)的次数。整个字段不填时默认值为:L1。允许多次领取时，活动触发接口需要传入out_biz_no来配合。	D3\|L10

参数	类型	是否必填	最大长度	描述	示例值
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=

参数	类型	是否必填	最大长度	描述	示例值
crowd_no	String	必填	128	生成的现金红包活动号	EPOJZsBg3A-CZOJE4qlbAueA7By4oJLDwEeYZlAiAnbMnSZ96O-zxUfKlHp5cxmx
pay_url	String	必填	256	活动创建后的付款链接，返回的是urlencode编码后的字符串。需要先进行urldecode解码，然后在浏览器中进行访问，会先进行支付宝登录引导，然后商户进行付款。	http%3a%2f%2fcashier.stable.alipay.net%2fstandard%2flightpay%2flightPayCashier.htm%3forderId%3d0826e2e3984d6fa7b92046.rz0NN4263%
origin_crowd_no	String	必填	64	原始活动号,商户排查问题时提供的活动依据	20160901109410190092922300444004

JAVA
.NET
PHP
HTTP请求源码

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-2022: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("调用失败");
}

IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "app_id", "merchant_private_key", "json", "1.0", "RSA2", "alipay_public_key", "GBK", false);
AlipayMarketingCampaignCashCreateRequest  request= new AlipayMarketingCampaignCashCreateRequest() ;
request.BizContent="{" +
"\"coupon_name\":\"XXX周年庆红包\"," +
"\"prize_type\":\"random\"," +
"\"total_money\":\"10000000.00\"," +
"\"total_num\":\"1000\"," +
"\"prize_msg\":\"XXX送您大红包\"," +
"\"start_time\":\"NowTime\"," +
"\"end_time\":\"2016-09-2022:48:30\"," +
"\"merchant_link\":\"http://www.weibo.com\"," +
"\"send_freqency\":\"D3|L10\"" +
"}";
AlipayMarketingCampaignCashCreateResponse response=client.execute(request);
Console.WriteLine(response.Body);

$aop = new AopClient ();
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do';
$aop->appId = 'your app_id';
$aop->rsaPrivateKey = '请填写开发者私钥去头去尾去回车，一行字符串';
$aop->alipayrsaPublicKey='请填写支付宝公钥，一行字符串';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset='GBK';
$aop->format='json';
$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-2022:48:30\"," .
"\"merchant_link\":\"http://www.weibo.com\"," .
"\"send_freqency\":\"D3|L10\"" .
"}");
$result = $aop->execute ( $request); 

$responseNode = str_replace(".", "_", $request->getApiMethodName()) . "_response";
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
echo "成功";
} else {
echo "失败";
}

https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=alipay.marketing.campaign.cash.create&app_id=4161&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&biz_content=
  {
"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"
  }

//为确保安全通信，需自行验证响应示例中的sign值是否为蚂蚁金服所提供。

JSON示例

{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_marketing_campaign_cash_create_response":{
		"msg":"Success",
		"code":"10000",
		"crowd_no":"EPOJZsBg3A-CZOJE4qlbAueA7By4oJLDwEeYZlAiAnbMnSZ96O-zxUfKlHp5cxmx",
		"origin_crowd_no":"20160901109410190092922300444004",
		"pay_url":"http%3a%2f%2fcashier.stable.alipay.net%2fstandard%2flightpay%2flightPayCashier.htm%3forderId%3d0826e2e3984d6fa7b92046.rz0NN4263%"
	}
}

JSON示例

{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_marketing_campaign_cash_create_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

错误码	错误描述	解决方案
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参数是否符合格式要求

公共错误码

营销API

alipay.marketing.campaign.cash.create (创建现金活动)

公共参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

业务错误码

公共错误码