title
String(32)
|
(Required)
Main title. For example, Samsung Transit Card.
|
groupingId
String(36)
|
(Optional)
Identifier used to group related cards.
|
orderId
String(36)
|
(Optional)
Unique order identifier.
|
subtitle1
String(32)
|
(Optional)
Supplementary information.
|
logoImage
String(256)
|
(Optional)
Logo image URL. The file size must not exceed 256 kB.
|
logoImage.darkUrl
String(256)
|
(Optional)
Logo image URL for dark mode. The file size must not exceed 256 kB.
|
logoImage.lightUrl
String(256)
|
(Optional)
Logo image URL for light mode. The file size must not exceed 256 kB.
|
providerName
String(32)
|
(Required)
Transit card provider name.
|
startDate
Long(13)
|
(Optional)
Display start date as an epoch timestamp in milliseconds.
|
endDate
Long(13)
|
(Optional)
Display end date as an epoch timestamp in milliseconds.
|
user
String(64)
|
(Optional)
Passenger name.
|
userType
String(32)
|
(Optional)
Passenger classification, such as Child or Adult.
|
issueDate
Long(13)
|
(Optional)
Issue date as an epoch timestamp in milliseconds.
|
transitFare
String(32)
|
(Optional)
General or transit fare.
|
departureName
String(64)
|
(Optional)
Departure point name.
|
arrivalName
String(64)
|
(Optional)
Arrival point name.
|
seatNumber
String(16)
|
(Optional)
Seat location.
|
passengerCount
String(8)
|
(Optional)
Number of riders displayed across ticket surfaces.
|
totalTrips
String(8)
|
(Optional)
Number of available trips.
|
remainingTrips
String(8)
|
(Optional)
Number of remaining trips.
|
transitClass
String(32)
|
(Optional)
Transit class, such as a premium bus class.
|
transactions
String(4096)
|
(Optional)
Transaction history. Up to three items are displayed, depending on data size. See Transactions.
|
identifier
String(64)
|
(Optional)
Unique identifier assigned to the product.
|
routeInformation
String(4096)
|
(Optional)
Complete route guidance for the booked origin and destination.
|
locations
String(1024)
|
(Optional)
Locations where the card can be used. See Locations.
|
noticeDesc
String(5000)
|
(Optional)
Notice text. HTML is supported.
|
csInfo
String(4096)
|
(Optional)
Provider customer service information as an escaped JSON string. Supported items: call, email, website, facebook, pinterest, x, and instagram.
|
appLinkLogo
String(256)
|
(Required)
App-link image URL. The file size must not exceed 256 kB.
|
appLinkName
String(32)
|
(Required)
App-link name.
|
appLinkData
String(256)
|
(Required)
Partner app-link data.
|
bgImage
String(256)
|
(Optional)
Background image for card art. Recommended size: 888 × 555 px.
|
bgColor
String(8)
|
(Optional)
Card-art colour, for example #00FFFF.
|
fontColor
String(8)
|
(Optional)
Font colour. Allowed values: dark, light.
|
blinkColor
String(8)
|
(Optional)
Colour of the capture-prevention indicator effect.
|
barcode.generationType
String(16)
|
(Optional)
Barcode operation mode. Defaults to STATIC. Allowed values: STATIC, TOTP, INTERVAL. See Barcode & QR Code Presentation.
|
barcode.value
String(4096)
|
(Optional)
Data delivered when the barcode or QR Code is scanned.
|
barcode.serialType
String(32)
|
(Optional)
Presentation type.
|
barcode.ptFormat
String(32)
|
(Optional)
Presentation format.
|
barcode.ptSubFormat
String(32)
|
(Optional)
Presentation sub-format.
|
barcode.errorCorrectionLevel
String(4)
|
(Optional)
QR error-correction level. Allowed values: L, M, Q, H.
|
barcode.interval
String(11)
|
(Conditional)
Refresh cadence in milliseconds. Applies only to INTERVAL mode.
|
barcode.secretKeyEncoding
String(16)
|
(Conditional)
Encoding of barcode.secretKey; no default is defined. Required for TOTP mode.
|
barcode.secretKey
String(512)
|
(Conditional)
Shared secret used for TOTP generation. Treat this value as credential material. Required for TOTP mode.
|
barcode.totpAlgorithm
String(32)
|
(Conditional)
TOTP algorithm. Defaults to TOTP_SHA1 in TOTP mode.
|
barcode.totpDigits
Integer
|
(Conditional)
TOTP digit count. Defaults to a zero-padded six-digit value in TOTP mode.
|
barcode.totpPeriodMillis
Long(13)
|
(Conditional)
TOTP time step in milliseconds. Defaults to 30000 in TOTP mode.
|
merchantId
String(36)
|
(Optional)
Merchant identifier.
|
merchantName
String(32)
|
(Optional)
Merchant name to display.
|
balance
String(32)
|
(Optional)
Available points or remaining balance, displayed as supplied. For example, $ 1,000 or 1,000P.
|
summaryUrl
String(256)
|
(Optional)
Web page URL for details such as balance or transaction history.
|
