Coupon

'Coupon' cards support digitized redeemable vouchers. Coupons in Wallet for various channels can provide alarms before expiration and update usage status.

Wallet Card type

Wallet card type

 Wallet card subtype
coupon

 others

Others

Wallet Card data fields

Attributes

Type

 Value

 Description
attributes.{fields}

 title
String(32)

 (Required)
Main title.
e.g., Free coupon.
subtitle
String(32)

 (Optional)
Auxiliary field displays supporting information.
* For Internal Use Only
orderId
String(32)

 (Optional)
Unique identifier for an order
mainImg
String(256)

 (Required)
URL for the main coupon 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
logoImage
String(256)

 (Optional)
Logo image URL to be displayed in the Card item.
The file size should not exceed 256 kB.
* For Internal Use Only
logoImage.darkUrl
String(256)

 (Optional)
Logo image URL in dark mode.
The file size should not exceed 256 kB.
* For Internal Use Only
logoImage.lightUrl
String(256)

 (Optional)
Logo image URL in light mode.
The file size should not exceed 256 kB.
* For Internal Use Only
brandName
String(32)

 (Optional)
Brand name
expiry
Long(13)

 (Required)
Expiration date in timestamp format. Issued data is cleaned up after it expires.
Epoch timestamp in milliseconds.
addressInputDeadline
String(13)

 (Optional)
The deadline by which the user must input or submit their shipping address.
This field is used only when barcode.ptFormat is set to "SHIPPING".
issueDate
Long(13)

 (Required)
Issue date.
Epoch timestamp in milliseconds.
redeemDate
Long(13)

 (Optional)
Date when the coupon is used.
Epoch timestamp in milliseconds.
redeemYn
String(1)

 (Optional)
Indicates whether the coupon has been redeemed.
Either ‘Y’ or ‘N’
noticeDesc
String(5000)

 (Optional)
Text of notice.
* HTML is supported.
extendedFields
String(1024)

 (Optional)
A flexible list of key-value pairs.
* See Extended Fields
storeInfo
String(32)

 (Optional)
Specifies the name of the store where the coupon can be used
providerName
String(32)

 (Optional)
Identifies the entity or service provider issuing or managing coupons.
lastUpdatedAt
Long(13)

 (Optional)
Last updated date.
Epoch timestamp in milliseconds.
editableYn
String(1)

 (Required)
Flag whether the coupon can be modified.
Either 'Y' or 'N'.
deletableYn
String(1)

 (Required)
Flag whether the coupon can be deleted.
Either 'Y' or 'N'.
displayRedeemButtonYn
String(1)

 (Required)
Flag whether the use completion button is displayed.
Either 'Y' or 'N'.
notificationYn
String(1)

 (Required)
Flag whether a notification related to the coupon is delivered.
Either 'Y' or '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.
preventCaptureYn
String(1)

 (Optional)
Flag whether this wallet card view prevents screen capture
Either 'Y' or 'N'
* Default: 'N'
barcode.value
String(4096)

 (Conditional)
Actual data that is delivered when the barcode/QR code is scanned.
* Required if serialType isn’t 'None'.
barcode.value2
String(4096)

 (Conditional)
The secondary barcode data.
* Required if ptFormat is DUALBARCODE or DUALBARCODESERIAL.
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
balance
String(50)

 (Optional)
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.
summaryUrl
String(256)

 (Optional)
Webpage url that show details, such as balance.
userMessage
String(256)

 (Optional)
Message to forward.
sender
String(64)

 (Optional)
Name of sender.
redeemUrl
String(256)

 (Optional)
Link to redeem coupons

Example

{
    "card": {
        "type": "coupon",
        "subType": "others",
        "data": [
            {
                "refId": "ref-230712-0001",
                "createdAt": 1612660039000,
                "updatedAt": 1612660039000,
                "language": "en",
                "attributes": {
                    "title": "Free Coupon",
                    "mainImg": "https://../main.png",
                    "brandName": "Samsung Coupon",
                    "expiry": 1637802725000,
                    "issueDate": 1637457125000,
                    "editableYn": "N",
                    "deletableYn": "N",
                    "displayRedeemButtonYn": "Y",
                    "notificationYn": "Y",
                    "appLinkName": "OO Voucher",
                    "appLinkLogo": "https://../applinklogo.png",
                    "appLinkData": "https://www.oocoupon.com",
                    "barcode.value": "CS16138353212584806754FG1802 ",
                    "barcode.serialType": "BARCODE",
                    "barcode.ptFormat": "QRCODESERIAL",
                    "barcode.ptSubFormat": "QR_CODE"
                }
            }
        ]
    }
}