淘宝开放平台

登录
文档中心 > API类目 > 营销API

营销API

alipay.marketing.voucher.send (发券接口)

发券

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
template_id String 必须 28 券模板ID 20140601000730010040000000EB
login_id String 特殊可选 128 支付宝登录ID，手机或邮箱 。user_id, login_id, taobao_nick不能同时为空，优先级依次降低 13196215350
taobao_nick String 特殊可选 128 淘宝昵称 。user_id, login_id, taobao_nick不能同时为空，优先级依次降低 yue54333
user_id String 特殊可选 16 支付宝用户ID 。user_id, login_id, taobao_nick不能同时为空，优先级依次降低 2088302001456115
out_biz_no String 必须 64 外部业务订单号，用于幂等控制，相同template_id和out_biz_no认为是同一次业务 2016122814164328aadaee_1aee_4
amount Price 可选 10 券金额。浮点数，格式为#.00，单位是元。红包发放时填写，其它情形不能填 9.99
memo String 可选 128 发券备注 优酷3个月兑换券

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
voucher_id String 必填 28 券ID 20160906000730020020002U8CBS
user_id String 必填 16 支付宝用户ID 2088302001456115

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
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");
AlipayMarketingVoucherSendRequest request = new AlipayMarketingVoucherSendRequest();
request.setBizContent("{" +
"\"template_id\":\"20140601000730010040000000EB\"," +
"\"login_id\":\"13196215350\"," +
"\"taobao_nick\":\"yue54333\"," +
"\"user_id\":\"2088302001456115\"," +
"\"out_biz_no\":\"2016122814164328aadaee_1aee_4\"," +
"\"amount\":9.99," +
"\"memo\":\"优酷3个月兑换券\"" +
"}");
AlipayMarketingVoucherSendResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
1
2
3
4
5
6
7
8
9
{
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
    "alipay_marketing_voucher_send_response":{
        "msg":"Success",
        "code":"10000",
        "user_id":"2088302001456115",
        "voucher_id":"20160906000730020020002U8CBS"
    }
}

异常示例

  • JSON示例
1
2
3
4
5
6
7
8
9
{
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
    "alipay_marketing_voucher_send_response":{
        "msg":"Service Currently Unavailable",
        "code":"20000",
        "sub_msg":"系统繁忙",
        "sub_code":"isp.unknow-error"
    }
}

业务错误码

错误码 错误描述 解决方案
TEMPLATE_NOT_EXIST 模板不存在 请仔细确认指定模板ID是否存在
TEMPLATE_EXPIRED 模板过期 查模板状态确认模板是否过期
USER_NOT_EXIST 用户不存在 请仔细确认传入支付宝用户ID是否正确
USER_STATUS_ERROR 用户状态不可用 请确认用户状态是否可用
INVALID_PARAMETER 参数有误 请检查入参是否符合接口要求
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持

公共错误码

公共错误码
有用(0)
我要提问
返回
顶部