淘宝开放平台 - 文档中心

请求地址：

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

公共请求参数：

参数	类型	是否必填	最大长度	描述	示例值
app_id	String	是	32	支付宝分配给开发者的应用ID	2014072300007148
method	String	是	128	接口名称	alipay.open.wangyan.test.delete
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
notify_url	String	否	256	支付宝服务器主动通知商户服务器里指定的页面http/https路径。	http://api.test.alipay.net/atinterface/receive_notify.htm
app_auth_token	String	否	40	详见应用授权概述
biz_content	String	是	-	请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

参数	类型	是否必填	最大长度	描述	示例值
user_name	String	可选	1	2	1
test	AlipayDataItemVoucherTemplete	可选	-	dffafad
└ voucher_type String 必填 20 券类型：单品代金券为CASH类型，全场折扣券为DISCOUNT类型 DISCOUNT └ value_amount Price 可选 20 价值金额 CASH类型为代金券金额 DISCOUNT类型为优惠封顶金额 100 └ threshold_amount Price 可选 20 起步数量，用于指定可享受优惠的起步单品购买数量 90 └ reduce_to_amount Price 可选 20 单品代金券中的减至金额 88 └ original_amount Price 可选 20 商品原金额，只有单品代金券有，丽人行业需要填写此字段 100 └ original_rate String 可选 10 券原折扣 0.9 └ discount_rate String 可选 10 折扣率，填写0~1间的小数且不包括0和1，如八折则传入0.8 9.5 └ valid_period Number 可选 20 领券之后多长时间内可以核销，单位：分钟，传入数值需大于1440（一天） 3600 └ voucher_desc String 可选 30 券的描述信息，目前客户端将统一展示“折扣须知” 使用规则 └ threshold_quantity String 可选 20 起步数量，用于指定可享受优惠的起步单品购买数量 20 desc_details AlipayDataItemDescription [] 必填 4000 券使用规则描述，包括描述标题及描述内容列表 └ title String 可选 30 描述标题，不得超过15个中文字符套餐材料 └ details String [] 可选 600 标题下的描述列表我是描述1,我是描述2 └ images String [] 可选 3000 明细图片列表 80fafaljl,dajf90 └ url String 可选 255 套餐使用说明链接，必须是https的地址链接 https://www.taobao.com external_goods_list AlipayDataItemGoodsList 可选 4000 外部单品列表 └ desc String 必填 100 单品的描述信息我是描述 └ goods_list String [] 必填 3000 单品id列表 123213,sdfdsfasd limit_period_info_list AlipayDataItemLimitPeriodInfo 可选 3000 使用时间规则，控制商品的生效时间 └ unit String 必填 20 单位描述，分为： MINUTE（分钟） HOUR（小时） WEEK_DAY（星期几） DAY（日） WEEK（周） MONTH（月） ALL（整个销售周期） WEEK_DAY └ rule String 必填 20 区间范围枚举，分为： INCLUDE（包含） EXCLUDE（排除） INCLUDE_INTERVAL └ value Number [] 必填 10 区间范围值 3,4 └ delay_minute Number 可选 20 延迟生效时间（手动领取条件下，可跟valid_period组合使用） 0 └ rounding_rule String 可选 20 折扣金额取整规则 AUTO_ROUNDING_YUAN：自动抹零到元 AUTO_ROUNDING_JIAO：自动抹零到角 ROUNDING_UP_YUAN：四舍五入到元 ROUNDING_UP_JIAO：四舍五入到角 ROUNDING_UP_YUAN
aaa	String	可选	1	1	1

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

参数	类型	是否必填	最大长度	描述	示例值

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");
AlipayOpenWangyanTestDeleteRequest request = new AlipayOpenWangyanTestDeleteRequest();
request.setBizContent("{" +
"\"user_name\":\"1\"," +
"\"test\":{" +
"\"voucher_type\":\"DISCOUNT\"," +
"\"value_amount\":100," +
"\"threshold_amount\":90," +
"\"reduce_to_amount\":88," +
"\"original_amount\":100," +
"\"original_rate\":\"0.9\"," +
"\"discount_rate\":\"9.5\"," +
"\"valid_period\":3600," +
"\"voucher_desc\":\"使用规则\"," +
"\"threshold_quantity\":\"20\"," +
"\"desc_details\":[{" +
"\"title\":\"套餐材料\"," +
"\"details\":[" +
"\"我是描述1\",\"我是描述2\"" +
"]," +
"\"images\":[" +
"\"80fafaljl\",\"dajf90\"" +
"]," +
"\"url\":\"https://www.taobao.com\"" +
"}]," +
"\"external_goods_list\":{" +
"\"desc\":\"我是描述\"," +
"\"goods_list\":[" +
"\"123213\",\"sdfdsfasd\"" +
"]" +
"}," +
"\"limit_period_info_list\":{" +
"\"unit\":\"WEEK_DAY\"," +
"\"rule\":\"INCLUDE_INTERVAL\"," +
"\"value\":[" +
"3,4" +
"]" +
"}," +
"\"delay_minute\":0," +
"\"rounding_rule\":\"ROUNDING_UP_YUAN\"" +
"}," +
"\"aaa\":\"1\"" +
"}");
AlipayOpenWangyanTestDeleteResponse 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);
AlipayOpenWangyanTestDeleteRequest  request= new AlipayOpenWangyanTestDeleteRequest() ;
request.BizContent="{" +
"\"user_name\":\"1\"," +
"\"test\":{" +
"\"voucher_type\":\"DISCOUNT\"," +
"\"value_amount\":100," +
"\"threshold_amount\":90," +
"\"reduce_to_amount\":88," +
"\"original_amount\":100," +
"\"original_rate\":\"0.9\"," +
"\"discount_rate\":\"9.5\"," +
"\"valid_period\":3600," +
"\"voucher_desc\":\"使用规则\"," +
"\"threshold_quantity\":\"20\"," +
"\"desc_details\":[{" +
"\"title\":\"套餐材料\"," +
"\"details\":[" +
"\"我是描述1\",\"我是描述2\"" +
"]," +
"\"images\":[" +
"\"80fafaljl\",\"dajf90\"" +
"]," +
"\"url\":\"https://www.taobao.com\"" +
"}]," +
"\"external_goods_list\":{" +
"\"desc\":\"我是描述\"," +
"\"goods_list\":[" +
"\"123213\",\"sdfdsfasd\"" +
"]" +
"}," +
"\"limit_period_info_list\":{" +
"\"unit\":\"WEEK_DAY\"," +
"\"rule\":\"INCLUDE_INTERVAL\"," +
"\"value\":[" +
"3,4" +
"]" +
"}," +
"\"delay_minute\":0," +
"\"rounding_rule\":\"ROUNDING_UP_YUAN\"" +
"}," +
"\"aaa\":\"1\"" +
"}";
AlipayOpenWangyanTestDeleteResponse 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 AlipayOpenWangyanTestDeleteRequest ();
$request->setBizContent("{" .
"\"user_name\":\"1\"," .
"\"test\":{" .
"\"voucher_type\":\"DISCOUNT\"," .
"\"value_amount\":100," .
"\"threshold_amount\":90," .
"\"reduce_to_amount\":88," .
"\"original_amount\":100," .
"\"original_rate\":\"0.9\"," .
"\"discount_rate\":\"9.5\"," .
"\"valid_period\":3600," .
"\"voucher_desc\":\"使用规则\"," .
"\"threshold_quantity\":\"20\"," .
"\"desc_details\":[{" .
"\"title\":\"套餐材料\"," .
"\"details\":[" .
"\"我是描述1\",\"我是描述2\"" .
"]," .
"\"images\":[" .
"\"80fafaljl\",\"dajf90\"" .
"]," .
"\"url\":\"https://www.taobao.com\"" .
"}]," .
"\"external_goods_list\":{" .
"\"desc\":\"我是描述\"," .
"\"goods_list\":[" .
"\"123213\",\"sdfdsfasd\"" .
"]" .
"}," .
"\"limit_period_info_list\":{" .
"\"unit\":\"WEEK_DAY\"," .
"\"rule\":\"INCLUDE_INTERVAL\"," .
"\"value\":[" .
"3,4" .
"]" .
"}," .
"\"delay_minute\":0," .
"\"rounding_rule\":\"ROUNDING_UP_YUAN\"" .
"}," .
"\"aaa\":\"1\"" .
"}");
$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.open.wangyan.test.delete&app_id=4100&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&biz_content=
  {
"user_name":"1",
"test":{
"voucher_type":"DISCOUNT",
"value_amount":100,
"threshold_amount":90,
"reduce_to_amount":88,
"original_amount":100,
"original_rate":"0.9",
"discount_rate":"9.5",
"valid_period":3600,
"voucher_desc":"使用规则",
"threshold_quantity":"20",
        "desc_details":[{
          "title":"套餐材料",
            "details":[
              "我是描述1","我是描述2"
            ],
            "images":[
              "80fafaljl","dajf90"
            ],
"url":"https://www.taobao.com"
          }],
"external_goods_list":{
"desc":"我是描述",
          "goods_list":[
            "123213","sdfdsfasd"
          ]
      },
"limit_period_info_list":{
"unit":"WEEK_DAY",
"rule":"INCLUDE_INTERVAL",
          "value":[
            3,4
          ]
      },
"delay_minute":0,
"rounding_rule":"ROUNDING_UP_YUAN"
    },
"aaa":"1"
  }

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

JSON示例

{
	"alipay_open_wangyan_test_delete_response":{
		"msg":"Success",
		"code":"10000"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

JSON示例

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

错误码	错误描述	解决方案
ABC	aaa	bbb
INVALID_PARAMETERONE	参数有误abc	aaaa

公共错误码

参数	类型	是否必填	最大长度	描述	示例值
user_name	String []	必填	1	1	1

https://www.merchant.com/receive_notify.htm?notify_type=trade_status_sync&notify_id=91722adff935e8cfa58b3aabf4dead6ibe&notify_time=2017-02-16 21:46:15&sign_type=RSA2&sign=WcO+t3D8Kg71dTlKwN7r9PzUOXeaBJwp8/FOuSxcuSkXsoVYxBpsAidprySCjHCjmaglNcjoKJQLJ28/Asl93joTW39FX6i07lXhnbPknezAlwmvPdnQuI01HZsZF9V1i6ggZjBiAd5lG8bZtTxZOJ87ub2i9GuJ3Nr/NUc9VeY=&user_name=1

异步通知验签方式

开放平台

店铺API

alipay.open.wangyan.test.delete (测试接口)

公共参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

业务错误码

公共错误码

触发通知字段

触发通知示例

异步通知验签方式