5. Create a Ticket

Name

Type

Required

Description

Sample

client-id

String

M

Client ID

2110200000000044

signature

String

M

Message signature information

algorithm=sha256withrsa,keyVersion=2,signature=xxxxxxxxxxxyyyyyyyyyyyyyyzzzzzzzzz==

encrypt

String

O

Message encryption information

algorithm=rsa, keyVersion=2

Content-type

String

M

Http content type

application/json; charset=UTF-8

Name

Type

Length

Required

Description

Sample

merchantId

String

64

M

Merchant Id

2160120041113167

userId

String

32

O

AlipayHK userId

2160120037098191

openId

String

32

O

AlipayHK openId

fj398457jd8iue98d8w7w93j

templateCode

String

32

M

Template Id

2020091119027102160530200000039

bizSerialId

String

128

M

Business serial number

bizSerialType

String

32

M

Business serial number type

Fixed value

OUT_PLAT_FORM

OUT_PLAT_FORM

startDate

Date

/

M

Ticket start date time

in millisecond timestamp format

1640970061000

endDate

Date

/

M

Ticket end date time

in millisecond timestamp format

For Traffic tickets, this time is prefered to be the latest refundable or changeable time+1h.

1640970061000

bizCreate

Date

/

M

The time when the card was created,

in millisecond timestamp format

order creation time

1640970061000

type

String

32

M

Template type

TICKET

TICKET

product

String

32

M

Product Type

PASS

MOVIE

AIR_TICKET

TRAIN_TICKET

BUS_TICKET

SHIP_TICKET

PASS

codeInfo

string

512

M

Card code value information, in JSON format

{
"$codemsg$": "9123912839123712893",

// code message, will be displayed
"$codevalue$": "9123912839123712893"

//code value
}

Pass random content when template codetype was set to none.

dataInfo

String

/

M

Ticket details

Please refer to below table.

extInfo

String

O

JSON String

For ticket scenarios:

"billId":"2020091119027102160530200000039" ,

// Alipay transaction no.

"merchantBillId":"1234567890",

//merchant transaction no. max.128

"merchantBillDetail":"alipayhk://"

//mini-app order detailed page max.256

Name

Type

Length

Required

Description

Sample

$ticketName_zh_HK$

String

12

O

Ticket name (CN)

雙人入場套票

$ticketName_en_US$

String

24

O

Ticket name (EN)

Ticket package for 2 persons

$address_zh_HK$

String

24

M

Event address (CN)

香港迪士尼樂園度假區迎樂路

$address_en_US$

String

48

M

Event address (EN)

Hong Kong Disneyland Resort

$availableTimes_zh_HK$

Integer

/

M

Available usage times (CN)

1

$availableTimes_en_US

String

/

M

Available usage times (EN)

One

should be aligned with Available usage times (CN)

$price_zh_HK$

JSON

/

O

Ticket Price

Unit：cent

{

"cent": 996,

"currency": "HKD"

}

$price_en_US$

JSON

/

O

Ticket Price

Unit：cent

{

"cent": 996,

"currency": "HKD"

}

$startTime_zh_HK$

Date

/

M

Campaign start time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$startTime_en_US$

Date

/

M

Campaign start time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_zh_HK$

Date

/

M

Campaign end time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970022387

$endTime_en_US$

Date

/

M

Campaign end time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970022387

$platformName_zh_HK$

String

32

O

Platform/agent name (CN)

KLOOK

$platformName_en_US$

String

64

O

Platform/agent name (EN)

KLOOK

$platformLogo_zh_HK$

String

256

O

Platform/agent logo URL

$platformLogo_en_US$

String

256

O

Platform/agent logo URL

Name

Type

Length

Required

Description

Sample

$airlineName_zh_HK$

String

32

M

Airline name (CN)

國泰航空

$airlineName_en_US$

String

64

M

Airline name (EN)

Cathay pacific airways

$airlineLogo_zh_HK$

String

256

O

Airline logo URL

$airlineLogo_en_US$

String

256

O

Airline logo URL

$airlineCode_zh_HK$

String

32

O

Airline Code

A1234

$airlineCode_en_US$

String

32

O

Airline Code

A1234

$from_zh_HK$

String

24

M

Departure station name (CN)

Prefer departure city name, append airport name if applicable

香港

$from_en_US$

String

48

M

Departure station name (CN)

Prefer departure city name, append airport name if applicable

Hong Kong

$to_zh_HK$

String

24

M

Arrival station name (EN)

Prefer arrival city name, append airport name if applicable

首爾（仁川）

$to_en_US$

String

48

M

Arrival station name (EN)

Prefer arrival city name, append airport name if applicable

Seoul（Incheon）

$fromAddress_zh_HK$

String

64

M

Departure station address (CN)

香港國際機場客運大樓1（HKG）

$fromAddress_en_US$

String

128

M

Departure station address (EN)

Hong Kong International Airport Terminal 1（HKG）

$toAddress_zh_HK$

String

64

M

Arrival station address (CN)

仁川國際機場客運大樓1（ICN）

$toAddress_en_US$

String

128

M

Arrival station address (EN)

Incheon International Airport Terminal 1 （ICN）

$shiftNumber_zh_HK$

String

32

M

Flight number

CX1234

$shiftNumber_en_US$

String

32

M

Flight number

CX1234

$passengerInfoList_zh_HK$

LIST

/

M

Passenger information

idNumber，seatNum are optional fields

max 9 passengers

[{"seatNum":"A1","passengerName":"小明","idNumber":"H*******1134""ticketType":"成人票","ticketLevel":"经济舱"

}]

$passengerInfoList_en_US$

LIST

/

M

Passenger information

idNumber，seatNum are optional fields

max 9 passengers

[{"seatNum":"A1","passengerName":"XiaoMing","idNumber":"H*******1134""ticketType":"Adult","ticketLevel":"Economy class"

}]

$platformName_zh_HK$

String

32

O

Platform/agent name (CN)

同程旅行

$platformName_en_US$

String

64

O

Platform/agent name (EN)

Tongcheng-Elong

$platformLogo_zh_HK$

String

256

O

Platform/agent logo URL

$platformLogo_en_US$

String

256

O

Platform/agent logo URL

$startTime_zh_HK$

Date

/

M

Flight take-off time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$startTime_en_US$

Date

/

M

Flight take-off time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_zh_HK$

Date

/

M

Flight arrival time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_en_US$

Date

/

M

Flight arrival time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

Name

Type

Length

Required

Description

Sample

$from_zh_HK$

String

24

M

Departure station name (CN)

香港西九龍

$from_en_US$

String

48

M

Departure station name (EN)

Hong Kong West Kowloon Station

$to_zh_HK$

String

24

M

Arrival station name (CN)

廣州南

$to_en_US$

String

48

M

Arrival station name (EN)

GuangZhounan Station

$shiftNumber_zh_HK$

String

32

M

Train number

G6001

$shiftNumber_en_US$

String

32

M

Train number

G6001

$checkpoint_zh_HK$

LIST

32

M

Ticket gate

size<=4

["4A","4B"]

$checkpoint_en_US$

LIST

32

M

Ticket gate
size<=4

["4A","4B"]

$passengerInfoList_zh_HK$

LIST

/

M

Passenger information

idNumber is optional field,

max 15 passengers

[{

"passengerName":"王XX","idNumber":"H*******1134","seatNum":"09车03D号","ticketType":"成人票","ticketLevel":"商务座"

}]

$passengerInfoList_en_US$

LIST

/

M

Passenger information

idNumber is optional field,

max 15 passengers

[{

"passengerName":"WangXX","idNumber":"H*******1134","seatNum":"09车03D号","ticketType":"Adult","ticketLevel":"Business Class"

}]

$platformName_zh_HK$

String

32

O

Platform/agent name (CN)

同程旅行

$platformName_en_US$

String

64

O

Platform/agent name (EN)

Tongcheng-Elong

$platformLogo_zh_HK$

String

256

O

Platform/agent logo URL

$platformLogo_en_US$

String

256

O

Platform/agent logo URL

$startTime_zh_HK$

Date

/

M

Train departure time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$startTime_en_US$

Date

/

M

Train departure time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_zh_HK$

Date

/

M

Train arrival time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970023000

$endTime_en_US$

Date

/

M

Train arrival time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970023000

Name

Type

Length

Required

Description

Sample

$from_zh_HK$

String

24

M

Departure station name (CN)

香港上環港澳碼頭

$from_en_US$

String

48

M

Departure station name (EN)

Hong Kong - Macau Ferry Terminal

$fromAddress_zh_HK$

String

64

M

Departure station address (CN)

上環干諾道中200號信德中心三樓

$fromAddress_en_US$

String

128

M

Departure station address (EN)

3/F Shun Tak Centre, 200 Connaught Road Central, Sheung Wan

$to_zh_HK$

String

24

M

Arrival station name (CN)

澳門外港碼頭

$to_en_US$

String

48

M

Arrival station name (EN)

Macau Outer Ferry Terminal

$toAddress_zh_HK$

String

64

M

Arrival station address (CN)

澳門海港前地（入境層一樓）

$toAddress_en_US$

String

128

M

Arrival station address (EN)

Outer Harbour Ferry Terminal (B Via / Lane)

$availableTimes_zh_HK$

integer

[1,100]

O

Available usage times (CN)

1

$availableTimes_en_US$

integer

[1,100]

O

Available usage times (EN)

One

should be aligned with Available usage times (CN)

$price_zh_HK$

JSON

/

O

Ticket Price

Unit：cent

{

"cent": 996,

"currency": "HKD"

}

$price_en_US$

JSON

/

O

Ticket Price

Unit：cent

{

"cent": 996,

"currency": "HKD"

}

$ticketType_zh_HK$

String

12

O

Ticket type (CN)

成人票

$ticketType_en_US$

String

24

O

Ticket type (EN)

Adult

$ticketLevel_zh_HK$

String

12

O

Ticket class(CN)

豪華位

$ticketLevel_en_US$

String

24

O

Ticket class(EN)

Premier

$platformName_zh_HK$

String

32

O

Platform/agent name (CN)

KLOOK

$platformName_en_US$

String

64

O

Platform/agent name (EN)

KLOOK

$platformLogo_zh_HK$

String

256

O

Platform/agent logo URL

$platformLogo_en_US$

String

256

O

Platform/agent logo URL

$startTime_zh_HK$

Date

/

M

Ferry departure time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$startTime_en_US$

Date

/

M

Ferry departure time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_zh_HK$

Date

/

M

Ferry arrival time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_en_US$

Date

/

M

Ferry arrival time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

Name

Type

Length

Required

Description

Sample

$from_zh_HK$

String

24

M

Departure station name (CN)

牛頭角下邨

$from_en_US$

String

48

M

Departure station name (EN)

Lower Ngau Tau Kok Estate

$fromAddress_zh_HK$

String

64

M

Departure station address (CN)

牛頭角下邨貴華樓旁9號紅色小巴站側

$fromAddress_en_US$

String

128

M

Departure station address (EN)

Ngau Tau Kok Road; near the bus stop outside Kwai Fai House; Lower Ngau Tau Kok Estate

$to_zh_HK$

String

24

M

Arrival station name (CN)

深圳灣口岸

$to_en_US$

String

48

M

Arrival station name (EN)

Shenzhen Bay Port

$toAddress_zh_HK$

String

64

M

Arrival station address (CN)

廣東省深圳市南山區蛇口東角頭

$toAddress_en_US$

String

128

M

Arrival station address (EN)

Shenzhen Bay Port Hong Kong Port Area

$availableTimes_zh_HK$

integer

[1,100]

O

Available usage times (CN)

1

$availableTimes_en_US$

integer

[1,100]

O

Available usage times (EN)

One

$price_zh_HK$

JSON

/

O

Ticket Price

Unit：cent

{

"cent": 996,

"currency": "HKD"

}

$price_en_US$

JSON

/

O

Ticket Price

Unit：cent

{

"cent": 996,

"currency": "HKD"

}

$ticketType_zh_HK$

String

12

O

Ticket type (CN)

成人票

$ticketType_en_US$

String

24

O

Ticket type (EN)

Adult

$busSeat_zh_HK$

String

12

O

Seat number(CN)

01

$busSeat_en_US$

String

24

O

Seat number(EN)

01

$platformName_zh_HK$

String

32

O

Platform/agent name (CN)

KLOOK

$platformName_en_US$

String

64

O

Platform/agent name (EN)

KLOOK

$platformLogo_zh_HK$

String

256

O

Platform/agent logo URL

$platformLogo_en_US$

String

256

O

Platform/agent logo URL

$startTime_zh_HK$

Date

/

M

Bus departure time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$startTime_en_US$

Date

/

M

Bus departure time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_zh_HK$

Date

/

M

Bus arrival time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_en_US$

Date

/

M

Bus arrival time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

Name

Type

Length

Required

Description

Sample

$ticketName_zh_HK$

String

12

O

Ticket name (CN)

星願奇緣

$ticketName_en_US$

String

24

O

Ticket name (EN)

Wish

$availableTimes_zh_HK$

Integer

[0,100]

24

O

Available usage times (CN)

1

$availableTimes_en_US$

String

[0,100]

48

O

Available usage times (EN)

One

$address_zh_HK$

String

64

M

Cinema address (CN)

尖沙咀 梳士巴利道18號 Victoria Dockside K11 MUSEA L4 樓層

$address_en_US$

String

64

M

Cinema address (EN)

Level 4, K11 MUSEA, Victoria Dockside, 18 Salisbury Rd, Tsim Sha Tsui

$price_zh_HK$

JSON

/

O

Ticket Price

Unit：cent

{

"cent": 996,

"currency": "HKD"

}

$price_en_US$

JSON

/

O

Ticket Price

Unit：cent

{

"cent": 996,

"currency": "HKD"

}

$startTime_zh_HK$

Date

/

M

Movie start time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$startTime_en_US$

Date

/

M

Movie start time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_zh_HK$

Date

/

M

Movie end time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$endTime_en_US$

Date

/

M

Movie end time in millisecond timestamp format.

Will be displayed on in-app wallet

1640970061000

$movieAttributes_zh_HK$

LIST

128

M

Movie info（CN）

["2D","英語","120分鐘","IIA"]

$movieAttributes_en_US$

LIST

128

M

Movie info（EN）

["2D","English","120 minutes","IIA"]

$cinemaHouse_zh_HK$

String

32

M

Cinema house（CN）

LUXE

$cinemaHouse_en_US$

String

64

M

Cinema house（EN）

LUXE

$movieSeats_zh_HK$

LIST

128

M

Seat number

["F05","F06","F07"]

$movieSeats_en_US$

LIST

128

M

Seat number

["F05","F06","F07"]

$platformName_zh_HK$

String

32

O

Platform/agent name (CN)

AlipayHK電影小程式

$platformName_en_US$

String

64

O

Platform/agent name (EN)

AlipayHK Cinema Mini-app

$platformLogo_zh_HK$

String

256

O

Platform/agent logo URL

$platformLogo_en_US$

String

256

O

Platform/agent logo URL

$cinemaName_zh_HK$

String

32

O

Cinema name（CN）

K11 ART HOUSE(尖東站)

$cinemaName_en_US$

String

64

O

Cinema name（EN）

K11 ART HOUSE

$ticketInfoList_zh_HK$

LIST (JSON)

256

O

Ticket info（CN）

max 999

[{"ticketLevel":"成人票","count":"3"},{"ticketLevel":"学生票","count":"2"}]

$ticketInfoList_en_US$

LIST (JSON)

512

O

Ticket info（EN）

max 999

[{"ticketLevel":"Adult","count":"3"},{"ticketLevel":"Child","count":"2"}]

Name

Type

Length

Description

Sample

resultInfo

Object

/

Result code

templateCode

String

32

Template Id

status

String

16

Template status

Name

Type

Length

Description

Sample

resultCode

String

Result code

SUCCESS

resultStatus

String

Result Status

F - Failed

S - Success

S

resultMsg

String

Result message

SUCCESS

Index

Result Code

Result Status

Description

HTTP Status Code

1

PARAM_ILLEGAL

F

Illegal parameters. For example, non-numeric input, invalid date.

200OK

2

SUCCESS

S

success.

200OK

3

UNKNOWN_EXCEPTION

U

API failed due to unknown reason.

200OK

4

USER_NOT_EXIST

F

The user nor exist.

200OK

5

PASS_HAS_EXIST

F

pass has exist

6

PASS_TEMPLATE_HAS_NOT_EXIT

F

pass template has not exist

200OK

7

PASS_TYPE_NOT_MATCH

F

pass type not match

200OK

8

PASS_PRODUCT_TYPE_NOT_MATCH

F

pass product type not match

200OK

9

PASS_TEMPLATE_JSON_CONTENT_IS_NULL

F

pass template content is null

200OK

10

PASS_TEMPLATE_JSON_CONTENT_ILLEGAL

F

pass template content illegal

200OK