商户会员卡

产品介绍

会员卡产品是商户营销的基础能力，满足商户对于持有会员卡用户的营销需求。会员卡功能主要围绕会员卡的创建、领取、修改以及同步交易设置了一系列接口，开发者可以根据自己想实现的效果选择合适的接口进行开发，以实现行业各有特色的会员卡应用。商户可以根据自己需求，自由组合实现电子会员卡功能：引导用户开卡、积分查询、交易记录、卡会员等级查询、卡权益展示、卡适用门店展示等。

产品特色

具有灵活的自主性，商户可以根据自己的业务场景，在任何环节下只需用户授权开通会员卡，无需用户填写会员信息，授权成功后自动给用户开通会员卡。并且可将会员卡的积分变化和交易变化等同步到支付宝卡券包。

使用场景

  • 商户可以将线下会员卡在线电子化：对接会员卡接口，让原有线下用户在支付宝客户端绑定线下会员卡。

  • 商户在小程序内给新用户发电子会员卡：商户可对接会员卡接口，让用户在小程序内申请新会员卡。

  • 商户可以配置会员卡展示内容：例如该会员的卡积分、交易记录，权益、等级等信息。这些信息可以根据不同商户需求，由商户自定义展示。

  • 会员卡自定义菜单配置：商户可在会员卡的菜单配置跳转到小程序。

  • 会员卡首页配置小程序菜单：商户可在会员卡首页上配置跳转到小程序，让用户在卡包-会员卡首页唤起小程序。

备注：会员卡的自定义菜单不允许配置线上充值的菜单。

使用说明

典型使用场景：

  • 商户使用会员卡产品完成会员卡模板创建。

  • 商户通过小程序引导用户领取卡，在用户授权的前提下，商户调用接口向用户发会员卡。

  • 拿到会员卡后，用户到商户消费使用该会员卡，进行消费，可获得会员优惠或者会员积分。

  • 用户可以在支付宝客户端卡券包里查看到该卡，并看到该卡的会员权益或积分或消费记录。

  • 商户可在会员卡首页以及菜单配置跳转到小程序，实现从小程序跳转到卡包，再从会员卡跳转回小程序。

业务流程及对应接口使用介绍：商户会员卡 - 图1

应用案例

小程序内领卡

用户可在小程序内完成领卡动作，若用户已经领过卡了，可以跳转到卡详情页，让用户查询卡积分权益等。用户端交互如下：

  • 用户进入会员卡领取页面，选择办理会员卡；

  • 进入会员开卡信息授权页面，用户确认授权信息后，自动填充会员信息并开通会员卡；

  • 开卡成功后，商户可自定义成功页面，可引导用户查看会员卡，若商户不想开发卡详情页可以引导跳转到卡包的卡详情页；

  • 在会员卡中配置跳转到小程序的菜单（通过小程序链接的方式），用户在会员卡详情页跳转到小程序。

商户会员卡 - 图2商户会员卡 - 图3

商户会员卡 - 图4

老会员绑定

商户可将已有的老会员快速同步到支付宝卡系统。用户领取会员卡时，可提供老会员绑定入口。用户进入老会员入口后进行身份识别并激活，激活后领卡成功。以大悦城会员卡为例，用户端交互如下：

  • 用户到商户页面领取会员卡，选择已有会员卡入口；

  • 用户在外链网页中设置老会员身份识别的选项，譬如手机号、会员号等唯一标识；

  • 商户接收到用户填写的会员信息并校验后，通过用户授权的情况下向用户发卡；并调用会员卡接口同步会员的积分等权益信息；

  • 在会员卡中配置跳转到小程序的菜单，用户在会员卡详情页跳转到小程序。

商户会员卡 - 图5

准入条件

1、会员卡接入无任何门槛条件，所有商户均可使用；2、开卡页面的会员信息默认不回填（姓名、生日、手机号码），由用户自主填写；只有授权的商户才能默认回填用户信息，如需获取用户信息，可向对接的BD申请，若无对接的业务BD，可以去小程序社区发帖申请，我们会有对口的小二来协助能力申请。

计费模式

不收费

接入介绍

添加商户会员卡

在小程序详情页的功能列表中添加“商户会员卡”和“支付宝卡包”两个功能包，如下图所示：商户会员卡 - 图6

接口调用

创建会员卡模板

接口名称：会员卡模板创建（alipay.marketing.card.template.create）会员卡模板模型介绍

  • 模板基本信息：会员卡名称、会员卡类型、核销方式等基本信息；

  • 模板样式信息：卡包详情页面的会员卡展现效果；

  • 会员权益信息：会员卡模板定义的会员权益是通用权益，其下发行的所有会员卡会继承该模板定义的通用权益；

  • 模板栏位信息：在卡包详情页面展现的会员卡功能栏位；

  • 会员卡属性规则：会员卡属性规则主要用于说明开卡流程中，如何从请求参数中解析会员卡信息。

商户会员卡 - 图7商户会员卡 - 图8

SDK 调用示例：

  1. /**
  2.  * 创建会员卡模板
  3.  * @param appAuthToken如ISV代替商户调用接口，需将商户授权后获取的app_auth_token带上；如商户自己调用，则传null。
  4.  * @param bizContent 因该接口业务参数复杂，请详见接口文档
  5.  * @return
  6.  * @throws AlipayApiException 请处理异常
  7.  */
  8.  AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); 
  9.  AlipayMarketingCardTemplateCreateRequest request = new AlipayMarketingCardTemplateCreateRequest();
  10.  request.putOtherTextParam("app_auth_token", appAuthToken);
  11.  request.setBizContent(bizContent);
  12.  AlipayMarketingCardTemplateCreateResponse response=alipayClient.execute(request);
  13.  System.out.println(response.getBody());

app_auth_token 在 ISV 代替商户调用接口时使用，商户自己调用，可传 null。bizContent Json 串示例：

  1. "{"
  2.                 + "\"request_id\":\"20160805100000023100679\","
  3.                 + "\"card_type\":\"OUT_MEMBER_CARD\","
  4.                 + "\"biz_no_prefix\":\"prexupdate\","
  5.                 + "\"biz_no_suffix_len\":\"10\","
  6.                 + "\"write_off_type\":\"qrcode\","
  7.                 + "\"template_style_info\":{"
  8.                 + "\"card_show_name\":\"花呗会员卡测试\","
  9.                 + "\"logo_id\":\"OKWBUiWCQ761MdRzP4PvUwAAACM****\","
  10.                 + "\"color\":\"rgb(55,112,179)\","
  11.                 + "\"background_id\":\"OKWBUiWCQ761MdRzP4PvUwAAACMA****\","
  12.                 + "\"bg_color\":\"rgb(55,112,179)\"},"
  13.                 + "\"template_benefit_info\":[{\"title\":\"消费即折扣\","
  14.                 + "\"benefit_desc\":[\"消费即折扣\",\"会员日7折扣\"],"
  15.                 + "\"start_date\":\"2016-08-18 15:17:23\","
  16.                 + "\"end_date\":\"2016-09-14 12:12:12\"}],"
  17.                 + "\"column_info_list\":[{\"code\":\"BENEFIT_INFO\",\"more_info\":{\"title\":\"扩展信息\",\"url\":\"http://www.baidu.com\","
  18.                 + "\"params\":\"{}\"},"
  19.                 + "\"title\":\"专属权益修改\",\"operate_type\":\"openWeb\",\"value\":\"会员权益\"},"
  20.                 +"{\"code\":\"BALANCE\",\"title\":\"余额\",\"value\":\"\"},"
  21.                +"{\"code\":\"TELEPHOME\",\"title\":\"手机号码\",\"value\":\"15000784967\"},"
  22.                +"{\"code\":\"Point\",\"title\":\"积分\",\"value\":\"100\"}"
  23.                 + "],"
  24.                 + "\"field_rule_list\":[{\"field_name\":\"Balance\",\"rule_name\":\"ASSIGN_FROM_REQUEST\",\"rule_value\":\"Balance\"},"
  25.                 + "{\"field_name\":\"Point\",\"rule_name\":\"CONST\",\"rule_value\":\"100\"}]}"

说明：1. request_id 为请求唯一标识，每次请求请保证唯一性；2. logo_id 和background_id 通过支付宝图片资料上传接口（alipay.offline.material.image.upload）获取；3. logo 图片规范：1M以内，格式：bmp，png，jpeg，jpg，gif；尺寸不小于 500px500px 的等边矩形；请优选使用商户logo；background 图片规范：2M以内，格式：bmp，png，jpeg，jpg，gif；尺寸不小于 1020px643px 的等边矩形；图片不得有圆角，不得拉伸变形；4. 具体 json 字段说明，请查看创建会员卡模板。

配置会员卡行动点（按钮）关联小程序

卡行动点（按钮）配置在创建会员卡模板接口（alipay.marketing.card.template.create）的 card_action_list 字段，对应:

参数名称具体类型必填最大长度示例值描述
codeString是32TO_CLOCK_IN行动点业务CODE，商户自定义
textString是6打卡行动点展示文案
url_typeString可选20miniAppUrl跳转链接类型，当前支持miniAppUrl：* miniAppUrl: 对应填写mini_app_url参数，跳转至指定的支付宝小程序页面
mini_app_urlTemplateActionMiniAppUrlDTO可选999小程序页面跳转链接当url_type取"miniAppUrl"时必填

小程序页面跳转链接配置项 mini_app_url 对应的字段配置项如下：

参数名称具体类型必填最大长度示例值描述
mini_app_idString是202018xxxxxxx小程序appId
mini_page_paramString可选20xxxxxxxx指定小程序页面，不填则默认跳转至对应小程序首页
mini_query_paramString可选50abcxxxxxxquery参数，商户自定义传参，填入值将以"query"为参数名提交至指定小程序页面
display_on_listString可选5false行动点按钮是否在列表页展示，true 或 false，不填则默认false；列表页可以配置展示最多2项小程序跳转行动点。

其中 mini_page_param 和 mini_query_param 分别对应小程序跳转 schema 中的 page 和 query 参数。

display_on_list字段设置行动点在列表页前置透出（支付宝客户端32版本及以上）

display_on_list 字段设置为 true，则会在列表页前置透出按钮；

配置规则说明：

  • card_action_list 最多配置4项，即1张卡最多配置4个按钮；

  • 所有按钮都可以自由选择配置为小程序跳转链接或普通链接；

  • display_on_list=true 的行动点只能配置0项或2项，不支持1,3,4项。

配置效果图

商户会员卡 - 图9

会员卡开卡表单模板配置

接口名称：会员卡开卡表单模板配置（alipay.marketing.card.formtemplate.set）商户需要对领卡页面的表单字段进行配置。SDK 调用示例：

  1. AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
  2. AlipayMarketingCardFormtemplateSetRequest request = new AlipayMarketingCardFormtemplateSetRequest();
  3. request.setBizContent(bizContent);
  4. AlipayMarketingCardFormtemplateSetResponse response = alipayClient.execute(request);
  5. System.out.println(response.getBody());

bizContent JSON 串示例：

  1. "{" +
  2.         "  \"template_id\": \"20170228000000000210102000300974\"," +
  3.         "  \"fields\": {" +
  4.         "    \"required\": {" +
  5.         "      \"common_fields\": [" +
  6.         "        \"OPEN_FORM_FIELD_MOBILE\"" +
  7.         "      ]" +
  8.         "    }," +
  9.         "    \"optional\": {" +
  10.         "      \"common_fields\": [" +
  11.         "        \"OPEN_FORM_FIELD_GENDER\"" +
  12.         "      ]" +
  13.         "    }" +
  14.         "  }" +
  15. "}"

说明：

获取会员卡领卡投放链接

接口名称：获取会员卡领卡投放链接（alipay.marketing.card.activateurl.apply）商户在配置完成会员卡开卡表单页面后，可获取会员卡领卡投放链接，领卡链接可投放于支付宝生活号、小程序内。

注意：在支付宝小程序中，callback 参数不用传输。在使用该接口返回的 url 时需要进行解码后方能使用。

SDK 调用示例：

  1. AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
  2. AlipayMarketingCardActivateurlApplyRequest request = new AlipayMarketingCardActivateurlApplyRequest();
  3. request.setBizContent(bizContent);
  4. AlipayMarketingCardActivateurlApplyResponse response = alipayClient.execute(request);
  5. System.out.println(response.getBody());

bizContent JSON串示例：

  1. "{" + 
  2.         "  \"template_id\": \"20170228000000000210102000300974\"," +
  3.         "  \"callback\": \"https://alipay.com/card/demo.htm\"," +
  4.         "  \"out_string\": \"201928393932\"" +
  5. "}"

说明：

  • template_id 为会员卡模板ID，创建会员卡模板将会返回该id；

  • callback 为会员卡领卡表单页面成功回调地址，此地址需要与应用配置的授权回调地址相同；

  • out_string 参数由商户自定义设置，确认领卡成功后将作为 url 参数拼接在 callback 回调地址之后原样带回；

  • apply_card_url 参数返回的会员卡领卡链接使用时需 URLDecode 解码；

  • 具体的 json 字段说明请查看：获取会员卡领卡投放链接。

小程序内唤起会员开卡授权页面

接口名称：获取会员卡领卡投放链接（my.addCardAuth）调用此接口在小程序内唤起会员开卡页面，开卡对用户展示页面示例如下，具体展示信息字段依商户“会员卡表单配置”而定；开卡页面的会员信息默认不回填（姓名、生日、手机号码），由用户自主填写；只有授权的商户才能默认回填用户信息，如需获取用户信息，可向对接的BD申请，若无对接的业务BD，可以去小程序社区发帖申请，我们会有对口的小二来协助能力申请。商户会员卡 - 图10

查询用户提交的会员卡表单信息

接口名称：查询用户提交的会员卡表单信息（alipay.marketing.card.activateform.query）用户通过会员卡领卡链接打开会员卡领卡表单页面，点击确认领取会员卡后，支付宝将会回调商户在获取领卡投放链接时配置的 callback 地址，并且回传 requestId 参数。商户可通过 requestId 参数使用“会员卡表单信息查询接口”从支付宝查询用户此次领取会员卡表单提交的信息，便于用户后续会员卡开卡。

SDK 调用示例：

  1. AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
  2. AlipayMarketingCardActivateformQueryRequest request = new AlipayMarketingCardActivateformQueryRequest();
  3. request.setBizContent(bizConent);
  4. AlipayMarketingCardActivateformQueryResponse response = alipayClient.execute(request,accessToken);
  5. System.out.println(response.getBody());

bizContent JSON串示例：

  1. "{" +
  2.         "  \"biz_type\": \"MEMBER_CARD\"," +
  3.         "  \"template_id\": \"20170228000000000210102000300974\"," +
  4.         "  \"request_id\": \"2017021929993993992839493394\"" +
  5. "}"

说明：

  • template_id 为会员卡模板ID，创建会员卡模板将会返回该id；

  • request_id 为支付宝回调商户地址时回传的参数；

  • 具体的 json 字段说明请查看：查询用户提交的会员卡表单信息。

会员卡开卡

接口名称：会员卡开卡（alipay.marketing.card.open）会员卡模型介绍

会员卡开卡需要根据支付宝端的模板ID，为用户发行商户会员卡。针对商户发行的会员卡，调用会员开卡接口，主要完成商户会员卡的电子化，从而在钱包端展现会员卡，同时将卡信息保存至支付宝系统。会员卡请求模型主要包含开卡请求基本信息（如外部流水号、会员卡模板等），会员信息，会员卡信息和扩展信息这几个部分。商户会员卡 - 图11

SDK 调用示例：

  1. /**
  2.  * 会员卡开卡
  3.  * @param appAuthToken如ISV代替商户调用接口，需将商户授权后获取的app_auth_token带上；如商户自己调用，则传null。
  4.  * @param bizContent 因该接口业务参数复杂，请详见接口文档
  5.  * @return
  6.  * @throws AlipayApiException 请处理异常
  7.  */
  8.  AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); 
  9.  AlipayMarketingCardOpenRequest request = new AlipayMarketingCardOpenRequest();
  10.  request.putOtherTextParam("app_auth_token", appAuthToken);
  11.  request.setBizContent(bizContent);
  12.  AlipayMarketingCardOpenResponse response = alipayClient.execute(request,accessToken);
  13.  System.out.println(response.getBody());

app_auth_token 在 ISV 代替商户调用接口时使用，商户自己调用，可传 null；accessToken 通过用户信息授权获取，其中第一步 url 拼接中scope的值必需设置为 auth_ecard。

bizContent Json串示例：

  1. "{" 
  2.         +"\"out_serial_no\":\"2016100910482088139\","//唯一标识
  3.         +"\"card_template_id\":\"2016100900000000001410200030****\","//会员卡模板id，通过模板创建接口返回得到 
  4.         +"\"card_user_info\":{" 
  5.         +"\"user_uni_id\":\"20884025********\"," //支付宝userid(一般2088开头)
  6.         +"\"user_uni_id_type\":\"UID\"}," 
  7.         +"\"card_ext_info\":{\"external_card_no\":\"EXT0003\","//商户会员卡卡号
  8.         + "\"open_date\":\"2016-10-08 14:20:00\",\"valid_date\":\"2020-02-20 21:20:46\",\"level\":\"VIP1\",\"point\":\"88\",\"balance\":\"124.89\"}," 
  9.         +"\"member_ext_info\":{\"name\":\"萧沫\",\"gende\":\"FEMALE\",\"birth\":\"2016-06-27\",\"cell\":\"13000000000\"}}"

说明：

  • out_serial_no 为唯一标识号，每次请求保障唯一；

  • card_template_id 为模板 id，通过会员卡模板创建接口获取；

  • user_uni_id 为支付宝账户 userid，为2088开头的16为数字，通过用户信息授权获取；

  • 具体 json 字段说明，请查看会员卡开卡；

  • 开卡成功后，登录到 userid 对应账号的支付宝钱包内卡券类目下查看发送成功的会员卡。

会员卡查询接口

接口名称：会员卡查询（alipay.marketing.card.query）

SDK 调用示例：

  1. /**
  2.  * 会员卡查询
  3. * @param appAuthToken如ISV代替商户调用接口，需将商户授权后获取的app_auth_token带上；如商户自己调用，则传null。
  4.  * @param bizContent 因该接口业务参数复杂，请详见接口文档
  5.  * @return
  6.  * @throws AlipayApiException 请处理异常
  7.  */
  8.  AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); 
  9.  AlipayMarketingCardQueryRequest request = new AlipayMarketingCardQueryRequest();
  10.  request.putOtherTextParam("app_auth_token", appAuthToken);
  11.  request.setBizContent(bizContent);
  12.  AlipayMarketingCardQueryResponse response = alipayClient.execute(request);
  13.  System.out.println(response.getBody());

bizContent Json串示例：

  1. "{" 
  2.                 +"\"target_card_no\":\"prex0000001781\"," 
  3.                 +"\"target_card_no_type\":\"BIZ_CARD\"," 
  4.                 +"\"card_user_info\":{" 
  5.                 +"\"user_uni_id\":\"20884025********\"," 
  6.                 +"\"user_uni_id_type\":\"UID\"" 
  7.                 +"}}"

说明：

  • target_card_no 为会员卡业务号，在调用开卡接口成功后支付宝返回的biz_card_no参数的值；

  • user_uni_id为支付宝用户号 userid，为2088开头的16位数字；

  • 具体 json 字段说明，请查看会员卡查询。

会员卡更新接口

接口名称：会员卡更新（alipay.marketing.card.update）

SDK 调用示例：

  1. /**
  2.  * 会员卡更新
  3. * @param appAuthToken如ISV代替商户调用接口，需将商户授权后获取的app_auth_token带上；如商户自己调用，则传null。
  4.  * @param bizContent 因该接口业务参数复杂，请详见接口文档
  5.  * @return
  6.  * @throws AlipayApiException 请处理异常
  7.  */
  8.  AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
  9.  AlipayMarketingCardUpdateRequest request = new AlipayMarketingCardUpdateRequest();
  10.  request.putOtherTextParam("app_auth_token", appAuthToken);
  11.  request.setBizContent(bizContent);
  12.  AlipayMarketingCardUpdateResponse response = alipayClient.execute(request);
  13.  System.out.println(response.getBody());

bizContent Json串示例：

  1. "{"
  2.                 +"\"target_card_no\":\"prex0000002507\"," 
  3.                 +"\"target_card_no_type\":\"BIZ_CARD\"," 
  4.                 +"\"occur_time\":\"2016-09-27 12:12:12\"," 
  5.                 +"\"card_info\":{" 
  6.                 +"\"open_date\":\"2014-02-20 21:20:46\"," 
  7.                 +"\"valid_date\":\"2020-02-20 21:20:46\"," 
  8.                 +"\"level\":\"VIP1\"," 
  9.                 +"\"point\":\"188\"," 
  10.                 +"\"balance\":\"128\"}"
  11.                 +"}"

说明：

  • target_card_no为会员卡业务号，在调用开卡接口成功后支付宝返回的biz_card_no参数的值；

  • 具体 json 字段说明，请查看会员卡更新。

会员卡删除接口

接口名称：会员卡删卡（alipay.marketing.card.delete）

SDK 调用示例：

  1. /**
  2.  * 会员卡删除
  3. * @param appAuthToken如ISV代替商户调用接口，需将商户授权后获取的app_auth_token带上；如商户自己调用，则传null。
  4.  * @param bizContent 因该接口业务参数复杂，请详见接口文档
  5.  * @return
  6.  * @throws AlipayApiException 请处理异常
  7.  */
  8.  AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
  9.  AlipayMarketingCardDeleteRequest request = new AlipayMarketingCardDeleteRequest();
  10.  request.putOtherTextParam("app_auth_token", appAuthToken);
  11.  request.setBizContent(bizContent);
  12.  AlipayMarketingCardDeleteResponse response = alipayClient.execute(request);
  13.  System.out.println(response.getBody());

bizCotent Json示例：

  1. "{" 
  2.                 +"\"out_serial_no\":\"2016100910482088139\"," 
  3.                 +"\"target_card_no\":\"prexupdate0000002781\"," 
  4.                 +"\"target_card_no_type\":\"BIZ_CARD\"," 
  5.                 +"\"reason_code\":\"USER_UNBUND\"" 
  6.                 +"}"

说明：

  • out_serial_no 为开卡时的唯一标识，调用开卡接口时做保存记录；

  • target_card_no 为会员卡业务号，调用开卡接口成功后支付宝返回的 biz_card_no 参数的值；

  • 具体 json 字段说明，请查看会员卡删卡。

会员卡模板修改接口

接口名称：会员卡模板修改（alipay.marketing.card.template.modify）

SDK 调用示例：

  1. /**
  2.  * 会员卡模板修改
  3. @param appAuthToken如ISV代替商户调用接口，需将商户授权后获取的app_auth_token带上；如商户自己调用，则传null。
  4.  * @param bizContent 因该接口业务参数复杂，请详见接口文档
  5.  * @return
  6.  * @throws AlipayApiException 请处理异常
  7.  */
  8.  AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
  9.  AlipayMarketingCardTemplateModifyRequest request = new AlipayMarketingCardTemplateModifyRequest();
  10.  request.putOtherTextParam("app_auth_token", appAuthToken);
  11.  request.setBizContent(bizContent);
  12.  AlipayMarketingCardTemplateModifyResponse response=alipayClient.execute(request);
  13.  System.out.println(response.getBody());

bizContent Json示例：

  1. "{"
  2.                 + "\"request_id\":\"201608051001121023100679\","
  3.                 + "\"template_id\":\"20161009000000000014102000300197\","
  4.                 + "\"biz_no_prefix\":\"prexupdate\","
  5.                 + "\"write_off_type\":\"qrcode\","
  6.                 + "\"template_style_info\":{"
  7.                 + "\"card_show_name\":\"花呗会员卡测试\","
  8.                 + "\"logo_id\":\"OKWBUiWCQ761MdRzP4PvUwAAACMAAQED\","
  9.                 + "\"color\":\"rgb(55,112,179)\","
  10.                 + "\"background_id\":\"OKWBUiWCQ761MdRzP4PvUwAAACMAAQED\","
  11.                 + "\"bg_color\":\"rgb(55,112,179)\"},"
  12.                 + "\"template_benefit_info\":[{\"title\":\"消费即折扣\","
  13.                 + "\"benefit_desc\":[\"消费即折扣\",\"会员日7折扣\"],"
  14.                 + "\"start_date\":\"2016-08-18 15:17:23\","
  15.                 + "\"end_date\":\"2016-09-14 12:12:12\"}],"
  16.                 + "\"column_info_list\":[{\"code\":\"BENEFIT_INFO\",\"more_info\":{\"title\":\"扩展信息\",\"url\":\"http://www.baidu.com\","
  17.                 + "\"params\":\"{\\\"cardNo\\\":\\\"$CardNo$\\\"}\"},"
  18.                 + "\"title\":\"专属权益修改\",\"operate_type\":\"openWeb\",\"value\":\"会员权益\"},"
  19.                 +"{\"code\":\"BALANCE\",\"title\":\"余额\",\"value\":\"\"},"
  20.                +"{\"code\":\"TELEPHOME\",\"title\":\"手机号码\",\"value\":\"15000784967\"},"
  21.                +"{\"code\":\"Point\",\"title\":\"积分\",\"value\":\"100\"}"
  22.                 + "],"
  23.                 + "\"field_rule_list\":[{\"field_name\":\"Balance\",\"rule_name\":\"ASSIGN_FROM_REQUEST\",\"rule_value\":\"Balance\"},"
  24.                 + "{\"field_name\":\"Point\",\"rule_name\":\"CONST\",\"rule_value\":\"100\"}]}"

说明：

会员卡模板查询接口

接口名称：会员卡模板查询接口（alipay.marketing.card.template.query）

SDK调用示例：

  1. /**
  2.  * 会员卡模板查询
  3. @param appAuthToken如ISV代替商户调用接口，需将商户授权后获取的app_auth_token带上；如商户自己调用，则传null。
  4.  * @param bizContent 因该接口业务参数复杂，请详见接口文档
  5.  * @return
  6.  * @throws AlipayApiException 请处理异常
  7.  */
  8.  AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
  9.  AlipayMarketingCardTemplateQueryRequest request = new AlipayMarketingCardTemplateQueryRequest();
  10.  request.putOtherTextParam("app_auth_token", appAuthToken);
  11.  request.setBizContent("{"
  12.                 +"\"template_id\":\""+templateid+"\""
  13.                 +"}");
  14.  AlipayMarketingCardTemplateQueryResponse response=alipayClient.execute(request);
  15.  System.out.println(response.getBody());

说明：

  • template_id 为模板 id，通过会员卡模板创建接口获取；

  • 具体 json 字段说明，请查看会员卡模板查询。

接口调用流程：

支付宝会员卡包含以下接口

接口英文名接口中文名接口描述
alipay.marketing.card.template.create会员卡模板创建创建会员卡模板
alipay.marketing.card.template.modify会员卡模板修改修改会员卡模板
alipay.marketing.card.template.query会员卡模板查询接口查询会员卡模板
alipay.marketing.card.formtemplate.set会员卡开卡表单模板配置会员卡开卡表单模板配置
alipay.marketing.card.activateurl.apply获取会员卡领卡投放链接获取会员卡领卡投放链接
alipay.marketing.card.activateform.query查询用户提交的会员卡表单信息查询用户提交的会员卡表单信息
alipay.marketing.card.open会员卡开卡根据会员卡模板，向用户发行指定会员卡，会员卡接口需要用户授权
alipay.marketing.card.update会员卡更新更新会员卡信息
alipay.marketing.card.delete会员卡删卡删除会员卡，会同步删除支付宝端的卡信息以及钱包端的电子卡
alipay.marketing.card.query会员卡查询查询已存在会员卡信息

1.会员卡模板创建接口商户会员卡 - 图12

2.会员卡模板修改接口商户会员卡 - 图13

3.会员卡模板查询接口商户会员卡 - 图14

4.会员卡开卡表单模板配置接口商户会员卡 - 图15

5.获取会员卡领卡投放链接商户会员卡 - 图166.查询用户提交的会员卡表单信息商户会员卡 - 图17

7.会员卡开卡接口商户会员卡 - 图18

8.会员卡删卡接口商户会员卡 - 图19

API介绍

此列表包含该产品所涉及的所有接口，点击接口名称可查看接口的公共请求参数，业务请求参数，返回参数，其他语言请求示例以及错误码等。

基础接口

接口名称接口描述
alipay.offline.material.image.upload图片资料上传

会员卡模板管理

会员卡模板管理包含以下接口：

接口名称接口描述
alipay.marketing.card.template.create会员卡模板创建
alipay.marketing.card.template.modify会员卡模板修改
alipay.marketing.card.template.query会员卡模板查询接口

开卡组件

开卡组件包含以下接口：

接口名称接口描述
alipay.marketing.card.formtemplate.set会员卡开卡表单模板配置
alipay.marketing.card.activateurl.apply获取会员卡领卡投放链接
my.addCardAuth小程序内唤起开卡页面
alipay.marketing.card.activateform.query查询用户提交的会员卡表单信息

会员卡管理

会员卡管理包含以下接口：

接口名称接口描述
alipay.marketing.card.open会员卡开卡
alipay.marketing.card.update会员卡更新
alipay.marketing.card.delete会员卡删卡
alipay.marketing.card.query会员卡查询

小程序跳转到支付宝卡包

小程序跳转会员卡包含以下接口：

接口名称接口描述
my.openCardList打开支付宝卡包中的“卡”列表
my.openMerchantCardList打开当前用户领取某个商户的“卡”列表
my.openCardDetail打开当前用户领取某张卡的详情页