| attributes.{fields}
|
title
String(32)
|
(Required)
Main title.
e.g.,Samsung Loyalty Card.
|
eventId
String(36)
|
(Optional)
If full cancelation of the event occurs, find and process all loyalty cards with this ID
|
groupingId
String(36)
|
(Optional)
Identifier used to group related cards
|
orderId
String(36)
|
(Optional)
A unique identifier for an order
|
subtitle1
String(32)
|
(Optional)
The auxiliary field which displays supporting information
|
logoImage
String(256)
|
(Optional)
Logo image URL to be displayed in the card item.
The file size should not exceed 256 KB.
|
logoImage.darkUrl
String(256)
|
(Optional)
Logo image URL in dark mode.
The file size should not exceed 256 KB.
|
logoImage.lightUrl
String(256)
|
(Optional)
Logo image URL in light mode.
The file size should not exceed 256 KB.
|
providerName
String(32)
|
(Required)
Loyalty card provider name
|
startDate
Long(13)
|
(Optional)
Start date (Display Start date).
Epoch timestamp in milliseconds.
|
endDate
Long(13)
|
(Optional)
End date (Display End date).
Epoch timestamp in milliseconds.
|
locations
String(1024)
|
(Optional)
List of locations where the card can be used.
* See Location format.
|
noticeDesc
String(5000)
|
(Optional)
Text of notice.
*HTML supported
|
csInfo
String(512)
|
(Optional)
Providers’ customer service Information
Using data in JSON format converted to escape string
* Allowed items: call, email, website, facebook, pinterest, x, or instagram
* See the example below.
|
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
|
bgImage
String(256)
|
(Optional)
Background image for a card art.
The recommended size for image resources is 888 x 555 px
|
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 which indicates that a card cannot be captured 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
|
merchantId
String(36)
|
(Optional)
Merchant identifier
|
merchantName
String(32)
|
(Optional)
Merchant name to display
|
amount
String(32)
|
(Optional)
Total amount of points or initial balance. This is going to be shown as received.
It is recommended to use a one letter currency symbol.
e.g., $ 1,000, 1,000P
|
balance
String(32)
|
(Optional)
Available points or remaining balance.
This is going to be shown as received.
It is recommended to use a one letter currency symbol.
e.g., $ 1,000, 1,000P
|
summaryUrl
String(256)
|
(Optional)
Webpage URL that shows details, such as balance or transactions history
|
