alipay.marketing.card.formtemplate.set(会员卡开卡表单模板配置) 在线调试(沙箱环境)

会员卡开卡、用户授权确认

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.card.formtemplate.set
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 必选 128 会员卡模板id。使用会员卡模板创建接口(alipay.marketing.card.template.create)返回的结果 20170228000000000210102000300974
fields OpenFormFieldDO 可选 会员卡开卡时的表单字段配置信息,可定义多个通用表单字段,最大不超过20个。 [OPEN_FORM_FIELD_MOBILE,OPEN_FORM_FIELD_GENDER]
required String 可选 10240 表单必填字段配置,common_fields属性定义一个表单字段数组,字段有效值如下列表所示:
OPEN_FORM_FIELD_MOBILE -- 手机号
OPEN_FORM_FIELD_GENDER -- 性别
OPEN_FORM_FIELD_NAME -- 姓名
OPEN_FORM_FIELD_BIRTHDAY -- 生日(不含年份,如:01-01)
OPEN_FORM_FIELD_BIRTHDAY_WITH_YEAR -- 生日(含年份,如:1988-01-01)
OPEN_FORM_FIELD_IDCARD -- 身份证
OPEN_FORM_FIELD_CERT_TYPE -- 证件类型
OPEN_FORM_FIELD_CERT_NO -- 证件号
OPEN_FORM_FIELD_EMAIL -- 邮箱
OPEN_FORM_FIELD_ADDRESS -- 地址
OPEN_FORM_FIELD_CITY -- 城市
OPEN_FORM_FIELD_IS_STUDENT -- 是否学生认证
OPEN_FORM_FIELD_MEMBER_GRADE -- 会员等级

注:
1. 会员等级、是否学生认证字段,如果获取不到该项数据时,表单页面不做展示。
2. 身份证字段和证件号、证件类型字段不可同时配置。
3. 如果身份证字段不能满足业务需求,可通过配置证件类型+证件号字段来获取其他证件类型的支持,目前支持的证件类型有:身份证、护照、港澳居民通行证、台湾居民通行证
{"common_fields":["OPEN_FORM_FIELD_MOBILE"]}
optional String 可选 10240 表单可选字段配置,common_fields属性定义一个表单字段数组,表单字段有效值列表与required字段有效值列表相同。
可选字段配置中不能含有必须字段配置的有效值。
{"common_fields":["OPEN_FORM_FIELD_GENDER"]}

响应参数

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

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCardFormtemplateSetRequest request = new AlipayMarketingCardFormtemplateSetRequest();
request.setBizContent("{" +
"\"template_id\":\"20170228000000000210102000300974\"," +
"\"fields\":{" +
"\"required\":\"{\\\"common_fields\\\":[\\\"OPEN_FORM_FIELD_MOBILE\\\"]}\"," +
"\"optional\":\"{\\\"common_fields\\\":[\\\"OPEN_FORM_FIELD_GENDER\\\"]}\"" +
"}" +
"}");
AlipayMarketingCardFormtemplateSetResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

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

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 请检查输入参数的有效性
SYSTEM_ERROR 系统繁忙 请稍后重试
CARD_TEMPLATE_NOT_EXIST 会员卡模板不存在 请检查template_id参数的有效性
DUPLICATE_FORM_FIELD 表单字段重复配置 请检查必填字段与可选字段是否配置了相同的表单字段名称
FORM_FIELD_INVALID 表单字段无效 请检查入参通用表单列表值的有效性
OPEN_FORM_SET_FAIL 表单配置失败 请稍后重试
DUPLICATE_BIRTHDAY_FIELD 不可同时配置两种类型的生日字段 不可同时配置两种类型的生日字段,请选择OPEN_FORM_FIELD_BIRTHDAY和OPEN_FORM_FIELD_BIRTHDAY_WITH_YEAR之一
DUPLICATE_CERT_NO 不可同时配置证件号和身份证号字段 不可同时配置证件号(OPEN_FORM_FIELD_CERT_NO)和身份证号(OPEN_FORM_FIELD_IDCARD)字段,请检查配置参数.
INVALID_CERT_TYPE_AND_NO 证件类型和证件号两个字段需同时配置 证件类型(OPEN_FORM_FIELD_CERT_TYPE)和证件号(OPEN_FORM_FIELD_CERT_NO)需同时配置,请检查配置参数。
onlineServer