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

接口说明

接口英文名称:alipay.marketing.card.template.batchquery
请求url:https://openapi.alipay.com/v3/alipay/marketing/card/template/batchquery
请求方式: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参数
page_no|查询起始页码必选number[1,99999]
【描述】查询起始页码,如第1页,单位:/页
【示例值】1
page_size|每页数据大小必选number[1,20]
【描述】每页数据大小,默认 20条,最大支持20个,单位:/个
【示例值】20
常见请求示例
curl -x post \
 "https://openapi.alipay.com/v3/alipay/marketing/card/template/batchquery" \
 -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 '{
	"page_no":1,
	"page_size":20
}'
说明:本示例仅供参考。

公共响应参数

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

业务响应参数

template_total|会员卡模板总数必选number(10)
【描述】会员卡模板总数,如10个卡模版,单位:/个
【示例值】10
mcard_template|会员卡模板基本信息可选mcardtemplate[]
【描述】会员卡模板基本信息
template_id|会员卡模板id必选string(32)
【描述】会员卡模板id
【示例值】20160718000000001
card_type|卡类型必选string(32)
【描述】卡类型
【枚举值】
外部权益卡: out_member_card
【示例值】out_member_card
template_style_info|会员卡模板展示样式必选templatestyleinfodto(20000)
【描述】会员卡模板展示样式,会员卡在卡包中的卡面展示效果
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
bg_color|字体颜色必选string(32)
【描述】字体颜色(非背景色),只影响卡详情中部信息区域字体颜色
【示例值】rgb(55,112,179)
color|卡片颜色可选string(64)
【描述】注意:此字段已废弃。
【示例值】rgb(55,112,179)
front_text_list_enable|设置是否在卡面展示文案信息可选boolean(5)
【描述】设置是否在卡面展示文案信息,默认不展示; 文案信息分行展示,最多展示4行文案,每行文案分为label和value两部分; 文案实际内容随创建卡/更新卡时传入; 详见会员卡产品说明文档。
【示例值】false
front_image_enable|设置是否在卡面展示(个人头像)图片信息可选boolean(5)
【描述】设置是否在卡面展示(个人头像)图片信息,默认不展示; 当前仅用于身份验证信息类型的个人头像图片; 图片id随创建卡/更新卡时传入; 详见会员卡产品文档。
【示例值】false
feature_descriptions|特色信息可选string[](4000)
【描述】特色信息,用于领卡预览
【示例值】["使用花呗卡可享受免费分期"]
slogan|标语可选string(100)
【描述】标语
【示例值】会员权益享不停
slogan_img_id|标语图片id可选string(100)
【描述】标语图片id, 通过接口(alipay.offline.material.image.upload)上传图片
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
brand_name|品牌商名称可选string(100)
【描述】品牌商名称
【示例值】可乐
banner_img_id|banner图片id可选string(1000)
【描述】banner图片id。 通过接口(alipay.offline.material.image.upload)上传图片。
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
banner_url|banner跳转地址可选string(256)
【描述】banner跳转地址。
【示例值】http://www.baidu.com
column_info_layout|栏位信息布局类型可选string(10)
【描述】如果为空则默认为list。
【枚举值】
列表: list
宫格: grid
【示例值】list
gmt_create|会员卡模板创建时间必选date(16)
【描述】会员卡模板创建时间
【示例值】2018-01-11 15:12:23
gmt_modified|会员卡模板修改时间必选date(16)
【描述】会员卡模板修改时间
【示例值】2018-01-11 15:12:23
响应示例
{
	"template_total":10,
	"mcard_template":[
		{
			"template_id":"20160718000000001",
			"card_type":"out_member_card",
			"template_style_info":{
				"card_show_name":"花呗联名卡",
				"logo_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
				"color":"rgb(55,112,179)",
				"background_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
				"bg_color":"rgb(55,112,179)",
				"front_text_list_enable":false,
				"front_image_enable":false,
				"feature_descriptions":[
					"使用花呗卡可享受免费分期"
				],
				"slogan":"会员权益享不停",
				"slogan_img_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
				"brand_name":"可乐",
				"banner_img_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
				"banner_url":"http://www.baidu.com",
				"column_info_layout":"list"
			},
			"gmt_create":"2018-01-11 15:12:23",
			"gmt_modified":"2018-01-11 15:12:23"
		}
	]
}
说明:本示例仅供参考。

公共错误码

前往查看

业务错误码

状态码错误码错误描述凯发app官方网站的解决方案
400system_error系统繁忙
服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试
400invalid_parameter参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图