Overview

'Add to Samsung Wallet' service also known as ATW, defines interfaces for users to conveniently add digital contents to Samsung Wallet.

Service flow

Figure 1: Add to Samsung Wallet

Preparation

  • 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.
  • See the chapter Implement the button for more details.

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.
  • Partners can consider the option*Data Fetch Link* when they provide full content data.
  • 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.
  • For interactions after storing contents on Samsung Wallet, server interfaces are needed which is defined on the chapter Server interaction.

Update Wallet Cards

  • If the wallet card contents should be updated by partners, they must call Samsung server API.
  • Path parameter 'cc2' must be set to the value brought from callback named 'Send Card State' API which includes 'ADDED' event.See a chapter Samsung Server API for more details.
  • Update Notification is for single content.
  • Cancel Notification is for calling off every user's wallet card contents 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.

Card States

Wallet cards have several states for each content provider’s notifications and user actions. The state diagram below describes wallet card states from beginning to end.

State diagram

Figure 2: Card state diagram