| attributes.{fields}
|
title
String (32)
|
(Required)
Main title.
e.g., MLB Ticket.
|
category
String (16)
|
(Optional)
Ticket category.
* This will be deprecated.
|
eventId
String (32)
|
(Optional)
If full cancelation of the event occurs, find and process all tickets with this ID
|
groupingId
String (32)
|
(Optional)
Identifier used to group related cards
|
orderId
String (32)
|
(Optional)
A unique identifier for an order
|
mainImg
String (256)
|
(Required)
URL for main ticket image.
The file size should not exceed 512 kB.
|
subtitle1
String (32)
|
(Optional)
The auxiliary field which displays supporting information.
|
logoImage
String (256)
|
(Required)
Logo image URL to be displayed in the Card item.
The file size should not exceed 256 kB.
|
logoImage.darkUrl
String (256)
|
(Required)
Logo image URL in dark mode.
The file size should not exceed 256 KB.
|
logoImage.lightUrl
String (256)
|
(Required)
Logo image URL in light mode.
The file size should not exceed 256 KB.
|
wideImage
String (256)
|
(Optional)
Wide horizontal image URL displayed on the Card information screen.
The file size should not exceed 256 kB.
|
providerName
String (32)
|
(Required)
Ticket provider name
|
providerViewLink
String (512)
|
(Optional)
Link to additional information from the provider
* See Links format.
|
classification
String (16)
|
(Optional)
Classification of tickets.
Use ONETIME, REGULAR, or ANNUAL.
* Default: ONETIME.
|
holderName
String (64)
|
(Optional)
Name of card holders
|
idPhoto
String (20k)
|
(Optional)
Holder’s photo image data encoded Base64
|
idPhoto.format
String (32)
|
(Optional)
Image file format
e.g., jpeg, png.
* Unsupported image formats may exist.
|
idPhoto.status
String(16)
|
(Optional)
Status of the data
Allowed value: UNCHANGED
|
grade
String (32)
|
(Optional)
Ticket grade
|
seatClass
String (32)
|
(Optional)
Seat class
|
entrance
String (64)
|
(Optional)
Entrance gate
|
seatNumber
String (256)
|
(Optional)
Seat location
|
seatLayoutImage
String (256)
|
(Optional)
URL of the seat layout image.
The file size should not exceed 512 KB.
|
issueDate
Long (13)
|
(Required)
issue date.
Epoch timestamp in milliseconds.
|
reservationNumber
String (32)
|
(Required)
Reservation number
|
user
String (64)
|
(Optional)
Name of person who made the reservation
|
certification
String (16)
|
(Optional)
Ticket certification.
e.g.,R, as a film rating.
|
reactivatableYn
String (1)
|
(Optional)
Flag whether the card is able to activate an expired ticket temporarily.
Either 'Y' or 'N'.
* Default: 'N'
|
preventCaptureYn
String (1)
|
(Optional)
Flag whether this wallet card view prevents screen capture.
Either 'Y' or 'N'
* Default: 'N'
|
noNetworkSupportYn
String (1)
|
(Optional)
Set whether to support to open the wallet card under 'No Network' Status.
Either 'Y' or 'N'.
* Default: 'N'
|
startDate
Long (13)
|
(Required)
Start date (Displayed Start date).
Epoch timestamp in milliseconds.
|
startDate.utcOffset
String(8)
|
(Optional)
UTC offset of start date time at the event location.
|
endDate
Long (13)
|
(Optional)
End date (Displayed End date).
Epoch timestamp in milliseconds.
* If null, the card will expire in 10 hours from startDate.
|
endDate.utcOffset
String(8)
|
(Optional)
UTC offset of start date time at the event location.
|
person1
String (512)
|
(Optional)
Number of persons by category.
* See Classification format.
|
locations
String (1024)
|
(Optional)
List of locations where the card can be used.
* See Location format.
|
noticeDesc
String (5000)
|
(Required)
Text of the notice.
* Long content is allowed.
* See Additional Information format.
|
groupInfo1
String (64)
|
(Optional)
The first common information with the same groupingId.
|
groupInfo2
String (64)
|
(Optional)
The second common information with the same groupingId.
*It is recommended to set groupInfo1 first.
|
groupInfo3
String (64)
|
(Optional)
The third common information with the same 'groupingId'.
*It is recommended to set groupInfo1, groupInfo2 first.
|
csInfo
String (512)
|
(Optional)
Providers’ customer service Information
Using data in JSON format converted to escape string
* Allowed items: call, email, website, facebook, youtube, or instagram
* See the example below.
|
privacyModeYn
String (1)
|
(Optional)
Whether or not to require user authentication when using the card
Either ‘Y’ or ‘N’
* Default: ‘N’
|
appLinkLogo
String (256)
|
(Required)
App link image URL.
The file size should not exceed 256 KB.
|
appLinkName
String (32)
|
(Required)
App link name
|
appLinkData
String (256)
|
(Required)
Information about the partner app link
|
bgColor
String (8)
|
(Optional)
Color of the card art.
e.g., #00FFFF.
|
fontColor
String (8)
|
(Optional)
Color of the font on the card art.
Acceptable values: dark, light.
|
blinkColor
String (8)
|
(Optional)
Color of the blinking effect in the Indicator area
e.g., #00FFFF
|
barcode.value
String (4096)
|
(Optional)
Actual data that is delivered when the barcode/QR code is scanned.
|
barcode.serialType
String (32)
|
(Optional)
Presentation type.
e.g., SERIALNUMBER, BARCODE....
* See Barcode format.
|
barcode.ptFormat
String (32)
|
(Optional)
Presentation format.
e.g., BARCODE, QRCODE, SERIAL....
* See Barcode format.
|
barcode.ptSubFormat
String (32)
|
(Optional)
Presentation sub-format.
e.g., CODE_128, QR_CODE....
* See Barcode format.
|
barcode.errorCorrectionLevel
String (4)
|
(Optional)
Amount of redundancy or error correction data included in the code.
There are four error correction levels available in QR codes.
* Code options: L/M/Q/H
|
barcode.Interval
String (4)
|
(Optional)
Update interval if support for dynamic updates
Epoch timestamp in milliseconds.
|
provision.data
String(512)
|
(Optional)
Elements to complete provisioning
* See Provisioning for details
|
provision.interval
String(16)
|
(Optional)
Update interval if support for dynamic updates.
Epoch timestamp in milliseconds
|
relCoupon{i}.title
String(32)
|
(Conditional)
Coupon title.
* Required if this ticket has a related coupon
i: 1~3
|
relCoupon{i}.subtitle
String(32)
|
(Optional)
Coupon subtitle
i: 1~3
|
relCoupon{i}.providerName
String(32)
|
(Conditional)
Coupon provider name.
* Required if this ticket has a related coupon
i: 1~3
|
relCoupon{i}.imageFileSrc
String(256)
|
(Optional)
Coupon image URL.
The file size should not exceed 256 kB.
i: 1~3
|
relCoupon{i}.noticeDescription
String(1024)
|
(Optional)
Text of the notice.
* Long content is allowed.
* See Additional Information format.
i: 1~3
|
relCoupon{i}.notificationTime
Long(13)
|
(Optional)
Coupon exposure time.
Epoch timestamp in milliseconds.
i: 1~3
|
relCoupon{i}.value
String(4096)
|
(Conditional)
Actual data that is delivered when the barcode/QR code is scanned.
i: 1~3
|
relCoupon{i}.serialType
String(32)
|
(Required)
Presentation Type
e.g., SERIALNUMBER, BARCODE, ...
* See Barcode format.
i: 1~3
|
relCoupon{i}.ptFormat
String(32)
|
(Conditional)
Presentation Format
e.g., BARCODE, QRCODE, SERIAL, ...
* See Barcode format.
i: 1~3
|
relCoupon{i}.ptSubFormat
String(32)
|
(Conditional)
Presentation Sub-format
e.g., CODE_128, QR_CODE, ...
* See Barcode format.
i: 1~3
|
relCoupon{i}.errorCorrectionLevel
String(4)
|
(Optional)
Amount of redundancy or error correction data included in the code.
There are four error correction levels available in QR codes.
- Code options: L/M/Q/H
i: 1~3
|
