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

接口说明

接口英文名称:alipay.marketing.card.template.query
请求url:https://openapi.alipay.com/v3/alipay/marketing/card/template/query
请求方式:get
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

业务请求参数

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 '{}'
说明:本示例仅供参考。

公共响应参数

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

业务响应参数

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;
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
background_id|背景图片id必选string(1000)
【描述】背景图片id,通过接口(alipay.offline.material.image.upload)上传图片
图片说明: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)上传图片
【示例值】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官方网站的解决方案
400system_error系统繁忙
系统错误,查看message获取实际错误原因
400invalid_parameter参数有误。参数有误。
查看message定位问题
400template_not_exit模板不存在
确认模板是否存在
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图