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 subtype
coupon

 others

Others

Figure 8: Sample UI: Coupon

Wallet Card data fields

Attributes

Type

 Value

 Description
attributes.{fields}

 title
String (32)

 (Required)
Main title.
e.g., Free coupon.
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.
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.
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.
issueDate
Long (13)

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

 (Optional)
Date when the coupon is used.
Epoch timestamp in milliseconds.
noticeDesc
String (5000)

 (Optional)
Text of notice.
* HTML is supported.
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.
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"
                }
            }
        ]
    }
}

Business Support for Special Purposes

Server APIs are provided for cases where it is necessary to manage a large number of cards. Cards created through API can also be checked and managed in the same way on the ‘Wallet Partners Portal'.

Changes to each card status can be processed at the ‘Wallet Partners Portal', and information on how to change them should be checked through the Partner Server Portal Guide. The attributes related to the server API are as follows.

Attributes

Type

 Value

 Description
Payload object

 cardTemplate
Object

 (Required)
Wallet card template object
cardTemplate.prtnrId
String(32)

 (Required)
Partner ID
cardTemplate.templateRefId
String(19)

 (Required)
Partner Template ID
cardTemplate.title
String(32)

 (Required)
Wallet Card Name
cardTemplate.countryCode
String(2)

 (Conditional)
The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType
String(100)

 (Conditional)
This value is set to “coupon”.
* Required when creating a template.
cardTemplate.subType
String(100)

 (Conditional)
This value is set to “others”.
* Required when creating a template.
cardTemplate.prtnrAppPckgName
String(128)

 (Optional)
The Application Package Name.
cardTemplate.appLogoImg
String(200)

 (Optional)
The banner logo image URL.
cardTemplate.noNetworkSupportYn
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn
String(1)

 (Optional)
This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state
String(15)

 (Optional)
Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff
String(1)

 (Optional)
TestMode Off
Either 'Y' or 'N'
* Default: ‘N’
Available only when updating templates
cardTemplate.desc
String(500)

 (Optional)
Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551313",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "coupon",
    "subType": "others",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "noNetworkSupportYn": "N",
    "shareButtonExposureYN": "Y",
    "privacyModeYn": "N",
    "preventCaptureYn": "N",
  }
}