接口说明
接口英文名称:alipay.marketing.card.template.query
请求url:https://openapi.alipay.com/v3/alipay/marketing/card/template/query
请求方式:get
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
基础版
扩展版
包含模板创建的必要参数和功能,优先推荐接入
公共请求参数
业务请求参数
query参数
template_id|会员卡模板id必选string[0,32]
【描述】会员卡模板id。调用alipay.marketing.card.template.create(会员卡模板创建接口)创建模板后同步返回。
【示例值】20160718000000001
常见请求示例
默认示例
curl -x get \
"https://openapi.alipay.com/v3/alipay/marketing/card/template/query?template_id=20160718000000001" \
-h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
-h "alipay-request-id: ${requestid}" \
-h "alipay-app-auth-token: ${app_auth_token}" \
-h "content-type: application/json" \
-d '{}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
template_style_info|模板样式信息必选templatestyleinfodto
【描述】模板样式信息(钱包展现效果)
card_show_name|钱包端显示名称必选string(10)
【描述】钱包端显示名称
【示例值】花呗联名卡
logo_id|logo的图片id必选string(1000)
【描述】logo的图片id,通过接口(alipay.offline.material.image.upload)上传图片
图片说明:1m以内,格式bmp、png、jpeg、jpg、gif;
尺寸不小于500*500px的正方形;
请优先使用商家logo;
图片说明:1m以内,格式bmp、png、jpeg、jpg、gif;
尺寸不小于500*500px的正方形;
请优先使用商家logo;
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
background_id|背景图片id必选string(1000)
【描述】背景图片id,通过接口(alipay.offline.material.image.upload)上传图片
图片说明:2m以内,格式:bmp、png、jpeg、jpg、gif;
尺寸不小于1020*643px;
图片不得有圆角,不得拉伸变形
图片说明:2m以内,格式:bmp、png、jpeg、jpg、gif;
尺寸不小于1020*643px;
图片不得有圆角,不得拉伸变形
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
brand_name|品牌商名称可选string(100)
【描述】品牌商名称
【示例值】可乐
access_version|接入版本可选string(16)
【描述】接入版本,接入的是基础版本一定会有值
【枚举值】
基础版: basic
扩展版: extend
【示例值】basic
card_level_confs|卡级别配置可选templatecardlevelconfdto[]
【描述】卡等级配置
level|会员级别必选string(64)
【描述】会员级别 该级别和开卡接口中的level要一致
【示例值】vip1
level_show_name|会员级别显示名称必选string(64)
【描述】会员级别显示名称
【示例值】黄金会员
level_icon|会员级别对应icon图片必选string(64)
【描述】会员级别对应icon图片,
会员信息预留字段,暂不在用户端展示;
通过接口(alipay.offline.material.image.upload)上传图片
会员信息预留字段,暂不在用户端展示;
通过接口(alipay.offline.material.image.upload)上传图片
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
level_desc|会员级别描述必选string(4000)
【描述】会员级别描述
【示例值】黄金会员享受免费停车
template_form_config|开卡表单配置可选templateformconfig
【描述】入会表单配置,包括入会表单的字段,入会弹层承接小程序appid等
fields|表单字段可选templateformfields
【描述】表单可选字段,required里面的选项与optional里面的选项不能存在重复
required|必填字段可选string[](50)
【描述】开卡表单必填字段,必填字段必须有一个值,并且不能与可选字段optional里面重复,字段有效值如下列表所示:
【枚举值】
姓名: open_form_field_name
手机号: open_form_field_mobile
性别: open_form_field_gender
【示例值】["open_form_field_mobile"]
optional|可选字段可选string[](50)
【描述】开卡表单可填字段,可选字段选项不能与必填字段required重复,字段有效值如下列表所示:
【枚举值】
手机号: open_form_field_mobile
性别: open_form_field_gender
姓名: open_form_field_name
【示例值】["open_form_field_mobile"]
open_card_mini_app_id|入会承接弹层的小程序appid可选string(64)
【描述】入会时承接入会弹层的小程序appid
【示例值】2019091767145019
spi_app_id|spi应用id可选string(32)
【描述】spi应用id,若使用openspi模式开卡,该字段为创建模版时,设置的实现spi.alipay.user.opencard.get接口的app_id
【示例值】2014072300007148
响应示例
正常示例
异常示例
{
"access_version":"basic",
"template_style_info":{
"card_show_name":"花呗联名卡",
"logo_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"background_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"brand_name":"可乐"
},
"card_level_confs":[
{
"level":"vip1",
"level_show_name":"黄金会员",
"level_icon":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"level_desc":"黄金会员享受免费停车"
}
],
"template_form_config":{
"fields":{
"required":[
"open_form_field_mobile"
],
"optional":[
"open_form_field_mobile"
]
},
"open_card_mini_app_id":"2019091767145019"
},
"spi_app_id":"2014072300007148"
}
说明:本示例仅供参考。
公共错误码
前往查看业务错误码
状态码 | 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|---|
400 | system_error | 系统繁忙 | 系统错误,查看message获取实际错误原因 |
400 | invalid_parameter | 参数有误。参数有误。 | 查看message定位问题 |
400 | template_not_exit | 模板不存在 | 确认模板是否存在 |