支付寶小程序：參數詳細說明

參數

類型

必填

描述

范例

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）

參數

類型

必填

描述

goodsId

String(64)

否

商品 ID。pass 對應商品的 id。

title

String(256)

是

pass 名稱。pass的名稱，如優惠券的名稱。

示例值：**優惠券

type

String(16)

是

卡券大類型（展示模板）。支付寶當前支持pass的類型（不同類型會有不同的詳情展示模板）。

示例值：coupon

product

String(16)

是

卡券子類型（產品業務）。支付寶當前支持 pass 的子類型，與 type 字段結合確定 pass 的準確類型。

示例值：free

startDate

String(16)

是

開始時間。pass 生效時間(起飛時間)，YYYY-MM-dd HH:mm:ss 格式字符串?？稍O置成動態參數：$activeTime$。

示例值：2016-6-30 15:44:11

endDate

String(19)

是

結束時間。pass 失效時間（落地時間）（可與startDate相同），需要精確到秒，可設置成動態參數：$expireTime$。

示例值：2013-05-01 23:59:59

einfo

EInfo(4000)

是

pass 特性。不同類型 pass 對應的特定屬性。

示例值：["wave","text"]

operation

Operation(1000)

是

操作信息。支持文本、二維碼、聲波等核銷內容展示，也可作為啟動應用操作。

remindInfo

RemindInfo

100

提醒信息。用于在 pass 生效或截止前提示用戶，可設置時間提前量、提醒的內容。

模板類型名稱

模板描述

coupon

優惠券類默認展示模板。

eventTicket

事件票務類默認展示模板。

boardingPass

登車、船、飛機票務等默認展示模板。

產品業務類型

描述

free

免費券

price

兌換券

groupon

團購券

lottery

彩票

movie

電影票

tourist

旅游景點門票等

hotel

酒店

boarding

登機牌

air

機票

train

火車票

bus

汽車票

參數

必填

描述

logo

是

PassLogo。從 alipass 文件包中獲?。杭?logo.png。

logoText

否

Logo旁白。logo 旁白區域。

secendLogoText

是

輔助 Logo 旁白。第二行 logo 旁白區域（可選）。

Thumbnail

是

縮略圖。從 alipass 文件包中獲?。杭?strip.png。

headFields

是

內容。頭部右端區域塊【EinfoUnit列表】。

primaryFields

是

第一區域塊。第一區域塊需要展示的內容【EinfoUnit列表】。

secondaryFields

是

第二區域塊。第二區域塊需要展示的內容【EinfoUnit列表】。

auxiliaryFields

是

輔助區域塊。輔助域塊需要展示的內容【EinfoUnit列表】。

backFields

是

背面區域塊。背面區域塊需要展示的內容【EinfoUnit列表】。

參數

類型

必填

說明

key

String

是

字段關鍵字

label

String

否

顯示名稱

value

String

否

顯示具體值

type

String

否

字段類型?？蛇x類型：

• 電話【tel】

• 網站連接地址【url】

• 地圖【map】

• 文本【text】(默認)

根據不同的類型，將在該字段前添加相應的icon，并會根據實際情況相應支持電話撥出、啟動瀏覽器跳轉連接地址、啟動手機應用客戶端、地圖等功能。

Product業務類型

必要屬性名稱（名稱可自定義）

參數（固定）

train(火車票)

出發地

from

目的地

to

列車號

trainNo

boarding（登機牌）

出發地

from

目的地

to

航班號

fltNo

air(機票)

出發地

from

目的地

to

航班號

fltNo

bus(汽車票)

出發地

from

目的地

to

車次號

busNo

核銷方式

模板中核銷區（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": "請使用"

}]

?無

參數

類型

必填

描述

offset

String

否

提前時間。提醒默認的提前秒數，（3600-24×3600秒之間）

參數

類型

必填

描述

mname

String

是

商戶全稱。商戶完整名稱。

mshortName

String

否

商戶簡稱。商戶的簡稱。

maddr

String

否

商戶地址。商戶的通訊地址。

mtel

String

否

商戶電話。商戶的服務電話。

minfo

String

否

商戶簡介。商戶的介紹。

參數

類型

必填

長度

描述

channelID

String

是

32

渠道商 ID。第三方在支付寶的 partnerId。

若已入駐支付寶開放平臺則使用對應的 appId。

channelScene

String

否

32

渠道場景?？梢栽O置為 public、server，如果設置 pubic 則當發券時不給用戶發 PUSH 消息，設置 server 會發 PUSH。

webServiceUrl

String

是

128

去的商服務地址。第三方服務 url，用于將支付寶相關的信息同步給第三方。

參數

必填

描述

backgroundColor

是

背景顏色。整體卡券背景顏色。

參數

類型

字段長度

描述

formatVersion

String

10

Pass文件版本。Alipass 的版本，現為 4。

canPresent

Boolean

10

是否支持轉贈。當設置為可轉贈則可以在錢包中點擊轉贈按鈕，將擁有的券轉贈給其他用戶。

canShare

Boolean

10

是否支持共享。當前 Alipass 是否指定到單一用戶，如果支持共享則可以有多個用戶擁有同一張 pass 文件。

serialNumber

String

32

Pass 文件序列號，同一第三方提供的序列號需要唯一；

同一用戶重復添加的 pass，對應的 serialNumber 要求一致（多份購買行為例外）。

參數

類型

必填

描述

label

String

否

名稱。在 alipass 中顯示的 app 應用名稱。

message

String

否

應用描述。應用的簡短描述，可能會展示在alipass的應用信息區。

app

String

否

應用具體信息。包含：

• 應用 ID 或包名。

• 應用啟動地址。

• 應下載地址：需要區分 IOS 與 android。

應用ID：*_appid、應用啟動地址：_launch、應下載地址：*_download，其中*代表 android 和 ios