Common

Overview

The structure for configuring wallet cards follows the defined specification. Configuring the card data in the specified formatted JSON structure is required.

Type

 Value

 Description
Card object

 card
Object

 (Required)
Card information
card.type
String(16)

 (Required)
Wallet Card type
card.subType
String(16)

 (Required)
Wallet Card sub type
card.data[]
Array of Object

 (Required)
Wallet card data container. Allows up to 6 objects at once.
data[].refId
String(128)

 (Required)
A unique content identifier defined by the content provider
data[].createdAt
Long(13)

 (Required)
Data creation timestamp. Epoch timestamp in milliseconds.
* UTC±00:00
data[].updatedAt
Long(13)

 (Required)
Data creation timestamp. Epoch timestamp in milliseconds.
* UTC±00:00
data[].language
String(8)

 (Required)
Default content language code.
e.g., en, ko
data[].attributes
Object

 (Required)
Attributes of card data.
* Refer to the following chapters for each type
data[].attributes.{fields}

 Attribute fields by card type.
data[].localization[]
Array of Object

 (Optional)
Information for multilingual support.
localization[].language
String(8)

 (Required)
Multilingual content language code.
e.g., en, ko
localization[].attributes.{fields}

 For displaying a given language, ‘data[].attributes’ can be replaced by localized versions.
* Refer to the following chapters for each type
Security components

 confirmationValue
String(256)

 (Optional)
Reference values for authenticating card registration requests.
* See Secure ATW option from partner portal.

[Example: Card object]

{
Example: Card object 
{
    "card": {
        "type": "ticket",
        "subType": "movies",
        "data": [{
            "refId": "ref-20230304-001",
            "createdAt": 1612660039000,
            "language": "en",
            "attributes": {
                "title": "Samsung Wallet",
                "mainImg": "https://../main.png"

                    *Refer to the following chapters for each type

            },
            "localization": [{
                "language": "ko",
                "attributes": {
                    "title": "삼성 월렛"
                }
            }]
        }]
    }
}

To ensure secure transmission of card data, it must be tokenized in JWT format. For this purpose, you will require the certificate obtained using the partner's email account when signing up for the partner portal.

For detailed information on secure data tokenization, please refer to the Security chapter.

*Image resources provided by URLs can be cached. Therefore, for the image resource to be replaced immediately, the corresponding URL path must be changed.