会员卡模板查询接口
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | alipay.marketing.card.template.query |
format | String | 否 | 40 | 仅支持JSON | JSON |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 256 | 商户请求参数的签名串,详见签名 | 详见示例 |
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 | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
template_id | String | 必须 | 32 | 支付宝卡模板ID(模板创建接口返回的支付宝端模板ID) | 20160718000000001 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
card_type | String | 必填 | 32 |
会员卡类型:
OUT_MEMBER_CARD:外部权益卡 |
OUT_MEMBER_CARD | ||||||||||||||||||||||||||||||||||||||||||||||||
biz_no_prefix | String | 必填 | 16 |
业务卡号前缀,由商户指定
支付宝业务卡号生成规则:biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实时生成)卡号后缀 |
prex | ||||||||||||||||||||||||||||||||||||||||||||||||
biz_no_suffix_len | String | 必填 | 16 |
业务卡号后缀的长度
支付宝业务卡号生成规则:biz_no_prefix(商户指定)卡号前缀 + biz_no_suffix(实时生成)卡号后缀 |
10 | ||||||||||||||||||||||||||||||||||||||||||||||||
template_style_info | TemplateStyleInfoDTO | 选填 | - | 模板样式信息(钱包展现效果) | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
template_benefit_info | TemplateBenefitInfoDTO [] | 选填 | - |
权益信息,
1、在卡包的卡详情页面会自动添加权益栏位,展现会员卡特权, 2、如果添加门店渠道,则可在门店页展现会员卡的权益 |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
column_info_list | TemplateColumnInfoDTO [] | 必填 | - | 栏位信息(卡包详情页面展现的栏位) | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
field_rule_list | TemplateFieldRuleDTO [] | 必填 | - |
字段规则列表,会员卡开卡过程中,会员卡信息的生成规则,
例如:卡有效期为开卡后两年内有效,则设置为:DATE_IN_FUTURE |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
service_label_list | String [] | 选填 | 1024 | 服务标签列表 | Checklater | ||||||||||||||||||||||||||||||||||||||||||||||||
shop_ids | String [] | 选填 | 1024 | 门店ids | ["2015122900077000000002409504"] | ||||||||||||||||||||||||||||||||||||||||||||||||
open_card_conf | TemplateOpenCardConfDTO | 选填 | - | 会员卡用户领卡配置,在门店等渠道露出领卡入口时,需要部署的商户领卡H5页面地址 | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
pub_channels | PubChannelDTO [] | 选填 | - | 卡模板投放渠道 | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
card_action_list | TemplateActionInfoDTO [] | 选填 | - |
卡行动点配置;
行动点,即用户可点击跳转的区块,类似按钮控件的交互; 单张卡最多4个行动点。 |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
card_level_confs | TemplateCardLevelConfDTO [] | 选填 | - | 卡等级配置 | |||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
mdcode_notify_conf | TemplateMdcodeNotifyConfDTO | 必填 | - |
商户动态码通知参数配置:
当write_off_type指定为商户动态码mdbarcode或mdqrcode时不为空; 在此字段配置用户打开会员卡时支付宝通知商户生成动态码(发码)的通知参数,如接收通知地址等。 |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
card_spec_tag | String | 选填 | 20 | 卡特定标签,只供特定业务使用,通常接入无需关注 | NONE |
1 2 3 4 5 6 7 8 9 10 11 | AlipayClient alipayClient = new DefaultAlipayClient( "https://openapi.alipay.com/gateway.do" , "app_id" , "your private_key" , "json" , "GBK" , "alipay_public_key" , "RSA2" ); AlipayMarketingCardTemplateQueryRequest request = new AlipayMarketingCardTemplateQueryRequest(); request.setBizContent( "{" + "\"template_id\":\"20160718000000001\"" + "}" ); AlipayMarketingCardTemplateQueryResponse response = alipayClient.execute(request); if (response.isSuccess()){ System.out.println( "调用成功" ); } else { System.out.println( "调用失败" ); } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | { "sign" : "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" , "alipay_marketing_card_template_query_response" :{ "msg" : "Success" , "mdcode_notify_conf" :{ "ext_params" : "{\"param1\":\"value1\",\"param2\":\"value2\"}" , }, "code" : "10000" , "card_level_confs" :[ { "level_show_name" : "黄金会员" , "level" : "VIP1" , "level_icon" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" , "level_desc" : "黄金会员享受免费停车" } ], "card_spec_tag" : "NONE" , "template_style_info" :{ "bg_color" : "rgb(55,112,179)" , "front_image_enable" : false , "color" : "rgb(55,112,179)" , "front_text_list_enable" : false , "logo_id" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" , "slogan_img_id" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" , "card_show_name" : "花呗联名卡" , "brand_name" : "可乐" , "background_id" : "1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" , "feature_descriptions" :[ "使用花呗卡可享受免费分期" ], "slogan" : "会员权益享不停" }, "open_card_conf" :{ "source_app_id" : "201609191111111" , "open_card_source_type" : "ISV" , "conf" : "\"\"" }, "template_benefit_info" :[ { "end_date" : "2016-07-34 12:12:12" , "benefit_desc" :[ "消费即折扣" ], "title" : "消费即折扣" , "start_date" : "2016-07-18 15:17:23" } ], "column_info_list" :[ { "operate_type" : "openWeb" , "code" : "BENEFIT_INFO" , "more_info" :{ "descs" :[ "会员生日7折" ], "title" : "会员专享权益" , "params" : "{}" , }, "title" : "会员专享" , "value" : "80" } ], "card_type" : "OUT_MEMBER_CARD" , "biz_no_suffix_len" : "10" , "field_rule_list" :[ { "rule_name" : "ASSIGN_FROM_REQUEST" , "rule_value" : "Balance" , "field_name" : "Balance" } ], "service_label_list" :[ "Checklater" ], "card_action_list" :[ { "code" : "TO_CLOCK_IN" , "text" : "打卡" , } ], "biz_no_prefix" : "prex" , "pub_channels" :[ { "ext_info" : "\"key\":\"value\"" , "pub_channel" : "SHOP_DETAIL" } ], "shop_ids" :[ "[\"2015122900077000000002409504\"]" ] } } |
1 2 3 4 5 6 7 8 9 | { "sign" : "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" , "alipay_marketing_card_template_query_response" :{ "msg" : "Service Currently Unavailable" , "code" : "20000" , "sub_msg" : "系统繁忙" , "sub_code" : "isp.unknow-error" } } |
错误码 | 错误描述 | 解决方案 |
---|---|---|
INVALID_PARAMETER | 参数有误。 | 查看message定位问题 |
SYSTEM_ERROR | 系统繁忙 | 系统错误,查看message获取实际错误原因 |
TEMPLATE_NOT_EXIT | 模板不存在 | 确认模板是否存在 |