| attributes.{fields}
|
title
String(32)
|
(Required)
Main title.
e.g.,Samsung Loyalty Card.
|
eventId
String(36)
|
(Optional)
If the event is cancelled, use this identifier to find and process all associated loyalty cards.
|
groupingId
String(36)
|
(Optional)
Identifier used to group related cards.
|
orderId
String(36)
|
(Optional)
A unique identifier for an order.
|
subtitle1
String(32)
|
(Optional)
Auxiliary field that 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.
This is a flat key name, not a nested object path.
The file size should not exceed 256 KB.
|
logoImage.lightUrl
String(256)
|
(Optional)
Logo image URL in light mode.
This is a flat key name, not a nested object path.
The file size should not exceed 256 KB.
|
providerName
String(32)
|
(Required)
Loyalty card provider name.
|
preventCaptureYn
String(1)
|
(Optional)
Flag whether this wallet card view prevents screen capture
Either 'Y' or 'N'
* Default: 'N'
|
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 Locations
|
noticeDesc
String(5000)
|
(Optional)
Text of notice.
* HTML supported
|
extendedFields
String(1024)
|
(Optional)
A flexible list of key-value pairs.
* See Extended Fields
|
csInfo
String(4096)
|
(Optional)
Provider customer service information.
Provide the value as an escaped JSON 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)
Colour of the card art.
e.g., #00FFFF.
|
fontColor
String(8)
|
(Optional)
Colour of the text on the card art.
Acceptable values: dark, light.
|
blinkColor
String(8)
|
(Optional)
Colour 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 & QR Code Presentation.
|
barcode.ptFormat
String(32)
|
(Optional)
Presentation format.
e.g., BARCODE, QRCODE, SERIAL....
* See Barcode & QR Code Presentation.
|
barcode.ptSubFormat
String(32)
|
(Optional)
Presentation sub-format.
e.g., CODE_128, QR_CODE....
*See Barcode & QR Code Presentation.
|
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 number of points or initial balance. Displayed as received.
Use a one-letter currency symbol where applicable.
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)
Web page URL that shows details, such as balance or transaction history.
|
level
String(16)
|
(Optional)
It represents the name or title of the loyalty level.
e.g., Bronze, Silver, Gold, etc
|
user
String(64)
|
(Optional)
Name of person who holds the loyalty card.
|
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.
|
selectorId
String(8)
|
(Optional)
When Samsung App-resident NFC is supported, it refers to the identifier issued during Wallet Card settings. When using the card's NFC function, the terminal can transmit selectorId to the user's device. Upon receiving selectorId, the device can identify the benefit service and perform additional actions accordingly.
* Refer to Access Integration Guide. Samsung approval required. Contact Technical Support.
|
provision.data
String(512)
|
(Optional)
Elements to complete provisioning.
* Refer to Access Integration Guide. Samsung approval required. Contact Technical Support.
|
provision.interval
String(16)
|
(Optional)
Update interval for dynamic provisioning, in milliseconds.
* Refer to Access Integration Guide. Samsung approval required. Contact Technical Support.
|
