开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
开发文档(v3版) 
支付
私域
公域
营销
营销活动送红包
商家券
商家会员卡
接入指南
api 列表
相关资料
红包
棋盘密云
支付券
资金
会员
信用
安全
广告
小程序云
其他
api文档 > 营销 > 商家会员卡 >  > 会员卡开卡表单模板配置接口
文档更新记录 >
收藏
订阅更新
我的文档
设置

接口说明

接口英文名称:alipay.marketing.card.formtemplate.set
请求url:https://openapi.alipay.com/v3/alipay/marketing/card/formtemplate/set
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
会员卡开卡、用户授权确认

公共请求参数

参数类型是否必选最大长度描述示例值
authorizationstring必选1024
请求身份信息,参考验签规则。在header参数中传递
content-typestring可选32
报文内容格式,默认需要使用application/json,加密请求使用text/plain,参考请求规则。在header参数中传递
application/json
x-http-method-overridestring可选16
http方法,对于部分不支持put、patch、delete等操作的情况,可以使用post发送请求,并通过该参数传输实际需要使用的http method,参考请求规则。在header参数中传递
put
alipay-request-idstring可选32
调用方的requestid,用于定位一次请求,需要每次请求保持唯一。排查问题时可以提供该字段,参考请求规则。在header参数中传递。
0ba7cddb1665744697169391253118
alipay-encrypt-typestring可选16
加密算法,请求使用加密能力时,需要指定加密算法,参考加解密规则。在header参数中传递
aes
alipay-root-cert-snstring可选128
支付宝根证书序列号。证书模式时,可传入该参数,支付宝服务端会校验序列号,确保调用方的证书未被篡改,参考验签规则。在header参数中传递
687b59193f3f462dd5336e5abf83c5d8_02941eef3187dddf3d3b83462e1dfcf6
alipay-app-auth-tokenstring可选128
应用授权令牌,参考代调用规则。在header参数中传递
201509bbeff9351ad1874306903e96b91d248a36

业务请求参数

body参数
template_id|会员卡模板id必选string[0,32]
【描述】会员卡模板id。调用alipay.marketing.card.template.create(会员卡模板创建接口)创建模板后同步返回。
【示例值】20170228000000000210102000300974
fields|表单字段必选openformfielddo
【描述】会员卡开卡时的表单字段配置信息,即用户开卡时需填写内容。可定义多个通用表单字段,最大不超过20个。 注意:required必须填一个
required|表单必填字段配置可选string[0,102400]
【描述】表单必填字段配置,common_fields属性定义一个表单字段数组,字段有效值如下列表所示: open_form_field_mobile -- 手机号 open_form_field_gender -- 性别 open_form_field_name -- 姓名 open_form_field_birthday -- 生日 open_form_field_idcard -- 身份证 open_form_field_email -- 邮箱 open_form_field_address -- 地址 open_form_field_city -- 城市 open_form_field_is_student -- 是否学生认证 open_form_field_member_grade -- 会员等级
【示例值】{ "common_fields": [ "open_form_field_mobile" ] }
optional|表单可选字段配置可选string[0,102400]
【描述】表单可选字段配置,common_fields属性定义一个表单字段数组,表单字段有效值列表与required字段有效值列表相同。 可选字段配置中不能含有必须字段配置的有效值。
【示例值】{ "common_fields": [ "open_form_field_gender" ] }
常见请求示例
curl -x post \
 "https://openapi.alipay.com/v3/alipay/marketing/card/formtemplate/set" \
 -h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
 -h "alipay-request-id: ${requestid}" \
 -h "content-type: application/json" \
 -d '{
	"fields":{
		"required":"{\n\n \"common_fields\": [\n\n \"open_form_field_mobile\"\n\n ]\n\n }"
	},
	"template_id":"20170228000000000210102000300974"
}'
说明:本示例仅供参考。

公共响应参数

参数中文名参数英文名类型是否必选最大长度描述示例值
支付宝响应时间戳alipay-timestampstring可选32
unix时间戳,用于验签及问题排查,参考验签规则。在header参数中传递
1666004496123
支付宝响应签名alipay-signaturestring可选512
支付宝响应报文签名,参考验签规则。在header中返回
支付宝traceidalipay-traceidstring可选64
支付宝traceid ,用于排查问题使用,参考请求规则。在header中返回
0ba7cddb1665744697169391253118
支付宝随机串alipay-noncestring可选64
支付宝nonce标记,每次请求会生成不同的nonce,可用于防重放判断,参考请求规则。在header中返回
515cf24c2f78b13564e94c2a495695ab

业务响应参数

无业务响应参数
响应示例
{}
说明:本示例仅供参考。

公共错误码

前往查看

业务错误码

状态码错误码错误描述凯发app官方网站的解决方案
400system_error系统繁忙
服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试
400invalid_parameter参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
400card_template_not_exist会员卡模板不存在
请检查template_id参数的有效性
400duplicate_birthday_field不可同时配置两种类型的生日字段
不可同时配置两种类型的生日字段,请选择open_form_field_birthday和open_form_field_birthday_with_year之一
400duplicate_cert_no不可同时配置证件号和身份证号字段
不可同时配置证件号(open_form_field_cert_no)和身份证号(open_form_field_idcard)字段,请检查配置参数.
400duplicate_form_field表单字段重复配置
请检查必填字段与可选字段是否配置了相同的表单字段名称
400form_field_invalid表单字段无效
请检查入参通用表单列表值的有效性
400illegal_null_argument有必填参数为空
请确认必填参数不为空
400invalid_cert_type_and_no证件类型和证件号两个字段需同时配置
证件类型(open_form_field_cert_type)和证件号(open_form_field_cert_no)需同时配置,请检查配置参数。
400open_form_set_fail表单配置失败
请稍后重试
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图