alipay.marketing.card.activateurl.apply(获取会员卡领卡投放链接) 在线调试(沙箱环境)

会员卡开卡业务,开发者通过该接口获取用户开卡链接,用于会员卡投放。

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.card.activateurl.apply
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
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 必选 1024 会员卡模板id。使用会员卡模板创建接口(alipay.marketing.card.template.create)返回的结果 20170228000000000210102000300974
out_string String 可选 256 扩展信息,会员领卡完成后将此参数原样带回商户页面。 201928393932
callback String 必选 10240 会员卡开卡表单提交后回调地址。
1.该地址不可带参数,如需回传参数,可设置out_string入参。
https://alipay.com/card/demo.htm
follow_app_id String 可选 512 需要关注的生活号AppId。若需要在领卡页面展示“关注生活号”提示,需开通生活号并绑定会员卡。生活号快速接入详见:https://doc.open.alipay.com/docs/doc.htm?treeId=193&articleId=105933&docType=1 20150000000000000

响应参数

参数 类型 是否必填 最大长度 描述 示例值
apply_card_url String 必填 102400 会员卡领卡链接(使用时需URLDecode解码)。商户获取此链接后可投放到服务窗消息、店铺二维码等。 https%3A%2F%2Fmemberprod.alipay.com%2Faccount%2Fopenform%2Factivecard.htm%3Fapp_id%3D2017051007191443%26template_id%3D2017053100

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCardActivateurlApplyRequest request = new AlipayMarketingCardActivateurlApplyRequest();
request.setBizContent("{" +
"\"template_id\":\"20170228000000000210102000300974\"," +
"\"out_string\":\"201928393932\"," +
"\"callback\":\"https://alipay.com/card/demo.htm\"," +
"\"follow_app_id\":\"20150000000000000\"" +
"}");
AlipayMarketingCardActivateurlApplyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_card_activateurl_apply_response": {
        "code": "10000",
        "msg": "Success",
        "apply_card_url": "https%3A%2F%2Fmemberprod.alipay.com%2Faccount%2Fopenform%2Factivecard.htm%3Fapp_id%3D2017051007191443%26template_id%3D2017053100"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 请检查接口调用参数
SYSTEM_ERROR 系统繁忙 请稍后重试
CARD_TEMPLATE_NOT_EXIST 会员卡模板不存在 请检查会员卡模板Id是否正确。使用会员卡模板创建接口(alipay.marketing.card.template.create)返回的结果
OPEN_FORM_TEMPLATE_NOT_EXIST 领卡表单配置不存在 领卡表单配置不存在,请调用会员卡开卡表单配置接口‘alipay.marketing.card.formtemplate.set’进行配置
onlineServer