接口说明
接口英文名称:alipay.marketing.card.template.batchquery
请求url:https://openapi.alipay.com/v3/alipay/marketing/card/template/batchquery
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
通用场景
会员卡模板批量查询
公共请求参数
业务请求参数
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
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
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官方网站的解决方案 |
---|---|---|---|
400 | system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
400 | invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |