接口说明
接口英文名称:alipay.marketing.card.activateform.query
请求url:https://openapi.alipay.com/v3/alipay/marketing/card/activateform/query
请求方式:get
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
通用场景
会员卡开卡场景下,用户确认领卡后,跳转到商户开卡处理页面,商户通过该接口查询用户表单信息。
公共请求参数
业务请求参数
query参数
auth_token|用户授权令牌必选string
【描述】用户授权令牌,同 access_token(用户访问令牌)。针对用户授权接口,获取用户相关数据时,用于标识用户授权关系。需使用 获取投放链接 配置的 callback 地址获取 auth_code(用户授权码)换取此令牌。
【示例值】20120823ac6ffaa4d2d84e7384bf983531473993
biz_type|开放表单信息查询业务类型必选string[0,64]
【描述】开放表单信息查询业务类型
【枚举值】
商家会员卡开卡: member_card
【示例值】member_card
template_id|会员卡模板id必选string[0,32]
【描述】会员卡模板id。使用会员卡模板创建接口(alipay.marketing.card.template.create)返回的结果
【示例值】2071828288283883
request_id|请求 id必选string[1,128]
【描述】查询用户表单提交信息的请求id。
网页移动应用&小程序应用:与auth_code 一起通过alipay.marketing.card.activateurl.apply(获取会员卡领卡投放链接)接口callback地址回传。
注意:auth_code(用户授权码)用于换取用户授权令牌 accesstoken,后续调用接口需传入accesstoken。
【示例值】2017021929993993992839493394
常见请求示例
默认示例
curl -x get \
"https://openapi.alipay.com/v3/alipay/marketing/card/activateform/query?biz_type=member_card&template_id=2071828288283883&request_id=2017021929993993992839493394" \
-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 '{}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
infos|表单提交信息特殊可选string(102400)
【描述】表单提交信息各个字段的值json数组
通用表单字段名称如下示例:
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 – 地址
详细字段名称列表见会员卡开卡表单模板配置接口:alipay.marketing.card.formtemplate.set
注:
1. 证件类型字段(open_form_field_cert_type)返回结果取值如下:
0 -- 身份证
1 -- 护照
2 -- 港澳居民通行证
3 -- 台湾居民通行证
【示例值】[{"open_form_field_gender":"男"},{"open_form_field_mobile":"13888888888"},{"open_form_field_name":"李四"}]
响应示例
正常示例
异常示例
{
"infos":"[{\"open_form_field_gender\":\"男\"},{\"open_form_field_mobile\":\"13888888888\"},{\"open_form_field_name\":\"李四\"}]"
}
说明:本示例仅供参考。
公共错误码
前往查看业务错误码
状态码 | 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|---|
400 | system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
400 | invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
400 | illegal_null_argument | 有必填参数为空 | 请确认必填参数不为空 |
400 | open_profile_query_fail | 查询失败 | 开放信息查询失败,请稍后重试 |
400 | request_id_expire | 请求id已过期 | 请求id已过期,请确认请求id的有效性 |
400 | request_id_invalid | 请求id无效 | 请确保请求id和会员卡模板id的正确性 |