Generic Card

'Generic Card' is defined for registering various forms of cards that aren't defined as other types. Partners can customize the items on the Generic Card to display by connecting them with card data.

Wallet card type

 Wallet card subtype
generic

 others

Others

Figure 16: Sample UI: Generic Card Type1
Figure 17: Sample UI: Generic Card Type2
Figure 18: Sample UI: Generic Card Type3

Wallet Card data fields

Attributes

Type

 Value

 Description
attributes.{fields}

 title
String(32)

 (Required)
Main title
subtitle
String(32)

 (Optional)
The auxiliary field which displays supporting information.
providerName
String(32)

 (Required)
Provider name.
eventId
String(32)

 (Optional)
Event Identifier
groupingId
String(32)

 (Optional)
Identifier used to group related cards.
startDate
Long(13)

 (Required)
Start date (Display Start date)
Epoch timestamp in milliseconds.
startDate.relativeNotiTime
String(4)

 (Optional)
The relative time from startDate
in minutes to provide a notification to the user
e.g., 5, 10, 15, 30, 60, and up to 2880
endDate
Long(13)

 (Optional)
End date (Display End date)
Epoch timestamp in milliseconds.
endDate.relativeNotiTime
String(4)

 (Optional)
The relative time from endDate
in minutes to provide a notification to the user
e.g., 5, 10, 15, 30, 60, and up to 2880
logoImage
String(256)

 (Optional)
Logo image URL to be displayed
in 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
* If this value does not exist, logoImage will be substituted
logoImage.lightUrl
String(256)

 (Optional)
Logo image URL in light mode
The file size should not exceed 256 kB
* If this value does not exist, logoImage will be substituted
bgImage
String(256)

 (Optional)
Card background image URL
The file size should not exceed 512 kB
The recommended size for image resources is 888 x 555 px
text{i}
String(64)

 (Optional)
Text item
i: 1~12
image1
String(128k)

 (Optional)
Image item
Use only type 3
image1.lightUrl
String(256)

 (Optional)
Image item in light mode
image1.darkUrl
String(256)

 (Optional)
Image item in dark mode
image1.status
String(16)

 (Optional)
Image item status
serial{i}.value
String(4096)

 (Optional)
Actual data that is delivered when the barcode/QR code is scanned.
i: 1~2
serial{i}.serialType
String(32)

 (Optional)
Presentation Type
e.g., SERIALNUMBER, BARCODE, ...
* See Barcode format
serial{i}.ptFormat
String(32)

 (Optional)
Presentation Format
e.g., BARCODE, QRCODE, SERIAL, ...
* See Barcode format
serial{i}.ptSubFormat
String(32)

 (Optional)
Presentation Sub-format
e.g., CODE_128, QR_CODE, ...
* See Barcode format
serial{i}.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
noticeDesc
String(1024)

 (Required)
Notice description
* 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: calls, emails, or websites
privacyModeYn
String(1)

 (Optional)
Whether or not to require user
authentication when using the card
Either ‘Y’ or ‘N’
* Default: ‘N’
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
noNetworkSupportYn
String(1)

 (Optional)
Sets whether to support to open
the wallet card under 'No Network' Status.
Either 'Y' or 'N'
* Default: '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.
locations
String(1024)

 (Optional)
List of locations where the card can be used.
* See Location format.

Example

{
    "card": {
        "type": "generic",
        "subType": "others",
        "data": [
            {
                "createdAt": 1661745824345,
                "updatedAt": 1661745824345,
                "language": "en",
                "refId": "REFID-012345",
                "attributes": {
                    "title": "Samsung Generic Card",
                    "subtitle": "Personal Members",
                    "providerName": "Samsung",
                    "startDate": 1661751274000,
                    "startDate.utcOffset": "UTC+9",
                    "endDate": 1761778000000,
                    "endDate.utcOffset": "UTC+9",
                    "endDate.relativeNotiTime": "1440",
                    "text1": "13047623",
                    "text2": "Silver",
                    "text3": "Suwon Station Branch",
                    "text4": "031)000-1235",
                    "image1": "https://www.samsung.com/images/image1.png",
                    "image1.darkUrl": "https://www.samsung.com/images/dark.png",
                    "image1.lightUrl": "https://www.samsung.com/images/light.png",
                    "serial1.value": ">1180MM2241B7C 0000000000000298060000000000 0 090870907 ",
                    "serial1.serialType": "QRCODE",
                    "serial1.ptFormat": "QRCODE",
                    "serial1.ptSubFormat": "QR_CODE",
                    "bgColor": "#FF5000",
                    "fontColor": "dark",
                    "noticeDesc": "{\"count\":2,\"info\":[{\"title\":\"NOTICE1\",\"content\":[\"DESCRIPTION1\",\"DESCRIPTION2\"]},{\"title\":\"NOTICE2\",\"content\":[\"DESCRIPTION1\",\"DESCRIPTION2\"]}]}",
                    "csInfo": "{\"calls\":[{\"key\":\"Emergency\",\"value\":\"82) 123-4567\"},{\"key\":\"Customer Service\",\"value\":\"82) 123-9876\"}],\"emails\":[{\"key\":\"CS Team\",\"value\":\"cs@atwsample.com\"}],\"websites\":[{\"key\":\"FAQ\",\"value\":\"https://atwhomepage.com/faq\"},{\"key\":\"Support\",\"value\":\"https://atwhomepage.com/support\"}]}",
                    "appLinkData": "https://www.samsung.com/",
                    "appLinkLogo": "https://www.samsung.com/logo.png",
                    "appLinkName": "Samsung"
                },
                "localization": [
                    {
                        "language": "ko",
                        "attributes": {
                            "title": "삼성 제네릭 카드",
                            "subtitle": "개인 멤버스",
                            "providerName": "삼성",
                            "text2": "실버 등급",
                            "text3": "수원역점"
                        }
                    }
                ]
            }
        ]
    }
}

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 “generic”.
* Required when creating a template.
cardTemplate.subType
String(100)

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

 (Optional)
Select from these values: “generic 01”, “generic 02”, “generic 03”
* Default: “generic 01”
cardTemplate.prtnrAppPckgName
String(128)

 (Optional)
APP Package Name
cardTemplate.appLogoImg
String(200)

 (Optional)
Banner logo image URL.
cardTemplate.noNetworkSupportYn
String(1)

 (Optional)
Either 'Y' or 'N'
* Default: 'N'
cardTemplate.privacyModeYn
String(1)

 (Optional)
Either 'Y' or 'N'
* Default: 'N'
cardTemplate.preventCaptureYn
String(1)

 (Optional)
Screen capture prevention flag
cardTemplate.category
String(20)

 (Optional)
Select from the following values: “parking_pass”, “membership”, “reservations”, “insurance”, “health”, “receipt”, “coupon_stamp”, “note”, “photo”, and “others”.
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": "2138240408282551319",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "generic",
    "subType": "others",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "designType": "generic 02",
    "noNetworkSupportYn": "N",
    "category": "membership",
    "privacyModeYn": "N",
    "preventCaptureYn": "N"
  }
}