W3Cschool
恭喜您成為首批注冊用戶
獲得88經(jīng)驗值獎勵
支付寶卡包產(chǎn)品介紹
[TOC]
什么是支付寶卡包(alipass
)?
支付寶卡包(alipass
),是支付寶公司推出的一款可以管理電子憑證的產(chǎn)品,該產(chǎn)品聚合來自各類生活服務的票據(jù)憑證,包括優(yōu)惠券、折扣券、代金券、換購券、電影票、演出票、火車票、機票。
產(chǎn)品生命周期:
企業(yè)或者個人開發(fā)者可以通過支付寶提供的開放接口,把卡券添加到支付寶卡包,用戶可以通過小程序查看卡券,同時支持跳轉(zhuǎn)到支付寶卡包頁面,在卡包中查看并使用商戶同步進來的卡券。
電子門票使用流程
免費接口,暫未收取費用。
在小程序“開發(fā)管理”詳情頁的“功能列表”中添加“支付寶卡包”
卡包術(shù)語介紹
以下是支付寶卡包接口開發(fā)過程中需要了解的常用概念:
名稱 | 描述 |
---|---|
模板/卡券模板(template) | 模板包含了開發(fā)者設計的卡券的樣式、內(nèi)容信息?;诖四0宓臉邮?,開發(fā)者可以向用戶發(fā)放卡券,一個模板可以對應多個卡券,模板內(nèi)容樣式的變化會引起卡券的變化。 |
模板編號(templateId) | 模板的唯一標識,由創(chuàng)建模板成功后,接口返回給商戶,基于此參數(shù)創(chuàng)建卡券。 |
卡券ID(passId) | 卡券ID,唯一代表一張卡券。可以多個卡券ID對應一個模板。由卡券創(chuàng)建成功后返回。 |
使用說明
商家通過開放平臺提供的alipass接口,可完成從卡券模板設計到卡券實體構(gòu)造整個流程。
1.創(chuàng)建卡券模版:
2.創(chuàng)建卡券:
接口調(diào)用流程
支付寶卡券整體接口調(diào)用流程:
創(chuàng)建卡券模板
/**
* 新建模板
* 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
"{\"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\":[]"
+ "}}}"
說明:
$
符號標志,即 $serialNumber$
表示自定義參數(shù)名為serialNumber
,供發(fā)放卡券時使用unique_id
參數(shù)支付寶有唯一性校驗,請保證每次請求該值唯一;發(fā)放卡券
/**
* 發(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
。"{\"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\"}}";
說明:
核銷卡券
/**
*
* 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。"{\"status\":\"USED\","
+ "\"channel_id\":\"2088**********10\","
+ "\"serial_number\":\"xm433367366244615532\","
+ "\"tpl_params\":"
+ "{\"useStateDesc\":\"已使用\"}"
+ "}"
說明:
channl_id
取發(fā)放卡券時候設置的值serial_number
取發(fā)放成功的卡券的值卡券模板更新
接口列表:更新模板接口(alipay.pass.template.update)
/**
* 更新模板
* 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。"{\"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\":[]"
+ "}}}"
說明:
tpl_id
即為需要修改的模板id,從創(chuàng)建模板接口中調(diào)用成功之后獲?。?/li>
tpl_content
即為創(chuàng)建模板是的json內(nèi)容,并修改其中需要更新的節(jié)點和內(nèi)容;
小程序跳轉(zhuǎn)到卡包列表或詳情頁
當用戶領取卡券后,可在小程序中展示券、票,可引導用戶點擊跳轉(zhuǎn)到支付寶卡包頁面
支付寶卡包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 | 打開當前用戶領取某張票的詳情頁 |
Copyright©2021 w3cschool編程獅|閩ICP備15016281號-3|閩公網(wǎng)安備35020302033924號
違法和不良信息舉報電話:173-0602-2364|舉報郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號
聯(lián)系方式:
更多建議: