开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
网页&移动应用 
支付产品
私域产品
公域产品
营销产品
支付券
商家券 2.0
商家会员卡
接入指南
api 列表
相关资料
历史文档
营销活动送红包
红包
棋盘密云
芝麻实力标
资金产品
会员产品
信用产品
安全产品
广告产品
其他通用产品
开发 > 服务端 > 营销产品 > 商家会员卡 > 接入指南 > 扩展功能
文档更新记录 >
收藏
订阅更新
我的文档
设置
接入检测
即可查看检测结果)
若有未通过的接入检测项,接口将无法调通
除了基本发卡链路外,开放平台还为开发者和商家提供了后续的配套接口,用于会员卡模板的查询和修改,以及会员卡的查询,更新和删除。
1 会员卡查询接口
商家/服务商可通过 alipay.marketing.card.query(会员卡查询接口)根据卡号或者持卡人信息查询会员卡信息。
1.1 请求示例
java
复制代码
package com.java.sdk.demo;

import com.alipay.api.alipayapiexception;
import com.alipay.api.alipayclient;
import com.alipay.api.defaultalipayclient;
import com.alipay.api.alipayconfig;
import com.alipay.api.response.alipaymarketingcardqueryresponse;
import com.alipay.api.request.alipaymarketingcardqueryrequest;
import com.alipay.api.domain.carduserinfo;
import com.alipay.api.domain.alipaymarketingcardquerymodel;

import com.alipay.api.fileitem;
import java.util.base64;
import java.util.arraylist;
import java.util.list;

public class alipaymarketingcardquery {

public static void main(string[] args) throws alipayapiexception {
// 初始化sdk
alipayclient alipayclient = new defaultalipayclient(getalipayconfig());

// 构造请求参数以调用接口
alipaymarketingcardqueryrequest request = new alipaymarketingcardqueryrequest();
alipaymarketingcardquerymodel model = new alipaymarketingcardquerymodel();
// 设置卡号id类型
model.settargetcardnotype("biz_card");
// 设置支付宝业务卡号
model.settargetcardno("0000001");
// 设置持卡人信息
carduserinfo carduserinfo = new carduserinfo();
// uid参数未来计划废弃,存量商户可继续使用,新商户请使用openid。请根据应用-开发配置-openid配置选择支持的字段。
// carduserinfo.setuseruniid("2088302463082075");
说明
target_card_no:会员卡业务号,在调用开卡接口成功后支付宝返回的 biz_card_no 参数的值。
user_uni_id(open_id):支付宝用户 id。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请
更多入参及响应示例详情可查看 alipay.marketing.card.query(会员卡查询接口)文档。
2 会员卡删除接口
商家/服务商可调用 alipay.marketing.card.delete(会员卡删卡接口)删除指定会员卡。
2.1 请求示例
说明:
out_serial_no 为请求唯一标识,每次请求需保证唯一。
target_card_no 为会员卡业务号,调用开卡接口成功后支付宝返回的 biz_card_no 参数的值。
更多入参及响应示例详情可查看 alipay.marketing.card.delete(会员卡删卡接口)文档。
3 会员卡模板修改接口
商家/服务商可调用 alipay.marketing.card.template.modify(会员卡模板修改接口),修改该模板样式等信息。
注意:
修改会员卡模板后,该模板下所有会员卡都会更新(包括已发放会员卡)。
修改会员卡模板,field_rule_list(字段规则列表)配置项不支持修改,设置后无效。
其它修改项因为线上缓存的缘故,模板更新可能存在 1 ~ 5 分钟延时。
3.1 请求示例
说明:
request_id 为请求唯一标识,每次请求请保证唯一性。
logo_id 和 background_id 通过 alipay.offline.material.image.upload(上传门店照片和视频接口)获取。
更多入参及响应示例详情可查看 alipay.marketing.card.template.modify(会员卡模板修改接口)文档。
3.2 修改标准会员卡模板
通过卡面基础装修,修改标准的商家会员卡模板。
4 会员卡模板查询接口
商家/服务商可调用alipay.marketing.card.template.query(会员卡模板查询接口)查询指定模板详情。
4.1 请求示例
说明:template_id :模板 id,通过会员卡模板创建接口获取。
更多入参及响应示例详情可查看alipay.marketing.card.template.query(会员卡模板查询接口)文档。
在商家完成接入会员卡的基本链路后,扩展功能可满足商家会员卡的个性化营销需求和玩法,通过额外的接口配置等步骤,实现生活号、小程序和蜻蜓设备的联动。
5 小程序服务直达
商家会员卡为商家在会员卡上开辟了至多 3 个卡行动点,商家可以在卡行动点上设置小程序/url 跳转链接,引导用户在会员卡复访小程序或商家页面,为商家页面引流。
商家在 alipay.marketing.card.template.create(会员卡模板创建接口)中 card_action_list 传入指定跳转小程序页面或其它 url 地址即可引导用户前往,精准引流。
5.1 卡行动点案例
行动点:即用户可点击跳转的区块,类似按钮控件的交互。
用户可在 支付宝客户端 > 卡包 > 卡券 > 会员卡 列表页(左图)中看到小程序卡行动点信息(列表页可以展示最多 2 项小程序跳转行动点),方便用户快速使用复访小程序。
用户点击会员卡进入详情页(右图),可在所有行动点中选择使用所需功能。
1 (2).jpeg

5.2 卡行动点字段
开发者可在 alipay.marketing.card.template.create(会员卡模板创建接口)通过以下参数配置卡行动点。
参数
类型
是否必填
描述
card_action_list
templateactioninfodto[]

卡行动点配置。单张卡最多定制 3 个行动点。如果各项的配置内容完全一样,展示时会进行去重。
l code
string

行动点业务 code,商家自定义。
示例值:to_clock_in
最大长度:32
l text
string

行动点展示文案。
示例值打卡
最大长度:6
l url_type
string

跳转链接类型,默认为 url。枚举值:
url:对应填写 url 参数,支持 http(s) 和支付宝 schema 地址等,该类型仅支持卡详情展示。
miniappurl:对应填写 mini_app_url 参数,跳转至指定的支付宝小程序页面。
最大长度:32
l url
string
特殊可选
行动点跳转链接,当 url_type 为 url 或不填时必填。
最大长度:1024
l mini_app_url
templateactionminiappurldto
特殊可选
小程序页面跳转链接。当 url_type 取 miniappurl 时必填。
最大长度:999
5.2.1 mini_app_url 对应的字段配置项
参数名称
具体类型
是否必填
描述
mini_app_id
string

小程序 appid。
示例值:2018xxxxxxx
最大长度:20
mini_page_param
string

指定小程序页面,不填则默认跳转至对应小程序凯发k8官方网娱乐官方首页。
示例值:pages/index/index
最大长度:20
mini_query_param
string

query 参数,商家自定义传参,填入值将以 query 为参数名提交至指定小程序页面。
示例值:key1=val1&key2=val2
最大长度:50
display_on_list
string

行动点按钮是否在列表页展示,true 或 false,不填则默认 false。列表页可以配置展示最多 2 项小程序跳转行动点。
示例值:false
最大长度:5
说明:
mini_page_param 和 mini_query_param 分别对应小程序跳转 scheme 中的 page 和 query 参数。
display_on_list 字段设置行动点在列表页前置透出(支付宝客户端32版本及以上)。
display_on_list 字段设置为 true,则会在列表页前置透出按钮。
5.2.2 配置规则说明
card_action_list 最多配置 3 项,即 1 张卡最多配置 3 个按钮。
所有按钮都可以自由选择配置为小程序跳转链接或普通链接。
display_on_list=true 的行动点只能配置 0 项或 2 项,不支持 1、3 项。
6 会员卡权益配置
通过此产品功能,商家可结合自身的运营需求,面向新老会员用户发放相应的会员权益,从而提高新会员开卡转化率,老会员复购活跃率,最终推动商家的业务转化提高。
6.1 会员通用权益
此类权益主要是用于向用户介绍,成为商家会员用户之后,可享受的会员特权,例如常见的会员双倍积分,会员日特价等,均可以通过此模块功能向用户展示。
6.1.1 展示场景
场景 1:开卡环节,在开卡组件页面展示(全屏开卡组件和半屏开卡组件均支持),告知用户成为会员之后,可享受的会员权益,促进用户的开卡转化。
image.png

场景 2:开卡成功之后,用户进入 支付宝 > 卡包,点击商家的会员卡,进入卡详情页时,可查卡当前会员卡权益内容。
image.png

6.1.2 配置方式
商家可登录 商家平台 > 运营中心 > 进行可视化配置,具体操作路径可查看 基础会员卡装修及管理
6.2 新会员入会礼
6.2.1 展示场景
针对新会员首次开卡入会,商户可通过配置入会礼来吸引用户开卡,提高新会员开卡转化率。
image.png

6.2.2 配置方式
第一步:商家需要先完成开卡礼活动的创建,并获取到开卡礼活动 id。创建开卡礼活动,商家可登录到 商家平台 > 运营中心 > 会员卡模块 进行可视化配置,具体操作路径可查看 配置入会礼
第二步:商家在前端在调用开卡组件时,需要将对应的活动 id 作为入参,传给开卡组件。具体字段和传参,可查看 前端集成开卡组件模块
7 会员卡模板定制化展示
商家可通过 alipay.marketing.card.template.create(会员卡模板创建接口)提供了一系列参数帮助开发者实现会员卡的定制化展示。
也支持登录 商家平台 > 运营中心 > ,进行可视化的会员卡模板定制化展示样式配置。
7.1 展示样式
商家会员卡模板 默认使用列表的排版 展示自定义栏位(如以下左图中所示),商家也可以使用 宫格图标排列 的方式展示自定义栏位(如以下右图中所示)。
商家通过 template_style_info#column_info_layout 参数来控制如下栏位展示样式。样式支持:
list:栏位以列表的形式展示,默认为 list。
grid:栏位以图标宫格的样式展示;展示的图标需要开发者将图标素材通过 alipay.offline.material.image.upload(上传门店照片和视频接口)上传,返回得到图标的 image_id,将得到的 image_id 的值传入到 alipay.marketing.card.template.create(会员卡模板创建接口) column_info_list 中的 icon_id 参数中。
注意:列表与宫格展示形式在权益信息上存在如下区别:
list(列表展示)样式 会员权益 可通过权益信息 template_benefit_info 参数配置会员卡权益说明。
grid(宫格展示)样式不展示 template_benefit_info 参数配置的权益说明,需要在 column_info_list#code 中自定义会员权益信息。

7.2 会员等级
商家通过在 column_info_list 的 code 参数中传入 level 可以展示给用户会员卡的等级,并通过 card_level_conf 参数配置会员卡级别信息。实现会员的分层营销,激励用户消费,提高用户和商家之间的粘度。
后续向用户开卡或更新用户会员等级时,仅需传入 card_level_conf#level 对应的 value 值即可。
7.2.1 示例代码
7.3 会员积分
商家通过在 column_info_listcode 参数中传入 point 可以展示会员卡的积分,积分可以和权益挂钩,刺激用户消费。
建议商家实时更新此项内容至支付宝,方便用户通过卡包页随时查看积分信息
当商家将积分更新消息通知支付宝后,用户可在支付宝端内收到积分更新消息通知
7.3.1 示例代码
7.4 余额信息
商家的会员卡为充值会员卡时,商家可通过在 column_info_listcode 参数中传入 balance 和值,用户可在会员卡中查看余额信息
当商家将余额变动消息通知卡包时,用户可在支付宝端内收到余额变动的通知消息
7.4.1 示例代码
7.5 凯发k8官方网娱乐官方的联系方式
商家可以将自身客服凯发k8官方网娱乐官方的联系方式展示在会员卡上,方便用户随时联系商家进行沟通反馈。商家通过在 column_info_listcode 参数中传入 telephone 和 value 值可以展示凯发k8官方网娱乐官方的联系方式。
7.5.1 示例代码
7.6 按会员等级展示不同卡片内容
若商家需针对不同等级会员展示不同样式会员卡,推荐按如下方案开发逻辑:
1商家需预先根据不同会员卡等级,创建不同卡模板样式与之对应;
2当用户会员卡达到某个等级时,商家可调用 alipay.marketing.card.update(会员卡更新接口)完成更新即可,该接口仅会更新指定会员卡内容,不会影响其它会员卡。
传入用户对应会员卡开卡时,接口返回会员卡 target_card_no(支付宝业务卡号)。
传入更换会员卡模板 template_id 。
7.7 动态会员码
商家/服务商如需在用户在支付宝卡包中打开会员卡时,展示自行生成的动态二维码/条形码,可根据 商户动态发码 指引集成动态发码功能。
7.8 其它参数
在创建会员卡模板时对应的其它参数如下图所示:
image.png

8 iot 刷脸开卡
除了支持通过支付宝端内引导用户领卡入会,商家会员卡产品也支持,通过线下刷脸支付机具,引导用户进行刷脸入会领卡。
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图