开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
了解支付宝开放能力最新动态
和同城同行业凯发k8官方网娱乐官方的合作伙伴交流业务
与开放平台产研团队沟通
文档中心
网页&移动应用 
产品地图
支付产品
私域产品
公域产品
营销产品
资金产品
会员产品
信用产品
安全产品
广告产品
其他通用产品
小程序交易投诉处理
收单资金结算到银行账户的到账消息
蚂蚁门店管理
ccm 插件化能力
学校库
分享到支付宝
商家账单数据查询及下载接口
商户自主监控
网站支付宝登录
支付宝卡包
产品介绍
接入准备
接入指南
api 列表
相关资料
常见问题
更新日志
电子发票
生活缴费
中小学教育缴费
地铁线上购票
车主平台停车在线缴费
口碑开店
私域营销
支付宝加油
商家费率申请
开发 > 服务端 > 其他通用产品 > 支付宝卡包 >  > 参数详细说明
收藏
订阅更新
我的文档
设置
商家使用支付宝账号登录 ，在线编辑获取 json 模板，设计完成后下载卡券模板文件并解压，打开 pass.json 文件，其值即为 alipay.pass.template.add（创建卡券模板接口）的参数 tpl_content 中 content 的值。
1 示例代码
​
json
复制代码
{
"evoucherinfo": {
"title": "上优酷，看世界杯优酷vip会员3天",
"type": "marketvoucher",
"product": "free",
"startdate": "$activetime$",
"enddate": "$expiretime$",
"operation": [
{
"format": "url",
"message": "$url$",
"alttext": "立即激活"
}
],
"einfo": {
"logotext": "3天",
"secondlogotext": "64场高清直播，进球就下红包雨",
"auxiliaryfields": [],
"customfields": [
{
"label": "详细说明",
"value": "",
"type": "url",
"more": {
"url": "http://xxxxxxxxxxxx"
}
}
],
"uselimitdesc": "优酷vip会员",
"brandname": "上优酷，看世界杯",
"originprice": "",
"banner": {
"bannerimg": "",
"url": ""
},
"passimg": "https://tfsimg.alipay.com/images/alipassprod/tb17floxb8rdunk6xejwu2eyxxa",
为了保证卡券展示的灵活扩展，卡券展示使用 json 格式的字符串来存储。其中一些是固定节点，控制在支付宝客户端中的展示位置；一部分是用户自定义的展示文案，文案可以是在模板设计时就设计好的固定文案，也可以是变量，使用 $var$ 来表示，等券实例化时再传入具体的 var 代表的值来替换，其中 var 为变量名，可以是任何有意义的名称，最好全部由英文字母组成。
2 pass.json 对象结构视图
1.png

2.1 属性分类描述
参数
参数名称
类型
必填
描述
范例
evoucherinfo
基础属性
string
是
pass 的基础信息，如 pass 标题、pass 类型等。
可查看 基础属性（evoucherinfo）
style
样式属性
string
否
pass 在 app 展现时的样式信息。
可查看 样式属性（style）
fileinfo
文件属性
string
是
alipass 文件的相关信息。
可查看 文件属性（fileinfo）
merchant
商户属性
string
是
pass 对应的第三方信息。
可查看 商户属性（merchant）
platform
渠道属性
string
是
pass 发布渠道或者平台信息。
可查看 渠道属性（platform）
appinfo
应用属性
string
否
第三方手机客户端应用信息。
可查看 应用属性（appinfo）
2.2 基础属性（evoucherinfo）
结构视图
2.png

属性描述
参数
参数名称
类型
必填
描述
范例
goodsid
商品 id
string(64)
否
pass 对应商品的 id。
--
title
pass 名称
string(256)
是
pass 的名称，如优惠券的名称。
**优惠券
type
卡券大类型(展示模板)
string(16)
是
支付宝当前支持 pass 的类型（不同类型会有不同的详情展示模板）。
coupon
product
卡券子类型(产品业务)
string(16)
是
支付宝当前支持 pass 的子类型，与 type 字段结合确定 pass 的准确类型。
free
startdate
开始时间
string(16)
是
pass 生效时间(起飞时间)，yyyy-mm-dd hh:mm:ss格式字符串。可设置成动态参数：$activetime$。
2016-6-30 15:44:11
enddate
结束时间
string(19)
是
pass 失效时间（落地时间）（可与 startdate 相同），需要精确到秒，可设置成动态参数：$expiretime$。
2013-05-01 23:59:59
einfo
pass特性
einfo(4000)
是
不同类型 pass 对应的特定属性。
["wave","text"]
operation
操作信息
operation(1000)
是
支持文本、二维码、声波等核销内容展示，也可作为启动应用操作。
 --
remindinfo
提醒信息
remindinfo
100
用于在 pass 生效或截止前提示用户，可设置时间提前量、提醒的内容。
 --
2.2.1 卡券类型（type 和 product）
支付宝卡券支持如下 2 种 type 类型，不同模板类型有不同的展示模板排版结构。
说明：支持版本信息可通过 fileinfo（文件属性）的 formatversion（pass 文件版本）确定。
序号
模板类型名称
模板描述
支持版本
1
coupon
旧版优惠券
1、2、3
2
eventticket
新版优惠券
4
支付宝卡券支持如下 14 种产品业务类型。接口调用方可以根据自身的业务场景，选择合适的产品类型。product 分类如下：
序号
产品业务类型
描述
1
free
优惠券
2
price
兑换券
3
groupon
团购券
4
discount
专享折扣
5
market
商家营销券
6
ticket
入场券
7
lottery
彩票
8
movie
电影票
9
tourist
旅游景点门票等
10
hotel
酒店
11
boarding
登机牌
12
air
机票
13
train
火车票
14
bus
汽车票
2.2.2 卡券有效时间设置（startdate 和 enddate）
●若将 evoucherinfo 中 startdate 字段值，配置成动态参数  $activetime$ ，则开发者在生成卡券预览页时 templateparams 必须传入此参数值用于预览页渲染，否则会报错 预览页渲染失败/系统错误。
●若将 evoucherinfo 中 enddate 字段值，配置成动态参数 $expiretime$ ，则开发者在生成卡券预览页时 templateparams 必须传入此参数值用于预览页渲染，否则会报错 预览页渲染失败/系统错误。
2.2.3 卡券属性设置（einfo）
einfo 数据是 alipass 的主体信息，主要用于展示给用户。如：电影票、登机牌、优惠券等均有自有行业特定的信息。第三方可根据实际需要按照约定的 json 数据格式将内容进行组装。这些数据最终会按照组装顺序显示在alipass的详情中（正面和背面均支持）。目前主要包含：headfields、primaryfields、secondaryfields、auxiliaryfields、backfields 几大块区域。
einfo结构区域描述（einfo）
序号
key
字段名
描述
必填
1
logo
passlogo
从 alipass 文件包中获取：即 logo.png
是
2
logotext
logo旁白
logo旁白区域
否
3
secondlogotext
辅助logo旁白
第二行logo旁白区域（可选）
是
4
thumbnail
缩略图
从 alipass 文件包中获取：即 strip.png。
是
5
headfields
内容
头部右端区域块【einfounit列表】
是
6
primaryfields
第一区域块
第一区域块需要展示的内容【einfounit列表】
是
7
secondaryfields
第二区域块
第二区域块需要展示的内容【einfounit列表】
是
8
auxiliaryfields
辅助区域块
辅助域块需要展示的内容【einfounit列表】
是
9
backfields
背面区域块
背面区域块需要展示的内容【einfounit列表】
是
说明：headfields、primaryfields、secondaryfields、auxiliaryfields、backfields 区域，至少有一个区域有值。
2.2.4 区块规则（einfounit）
序号
内容
类型
说明
必填
1
key
string
字段关键字。
否
2
label
string
显示名称。
是
3
value
string
显示具体值。
是
4
type
string
字段类型，可选类型为：
电话【tel】、网站链接地址【url】、地图【map】、文本【text】(默认)等。
根据不同的类型，将在该字段前添加相应的 icon，并会根据实际情况相应支持电话拨出、启动浏览器跳转链接地址、启动手机应用客户端、地图等功能。
是
说明：如果 key 的值不为空，则 label 和 value 必须有一个值非空。
einfo 业务必要属性声明
说明：因部分业务需要，除基础属性外在 einfo 同样有部分特有的关键属性信息（key值固定，显示名称不做限制）不得为空，并且需要保证在 einfo 中关键业务的 key 值没有重复，但并不限制排版位置。如下表所示：
序号
product业务类型
必要属性名称（名称可自定义）
key（固定）
1
train(火车票)
出发地
from
目的地
to
列车号
trainno
2
boarding（登机牌）
出发地
from
目的地
to
航班号
fltno
3
air(机票)
出发地
from
目的地
to
航班号
fltno
4
bus(汽车票)
出发地
from
目的地
to
车次号
busno
2.2.5 核销区域设置（operation）
核销操作区目前支持：wave（声波方式）、qrcode（二维码方式）、barcode（条码方式）、text（文本方式）、应用启动（app）、网页链接（url）、图片（img）。
核销方式
模板中核销区（operation）示例
备注
声波方式
"operation": [{
"message": "$ackcode$",
"messageencoding": "utf-8",
"format": "wave",
"alttext": "$ackcode$"
}]
如果是声波类型，message 字符长度规则如下：
●16位及以下字符串任意字符传输。(兼容上期版本)。 eg：!@#$%^&*()|{}12a。
●长度在16位以上字符串，最长长度不超过 32 位。整个字符串组合为数字或 a - f 的字母(字母不区分大小写，输出结果统一为大写)，首字符不能为 0。 eg：123456789abcdef0123456789abcdefa。
●不符合规则客户端本地过滤不显示声波核销按钮。
条形码方式
"operation": [{
"message": "$ackcode$",
"messageencoding": "utf-8",
"format": "barcode",
"alttext": "$ackcode$"
}]
 无
二维码方式
"operation": [{
"message": "$ackcode$",
"messageencoding": "utf-8",
"format": "qrcode",
"alttext": "$ackcode$"
}]
 无
文本方式
"operation": [{
"alttext": "兑换码",
"message": [{
"label": "序列号",
   "value": "$ackcode$"
},{
"label": "验证码",
"value": "4958"
}],
"messageencoding": "utf-8",
"format": "text"
}]
如果 format 为文本方式，message 需要为 json 数组。
应用方式
"operation": [{
"message": {
"android_appid": "androidid",
"android_launch": "android启动地址",
"android_download": "android下载地址",
"ios_appid": "iosid",
"ios_launch": "ios启动地址",
"ios_download": "ios下载地址"
},
"format": "app",
"messageencoding": "utf-8",
"alttext": "按钮文字"
}
跳转启动外部应用
图片
"operation": [{
"message": {
"img": "*****.png",
     "target": ""
},
"format": "img",
"messageencoding": "utf-8",
"alttext": "核销图片"
}]
 无
链接
"operation": [{
"format": "url",
"message": "https://****",
"messageencoding": "utf-8",
"alttext": "请使用"
}]
 无
2.2.6 提醒信息设置（remindinfo）
结构视图
3.png

请在卡券平台设置提醒信息
4.png

注意：仅支持设置到期前提醒时间，不支持自定义提醒内容。支付宝将根据如下规则自动生成提醒文案。提醒文案示例如下，提醒文案中的的变量会从 pass 的 基础属性 和 einfo 中捞取，并会根据实际展示需要进行格式化：
●机票：您从#from#到#to#的航班将于今（明天）天#startdate#起飞，请提前做好安排。
●酒店：您将于#startdate#入住#title#店，请提前做好安排。
●门票：您预订了#startdate#的#title#门票，请提前做好安排。
属性描述
序号
key
字段名
字段类型
描述
必填
1
offset
提前时间
string
提醒默认的提前秒数，（3600-24×3600秒之间）。
是
2.3 商户属性（merchant）
商户属性是指归属于第三方的最终商户，比如天猫商城是一个第三方，其中深航机票是一个最终商户。
2.3.1 结构视图
5.png

2.3.2 属性描述
序号
key
类型
描述
必填
1
mname
string
商户全称。商户完整名称。
否
2
mshortname
string
商户简称。商户的简称。
是
3
maddr
string
商户地址。商户的通讯地址。
是
4
mtel
string
商户电话。商户的服务电话。
是
5
minfo
string
商户简介。商户的介绍。
是
2.4 渠道属性（platform）
2.4.1 结构视图
6.png

2.4.2 属性描述
序号
key
类型
长度
描述
必填
1
channelid
string
32
渠道商 id。第三方在支付宝的 partnerid
若已入驻支付宝开放平台则使用对应的 appid。
否
2
channelscene
string
32
渠道场景。可以设置为 public、server，如果设置 public 则当发券时不给用户发 push 消息，设置 server 会发 push。
是
3
webserviceurl
string
128
渠道商服务地址。第三方服务 url，用于将支付宝相关的信息同步给第三方。
否
2.5 样式属性（style）
2.5.1 结构视图
7.png

2.5.2 属性描述
序号
key
描述
必填
1
backgroundcolor
背景颜色。整体卡券背景颜色。
否
2.6 文件属性（fileinfo）
2.6.1 结构视图
8.png

2.6.2 属性描述
序号
key
字段类型
字段长度
描述
必填
1
formatversion
string
10
pass文件版本。alipass的版本，现为 4。
否
2
canpresent
boolean
10
否支持转赠。当设置为可转赠则可以在支付宝客户端中点击转赠按钮，将拥有的券转赠给其他用户。
是
3
canshare
boolean
10
是否支持共享。当前 alipass 是否指定到单一用户，如果支持共享则可以有多个用户拥有同一张 pass 文件。
是
4
serialnumber
string
32
pass 文件序列号。同一第三方提供的序列号需要唯一。
同一用户重复添加的 pass，对应的 serialnumber 要求一致（多份购买行为例外）。
否
2.7 应用属性（appinfo）
2.7.1 结构视图
9.png

2.7.2 属性描述
序号
key
类型
描述
必填
1
label
string
名称。在 alipass 中显示的 app 应用名称。
是
2
message
string
应用的简短描述，可能会展示在alipass的应用信息区。
是
3
app
string
应用具体信息，包含：
●应用id或包名：*_appid
●应用启动地址：_launch
●应用下载地址：*_download。
其中 * 代表 android 和 ios。
是
​
 上一篇：上传门店照片和视频接口下一篇：常见问题 
相关问题
支付宝卡包使用云排查说明
如何修改支付宝卡包
内容没有解决您的问题？您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 2022 支付宝（杭州）信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助？
当前页面目录
网站地图