3.1 Overview

The Add to Samsung Wallet (ATW) service provides a set of interfaces that enable users to easily add digital content to their Samsung Wallet, enhancing convenience by allowing users to store, manage, and access items such as loyalty cards, tickets, boarding passes, and more directly within the app. The service involves several steps, from content preparation to updates and managing card states.

3.1.1 Service Flow

3.1.2 Preparation

Steps to prepare

The contents intended to store on Samsung Wallet must be tokenized as JWT (JSON Web Token) when using Data Transmit Link
Considering what environments, the button will be displayed in such as App, Web, MMS, or Email when you plan to integrate this service.

Refer to Implement the button section for more details.

Note-The Data Transmit Link is used for communication between the partner’s server and Samsung Wallet. This link sends any additional information related to the card (such as updates or notifications about the card’s status).

3.1.3 Add to Wallet

Steps to Add to Wallet

Once users who want to store contents click or tab the linked button, it initiates the process of adding to Samsung Wallet.
See Add to Wallet Interfaces for more details.
If you are providing the full pass content, use the Data Fetch Link option.
Note-The Data Fetch Link enables the partner's backend system to pull content dynamically. When a user clicks the "Add to Wallet" button, the system fetches the necessary content (e.g., card details, event data, loyalty points) using this link.
Samsung will notify the result through server interface named Send Card State. This works as a callback for 'Add to Wallet' process delivering events and country code for the user wallet card.
To handle interactions after storing content in Samsung Wallet, server interfaces are required. These interfaces are defined in the chapter titled "Server Interaction".

3.1.4 Update Wallet Cards

Steps to update wallet cards

Partners may need to update or modify the content stored in Samsung Wallet. For example, a user might accumulate more loyalty points, or flight details may change. To update the wallet card content, partners must call the Samsung server API.
The cc2 path parameter must match the cc2 value from the Send Card State API notification triggered by the ADDED event.
Refer to Samsung Server API section for more details.
Update Notification is for single content.
Cancel Notification is for calling off every user's wallet card content related to a specific event.
Get Card Data payload has the same format of card information as the one of 'Add to wallet'.
Send Card State can also have an event 'DELETED' to notify a wallet card deletion on Samsung Wallet by users.
Gift cards and Generic cards currently do not support update notification functionality.

3.1.5 Card States

Wallet cards within Samsung Wallet can have various states (e.g., active, expired, used, suspended) for each content provider’s notifications and user actions.

The state diagram below describes wallet card states from beginning to end.

Essential Cookies

These cookies are essential as they enable you to move around the website. This category cannot be disabled.

Analytical/Performance Cookies

These cookies collect information about how you use our website. for example which pages you visit most often. All information these cookies collect is used to improve how the website works.

Functionality Cookies

These cookies allow our website to remember choices you make (such as your user name, language or the region your are in) and tailor the website to provide enhanced features and content for you.

Advertising Cookies

These cookies gather information about your browser habits. They remember that you've visited our website and share this information with other organizations such as advertisers.