'Add to Samsung Wallet' service also known as ATW, defines interfaces for users to conveniently add digital contents to Samsung Wallet.
Service flow
User-Initiated Links
Data Transmit Link
The most common and straightforward method is the Data Transmit Link approach, which securely includes tokenized data in the ATW link. The ATW link format for this method is as follows.
The name Data Transmit Link has been changed from Typical flow.
Wallet card identifier issued from Partner portal when the partner manager signs up for partner services and registers the wallet card they want to service.
Hash path parameters
#Clip
String
Required
Parameters for the Hash link * The first letter is capitalized
Query parameters
cdata
String
Required
Actual payload data in basic JSON format to communicate between partners and Samsung Wallet. This must be secured in JWT(JSON Web Token) format. * Refer to Security for more details.
In cases involving sensitive data or when providing static links, Data Fetch Link method is highly recommended. Links using this approach include only a unique reference ID, and Wallet Cards are added by querying data through Get Card Data path as specified in Partner portal.
The name Data Fetch Link has been changed from Slim data flow.
Please be aware that if the link is exposed to unintended users, it can be exploited. Please prepare the integration with this in mind.
It is crucial to ensure that the refId, used for a reference value, is generated in a manner that is not easily deducible by potential attackers.
Certificate identifier based on a CSR during onboarding. 4 digits alphanumeric. * Must be generated from Partner Portal
cardId
String
Required
Wallet card identifier. * It must be generated from Partners Portal.
Hash path parameters
#Clip
String
Required
Parameters for the Hash link
Query parameter
pdata
String
Required
Unique ID defined by content providers. This has identification for each user's Wallet Card contents. * For secure transactions, a Reference ID(refId) must be in a form that cannot be inferred.
This is an API that allows partners to provide wallet cards to users. Request payload must include user information. Then the user device is notified of card registration through a push notification.
Card Data Specification
Card ID
{Card Id} is an ID issued when the partner manager signs up for partner services and register the wallet card they want to service. Refer to Partner Onboarding guide document for details.
cdata
Actual payload data in basic JSON format to communicate between partners and Samsung Wallet. See the details on the below sheet.
Card Data Token
The specific wallet card data mentioned as cdata must be secured in JWT(JSON Web Token) format. See a chapter Security for details.
Request
Type
Value
Description
Method
POST
URL
/atw/v1/cards/{cardId}
Headers
Authorization
String(1024)
Required
Credential token. The token can have prefix "Bearer" as an authorization type. i.e., Bearer * See Authorization Token
x-smcs-partner-id
String(32)
Required
Partner ID.
x-request-id
String(32)
Required
Request identifier. Random generated UUID string.
x-smcs-cc2
String(2)
Required
Country Code (ISO-3166-1 alpha-2) of User Account
Path Parameters
cardId
String(32)
Required
Wallet card identifier granted from Partner Portal
Body Parameters
cdata
Object
Required
Actual payload data in basic JSON format to communicate between partners and Samsung Wallet. This must be secured in JWT(JSON Web Token) format. * See the chapter Security for more details.
Requests cannot or will not be processed the request due to something that is perceived to be a client error
401
401 Unauthorized
Authorization token is invalid or expired.
500
500 Internal Server Error
503
503 Service Unavailable
Manage Your Cookies
We use cookies to improve your experience on our website and to show you relevant
advertising. Manage you settings for our cookies below.
Essential Cookies
These cookies are essential as they enable you to move around the website. This
category cannot be disabled.
Company
Domain
Samsung Electronics
.samsungdeveloperconference.com
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.
Company
Domain
LinkedIn
.linkedin.com
Meta (formerly Facebook)
.samsungdeveloperconference.com
Google Inc.
.samsungdeveloperconference.com
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.
Company
Domain
LinkedIn
.ads.linkedin.com, .linkedin.com
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.
Company
Domain
LinkedIn
.linkedin.com
Meta (formerly Facebook)
.samsungdeveloperconference.com
Google Inc.
.samsungdeveloperconference.com
Preferences Submitted
You have successfully updated your cookie preferences.