| attributes.{fields}
|
title
String (32)
|
(Required)
Main title.
e.g., Samsung Gift Card.
|
eventId
String (36)
|
(Optional)
If full cancelation of the event occurs, find and process all gift cards with this ID
|
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)
Gift card provider name
|
user
String (64)
|
(Optional)
Name of person who holds the gift card
|
preventCaptureYn
String (1)
|
(Optional)
Flag whether this wallet card view prevents screen capture.
Either 'Y' or 'N', the default value is '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 gift card can be used.
* See Location format.
|
noticeDesc
String (5000)
|
(Optional)
Text of the notice.
* Long content is allowed.
* See Additional Information format.
|
csInfo
String (512)
|
(Optional)
Providers’ customer service Information
Using data in JSON format converted to escape string
* Allowed items: call, email, or website
* 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)
URL for card art (background) image.
The recommended size for image resources is 888 x 555 px
|
mainImg
String (256)
|
(Optional)
URL for gift card image.
The file size should not exceed 512 KB.
|
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.pin
String (16)
|
(Optional)
PIN to show with a barcode
|
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)
Initial balance.
This is going to be shown as received.
e.g., $1,000.
|
balance
String (32)
|
(Optional)
Remaining balance.
This is going to be shown as received.
e.g., $1,000.
|
summaryUrl
String (256)
|
(Optional)
Web url that show details, such as balance or transactions history.
|
