支付寶卡包產(chǎn)品介紹

2018-12-07 17:30 更新

支付寶卡包產(chǎn)品介紹

[TOC]

1.產(chǎn)品介紹

什么是支付寶卡包(alipass)? 支付寶卡包(alipass),是支付寶公司推出的一款可以管理電子憑證的產(chǎn)品,該產(chǎn)品聚合來自各類生活服務的票據(jù)憑證,包括優(yōu)惠券、折扣券、代金券、換購券、電影票、演出票、火車票、機票。 什么是支付寶卡包1

什么是支付寶卡包2

1.1 產(chǎn)品能力

產(chǎn)品特色

產(chǎn)品生命周期: 支付寶卡包產(chǎn)品特色

使用場景

企業(yè)或者個人開發(fā)者可以通過支付寶提供的開放接口,把卡券添加到支付寶卡包,用戶可以通過小程序查看卡券,同時支持跳轉(zhuǎn)到支付寶卡包頁面,在卡包中查看并使用商戶同步進來的卡券。 支付寶卡包使用場景

應用案例

電子門票使用流程

支付寶卡包電子門票使用流程

支付寶卡包電子門票使用流程2

產(chǎn)品關(guān)聯(lián)推薦

  • 商家方面,覆蓋面比較廣,涉及到所有發(fā)核券的商家均可使用。
  • 公共事業(yè)方面,也可以拓展,如:電子地鐵票等。

準入條件

  1. 公司運營穩(wěn)定,具有一定的客戶群。具體考核將參考公司運營時長、規(guī)模、用戶數(shù)來做出綜合判定;
  2. 公司具備一定的技術(shù)能力,能夠獨立完成技術(shù)對接;
  3. 支持合作后的服務聯(lián)動處理,數(shù)據(jù)反饋和異議處理。

計費模式

免費接口,暫未收取費用。

2.接入指引

2.1 添加支付寶卡包

在小程序“開發(fā)管理”詳情頁的“功能列表”中添加“支付寶卡包” 添加支付寶卡包

2.2接入支付寶卡包

卡包術(shù)語介紹

以下是支付寶卡包接口開發(fā)過程中需要了解的常用概念:

名稱 描述
模板/卡券模板(template) 模板包含了開發(fā)者設計的卡券的樣式、內(nèi)容信息?;诖四0宓臉邮?,開發(fā)者可以向用戶發(fā)放卡券,一個模板可以對應多個卡券,模板內(nèi)容樣式的變化會引起卡券的變化。
模板編號(templateId) 模板的唯一標識,由創(chuàng)建模板成功后,接口返回給商戶,基于此參數(shù)創(chuàng)建卡券。
卡券ID(passId) 卡券ID,唯一代表一張卡券。可以多個卡券ID對應一個模板。由卡券創(chuàng)建成功后返回。

2.3接口調(diào)用

使用說明

商家通過開放平臺提供的alipass接口,可完成從卡券模板設計到卡券實體構(gòu)造整個流程。 支付寶卡包接口調(diào)用

1.創(chuàng)建卡券模版: 支付寶卡包創(chuàng)建卡券模版

2.創(chuàng)建卡券: 支付寶創(chuàng)建卡券

接口調(diào)用流程

支付寶卡券整體接口調(diào)用流程: 支付寶卡包接口調(diào)用流程

創(chuàng)建卡券模板

  • 接口列表:創(chuàng)建卡券模板接口(alipay.pass.template.add)
  • SDK調(diào)用示例:

/**
 * 新建模板
 * appAuthToken如ISV代替商家調(diào)用接口,需將商戶授權(quán)后獲取的app_auth_token帶上;如商家自己調(diào)用,則傳null。
 * bizContent 因該接口業(yè)務參數(shù)復雜,請詳見接口文檔
 */
 AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
 AlipayPassTemplateAddRequest request = new AlipayPassTemplateAddRequest();
 request.putOtherTextParam("app_auth_token", appAuthToken);
 request.setBizContent(bizContent);
 AlipayPassTemplateAddResponse response=alipayClient.execute(request);
 System.out.print(response.getBody());//根據(jù)業(yè)務處理response

  • app_auth_token在ISV代替商家調(diào)用接口時使用,商家自己調(diào)用,可傳null。
  • bizContent Json串示例:

"{\"unique_id\":\"143512639346821\"," //支付寶對該參數(shù)的請求有唯一性校驗,請保證每次請求該參數(shù)唯一
                + "\"tpl_content\":"
                + "{\"logo\":\"https://alipass.alipay.com//temps/free/logo.png\","
                + "\"strip\":\"https://alipass.alipay.com//temps/free/strip.png\","
                + "\"icon\":\"http://alipassprod.test.alipay.net/temps/free/icon.png\","
                + "\"content\":{"
                + "\"evoucherInfo\":"
                + "{\"title\":\"風情優(yōu)惠券\","
                + "\"type\":\"coupon\","
                + "\"product\":\"free\","
                + "\"startDate\":\"$validStartDate$\","
                + "\"endDate\":\"$validEndDate$\","
                + "\"operation\":"
                + "[{\"format\":\"barcode\",\"message\":\"$code$\",\"messageEncoding\":\"UTF-8\",\"altText\":\"$code$\"}],"
                + "\"einfo\":{"
                + "\"logoText\":\"$logoText$\","
                + "\"headFields\":"
                + "[{\"key\":\"status\",\"label\":\"狀態(tài)\",\"value\":\"$useStateDesc$\",\"type\":\"text\"}],"
                + "\"primaryFields\":"
                + "[{\"key\":\"strip\",\"label\":\"\",\"value\":\"$discountInfo$\",\"type\":\"text\"}],"
                + "\"secondaryFields\":"
                + "[{\"key\":\"validDate\",\"label\":\"有效期至:\",\"value\":\"$validEndDate$\",\"type\":\"text\"}],"
                + "\"auxiliaryFields\":[],"
                + "\"backFields\":"
                + "[{\"key\":\"description\",\"label\":\"詳情描述\",\"value\":\"1.該優(yōu)惠有效期:截止至2014年06月18日;\n2.憑此券可以享受以下優(yōu)惠:\n享門市價優(yōu)惠\n不與其他優(yōu)惠同享。詳詢商家。\",\"type\":\"text\"},"
                + "{\"key\":\"shops\",\"label\":\"可用門店\",\"value\":\"\",\"type\":\"text\"},"
                + "{\"key\":\"disclaimer\",\"label\":\"負責聲明\",\"value\":\"除特殊注明外,本優(yōu)惠不能與其他優(yōu)惠同時享受;本優(yōu)惠最終解釋權(quán)歸商家所有,如有疑問請與商家聯(lián)系。提示:為了使您得到更好的服務,請在進店時出示本券。\",\"type\":\"text\"}"
                + "]},"
                + "\"remindInfo\":{\"offset\":\"2\"}},"
                + "\"merchant\":{\"mname\":\"hodewu\",\"mtel\":\"\",\"minfo\":\"\"},"
                + "\"platform\":{\"channelID\":\"$channelID$\",\"webServiceUrl\":\"\"},"
                + "\"style\":{\"backgroundColor\":\"RGB(255,126,0)\"},"
                + "\"fileInfo\":"
                + "{\"formatVersion\":\"2\",\"canShare\":true,\"canBuy\":false,\"canPresent\":true,\"serialNumber\":\"$serialNumber$\",\"supportTaxi\":\"true\",\"taxiSchemaUrl\":\"alipays://platformapi/startapp?appId=20000130&sourceId=20000030&showTitleBar=YES&showToolBar=NO&showLoading=NO&safePayEnabled=YES&readTitle=YES&backBehavior=back&url=/www/index.html\"},"
                + "\"appInfo\":"
                + "{\"app\":{},\"label\":\"\",\"message\":\"\"},"
                + "\"source\":\"alipassprod\","
                + "\"alipayVerify\":[]"
                + "}}}"

說明:

  1. 模板中的自定義參數(shù)以雙 $ 符號標志,即 $serialNumber$ 表示自定義參數(shù)名為serialNumber,供發(fā)放卡券時使用
  2. unique_id參數(shù)支付寶有唯一性校驗,請保證每次請求該值唯一;

發(fā)放卡券

  • 接口列表:發(fā)放卡券接口(alipay.pass.instance.add)
  • SDK調(diào)用示例:

/**
 * 發(fā)放卡券
 * appAuthToken如ISV代替商家調(diào)用接口,需將商戶授權(quán)后獲取的app_auth_token帶上;如商家自己調(diào)用,則傳null。
 * bizContent 因該接口業(yè)務參數(shù)復雜,請詳見接口文檔 
 */
 AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
 AlipayPassInstanceAddRequest request = new AlipayPassInstanceAddRequest();
 request.putOtherTextParam("app_auth_token", appAuthToken);
 request.setBizContent(bizContent);
 AlipayPassInstanceAddResponse response = alipayClient.execute(request);




 System.out.print(response.getBody());//根據(jù)業(yè)務處理response

  • app_auth_token在ISV代替商家調(diào)用接口時使用,商家自己調(diào)用,可傳null
  • bizContent Json串示例:
    "{\"recognition_type\":\"1\","
                + "\"tpl_id\":\"2016072715135409252622447\","
                + "\"recognition_info\":{\"partner_id\":\"2088**********10\","
                + "\"out_trade_no\":\"xiaomoxiaomotest7629500\"}," 
                + "\"tpl_params\":"
                + "{"
                + "\"validStartDate\":\"2016-06-30 20:00:00\","
                + "\"validEndDate\":\"2016-12-30 20:00:00\","
                + "\"channelID\":\"2088**********10\","
                + "\"discountInfo\":\"憑此券即可打8.5折\","
                + "\"code\":\"20160725762587i\","
                +"\"useStateDesc\":\"可使用\","
                +"\"logoText\":\"四季風情85折優(yōu)惠券\","
                + "\"serialNumber\":\"xm433367366244615532\"}}";

說明:

  1. tpl_params中的json節(jié)點即為模板創(chuàng)建時設置的自定義參數(shù)(即模板中定義的 $xxxx$ ),每次發(fā)券可以自己定義內(nèi)容,且其中的serialNumber支付寶有唯一性校驗,每次請求請保證唯一性,不要重復
  2. tpl_id:調(diào)用模板創(chuàng)建接口成功后返回模板ID,該ID用于發(fā)放券票
  3. recognition_info:真實存在的支付寶交易,需要提供該交易的外部訂單號和對應的商戶PID
  4. channelID:可設置為APPID(從創(chuàng)建應用處獲?。┗蛘逷ID

核銷卡券

  • 接口列表:更新卡券接口(alipay.pass.instance.update)
  • SDK調(diào)用示例

/**
 * 
 * appAuthToken如ISV代替商家調(diào)用接口,需將商戶授權(quán)后獲取的app_auth_token帶上;如商家自己調(diào)用,則傳null。
 * bizContent 因該接口業(yè)務參數(shù)復雜,請詳見接口文檔
 */
 AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
 AlipayPassInstanceUpdateRequest request = new AlipayPassInstanceUpdateRequest();
 request.putOtherTextParam("app_auth_token", appAuthToken);
 request.setBizContent(bizContent);
 AlipayPassInstanceUpdateResponse response = alipayClient.execute(request);




 System.out.print(response.getBody());//根據(jù)業(yè)務處理response

  • app_auth_token在ISV代替商家調(diào)用接口時使用,商家自己調(diào)用,可傳null。
  • bizContent Json串示例:

"{\"status\":\"USED\","
                + "\"channel_id\":\"2088**********10\"," 
                + "\"serial_number\":\"xm433367366244615532\","
                + "\"tpl_params\":"
                + "{\"useStateDesc\":\"已使用\"}"
                + "}"

說明:

  1. channl_id取發(fā)放卡券時候設置的值
  2. serial_number取發(fā)放成功的卡券的值

卡券模板更新

接口列表:更新模板接口(alipay.pass.template.update)

  • SDK調(diào)用示例:

/**
 * 更新模板
 * appAuthToken如ISV代替商家調(diào)用接口,需將商戶授權(quán)后獲取的app_auth_token帶上;如商家自己調(diào)用,則傳null。
 * bizContent 因該接口業(yè)務參數(shù)復雜,請詳見接口文檔 
 */
 AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
 AlipayPassTemplateUpdateRequest request = new AlipayPassTemplateUpdateRequest();
 request.putOtherTextParam("app_auth_token", appAuthToken);
 request.setBizContent(bizContent);
 AlipayPassTemplateUpdateResponse response = alipayClient.execute(request);
 System.out.print(response.getBody());//根據(jù)業(yè)務處理response

  • app_auth_token在ISV代替商家調(diào)用接口時使用,商家自己調(diào)用,可傳null。
  • bizContent Json串示例:
    "{\"tpl_id\":\"2016071516121584501489290\"," //支付寶對該參數(shù)的請求有唯一性校驗,請保證每次請求該參數(shù)唯一
                + "\"tpl_content\":"
                + "{\"logo\":\"https://alipass.alipay.com//temps/free/logo.png\","
                + "\"strip\":\"https://alipass.alipay.com//temps/free/strip.png\","
                + "\"icon\":\"http://alipassprod.test.alipay.net/temps/free/icon.png\","
                + "\"content\":"
                + "{\"evoucherInfo\":"
                + "{\"title\":\"蕭蕭沫沫優(yōu)惠券\",\"type\":\"coupon\",\"product\":\"free\",\"startDate\":\"$validStartDate$\",\"endDate\":\"$validEndDate$\",\"operation\":"
                + "[{\"format\":\"barcode\",\"message\":\"45612346579465\",\"messageEncoding\":\"UTF-8\",\"altText\":\"45612346579465\"}],"
                + "\"einfo\":{"
                + "\"logoText\":\"$logoText$\","
                + "\"headFields\":"
                + "[{\"key\":\"status\",\"label\":\"狀態(tài)\",\"value\":\"$useStateDesc$\",\"type\":\"text\"}],"
                + "\"primaryFields\":"
                + "[{\"key\":\"strip\",\"label\":\"\",\"value\":\"$discountInfo$\",\"type\":\"text\"}],"
                + "\"secondaryFields\":"
                + "[{\"key\":\"validDate\",\"label\":\"有效期至:\",\"value\":\"$validEndDate$\",\"type\":\"text\"}],"
                + "\"auxiliaryFields\":[],"
                + "\"backFields\":"
                + "[{\"key\":\"description\",\"label\":\"詳情描述\",\"value\":\"1.該優(yōu)惠有效期:截止至2014年06月18日;\n2.憑此券可以享受以下優(yōu)惠:\n享門市價優(yōu)惠\n不與其他優(yōu)惠同享。詳詢商家。\",\"type\":\"text\"},"
                + "{\"key\":\"shops\",\"label\":\"可用門店\",\"value\":\"\",\"type\":\"text\"},"
                + "{\"key\":\"disclaimer\",\"label\":\"負責聲明\",\"value\":\"除特殊注明外,本優(yōu)惠不能與其他優(yōu)惠同時享受;本優(yōu)惠最終解釋權(quán)歸商家所有,如有疑問請與商家聯(lián)系。提示:為了使您得到更好的服務,請在進店時出示本券。\",\"type\":\"text\"}"
                + "]},"
                + "\"remindInfo\":"
                + "{\"offset\":\"2\"}},"
                + "\"merchant\":{\"mname\":\"hodewu\",\"mtel\":\"\",\"minfo\":\"\"},"
                + "\"platform\":{\"channelID\":\"$channelID$\",\"webServiceUrl\":\"\"},"
                + "\"style\":{\"backgroundColor\":\"RGB(255,126,0)\"},"
                + "\"fileInfo\":{\"formatVersion\":\"2\",\"canShare\":true,\"canBuy\":false,\"canPresent\":true,\"serialNumber\":\"$serialNumber$\",\"supportTaxi\":\"true\",\"taxiSchemaUrl\":\"alipays://platformapi/startapp?appId=20000130&sourceId=20000030&showTitleBar=YES&showToolBar=NO&showLoading=NO&safePayEnabled=YES&readTitle=YES&backBehavior=back&url=/www/index.html\"},"
                + "\"appInfo\":{\"app\":{},\"label\":\"\",\"message\":\"\"},"
                + "\"source\":\"alipassprod\","
                + "\"alipayVerify\":[]"
                + "}}}"

    說明:

  1. tpl_id即為需要修改的模板id,從創(chuàng)建模板接口中調(diào)用成功之后獲?。?/li>
  2. tpl_content即為創(chuàng)建模板是的json內(nèi)容,并修改其中需要更新的節(jié)點和內(nèi)容;

小程序跳轉(zhuǎn)到卡包列表或詳情頁

當用戶領取卡券后,可在小程序中展示券、票,可引導用戶點擊跳轉(zhuǎn)到支付寶卡包頁面

3.API列表

支付寶卡包API列表

接口名稱 接口描述
alipay.pass.template.add 新建卡券模板
alipay.pass.template.update 更新卡券模板
alipay.pass.instance.add 發(fā)布卡券
alipay.pass.instance.update 更新卡券

小程序跳轉(zhuǎn)到支付寶卡包API列表

接口名稱 接口描述
my.openVoucherList 打開支付寶卡包中的“券”列表
my.openMerchantVoucherList 打開當前用戶領取某個商戶的“券”列表
my.openVoucherDetail 打開當前用戶領取某張券的詳情頁(非口碑券)
my.openKBVoucherDetail 打開當前用戶領取某張券的詳情頁(口碑券)
my.openTicketList 打開支付寶卡包中的“票”列表
my.openMerchantTicketList 打開當前用戶領取某個商戶的“票”列表
my.openTicketDetail 打開當前用戶領取某張票的詳情頁
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號