alipay.marketing.card.template.batchquery(会员卡模板批量查询) 在线调试(沙箱环境)

会员卡模板批量查询

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.card.template.batchquery
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
page_no Number 必选 10 页码 1
page_size Number 必选 10 每页大小,默认20条,最大支持20条 20

响应参数

参数 类型 是否必填 最大长度 描述 示例值
template_total Number 必填 10 会员卡模板总数 10
mcard_template McardTemplate 必填 会员卡模板基本信息
template_id String 必填 32 会员卡模板ID 20160718000000001
card_type String 必填 32 会员卡类型 OUT_MEMBER_CARD
template_style_info TemplateStyleInfoDTO 必填 20000 会员卡模板展示样式,会员卡在卡包中的卡面展示效果
card_show_name String 必填 10 钱包端显示名称(字符串长度) 花呗联名卡
logo_id String 必填 1000 logo的图片ID,通过接口(alipay.offline.material.image.upload)上传图片

图片说明:1M以内,格式bmp、png、jpeg、jpg、gif;
尺寸不小于500*500px的正方形;
请优先使用商家LOGO;
1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
color String 可选 64 注意:此字段已废弃。
卡片颜色
rgb(55,112,179)
background_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)
front_text_list_enable Boolean 可选 5 设置是否在卡面展示文案信息,默认不展示;
文案信息分行展示,最多展示3行文案,每行文案分为label和value两部分;
文案实际内容随创建卡/更新卡时传入;
详见会员卡产品说明文档。
false
front_image_enable Boolean 可选 5 设置是否在卡面展示(个人头像)图片信息,默认不展示;
当前仅用于身份验证信息类型的个人头像图片;
图片id随创建卡/更新卡时传入;
详见会员卡产品文档。
false
feature_descriptions String[] 可选 4000 特色信息,用于领卡预览 使用花呗卡可享受免费分期
slogan String 可选 100 标语 会员权益享不停
slogan_img_id String 可选 100 标语图片, 通过接口(alipay.offline.material.image.upload)上传图片 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
brand_name String 可选 100 品牌商名称 可乐
gmt_create Date 必填 16 会员卡模板创建时间 2018-01-11 15:12:23
gmt_modified Date 必填 16 会员卡模板修改时间 2018-01-11 15:12:23

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCardTemplateBatchqueryRequest request = new AlipayMarketingCardTemplateBatchqueryRequest();
request.setBizContent("{" +
"\"page_no\":1," +
"\"page_size\":20" +
"  }");
AlipayMarketingCardTemplateBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_card_template_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "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": "可乐"
                },
                "gmt_create": "2018-01-11 15:12:23",
                "gmt_modified": "2018-01-11 15:12:23"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_marketing_card_template_batchquery_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 查看message定位问题
SYSTEM_ERROR 系统繁忙 系统错误,查看message获取实际错误原因
onlineServer