UPC/EAN extension format. Not a stand-alone format.
Locations
Locations refer to place information that denotes where a card can be used. Using this information, Samsung Wallet can show a map, place name, and address. Additionally, location information can be used to provide Location-Based Services (LBS).
Location information can be represented by a JSON array and up to 10 locations can be specified.
Notice: Map services are only available in certain countries.
JSON Format
Key
Type
Requirement
Description
[].lat
Double
Optional
Latitude
[].lng
Double
Optional
Longitude
[].address
String
Required
String containing the full address
[].name
String
Required
Branch name
Example
* Location information for the entrance to Oracle Park
[
{
"lat": 37.779337,
"lng": -122.388755,
"address": "24 Willie Mays Plaza, San Francisco, CA 94107",
"name": "Willie Mays Plaza"
},
{
"lat": 37.77814,
"lng": -122.390836,
"address": "King St, San Francisco, CA 94107",
"name": "King St"
}
]
Additional Information
Additional information to be delivered to customers can be defined in the following format.
Be careful of the content string length. If an attribute does not allow long content, it is not displayed on the device.
JSON Format
Key
Type
Requirement
Description
count
Integer
Required
Size of information
info[]
Object arrays
Required
Container of information
info[].title
String
Required
Title. * Need either content or chart.
info[].content[]
String arrays
Optional
Content text
info[].chart
Object
Optional
Chart data
info[].chart.headers[]
String arrays
Optional
Header of chart
info[].chart.body[]
Array
Required
Body of chart
info[].chart.metadata[]
String arrays
Optional
Metadata of chart * Units or additional information of chart
* An example case of long content being allowed: Movie ticket policy
{
"count": 2,
"info": [
{
"title": "REFUNDS AND EXCHANGES",
"content": [
"Refunds and exchanges of movie ticket(s) are available in certain limited circumstances.",
"Movie tickets purchased through the Services include a non-refundable Convenience Fee. Before purchasing your movie ticket(s) we urge you to confirm the title, time, location and quantity of tickets for the movie you wish to see."
]
},
{
"title": "CHANGES TO TICKET POLICY",
"content": [
"From time to time, we may revise this Ticket Policy. You can determine when this Ticket Policy was last revised by referring to the top of this page. Any changes to this Ticket Policy will become effective upon posting of the revised Ticket Policy on the Internet, accessible through the Services."
]
}
]
}
* 1 person with a ticket
{
"person": [
{
"category": "Adult",
"count": 1
}
]
}
Transactions
Transactions to be delivered to customers can be defined in the following format.
Be careful of the content string length. If an attribute does not allow long content, it will not be displayed on the device.
JSON Format
Key
Type
Requirement
Description
[].date
String
Required
Transaction Date
[].amount
String
Optional
Amount value
[].description
String
Optional
Description
Example
* An example for payasyougo-evcharge-transactions
[
{
"date": "2023-09-10 12:00:00",
"amount": "50,000 WON",
"description": "Suwon Station Branch"
},
{
"date": "2023-09-20 18:00:00",
"amount": "70,000 WON",
"description": "Gangnam Central Branch"
}
]
Authentication
Defines the data format to authenticate the user registering/updating the card.
If need a custom user verification process, please get in touch with us via Tech Support.
Authentication Data Set
Case
Type
Value
Description
Connecting Information
ci
User’s CI Value
Identifier of Identity Verification Agency
Samsung Account
sa
User’s Samsung Account
Verifying that the signed-in Samsung account on the user's Galaxy device matches.
Subscriber Identity Module
sim
Sim card information on mobile telephone devices
Verify the SIM information being used on the user's mobile phone.
One-Time Password
otp
Dynamic Password
The temporary password provided by the partner to the user is verified by receiving user input during the Add to Samsung Wallet process.
Access Token
token
Token to verify data retrieval request
Token data included in card data is used as a key accessed when querying a partner server. This tokenized key can be reissued when the partner delivers updated card data.
Defines access control data for service providers to configure additional features with user's card.
JSON Format
Key
Type
Requirement
Description
provision.feature
String
Required
A specified feature defined in Wallet Card. * When setting up a Wallet Card, prior selection or consultation is required. * Use the value selected when setting up your Wallet Card in the Partner Portal.
provision.type
String
Required
A provisioning type defined in Wallet Card. * When setting up a Wallet Card, prior selection or consultation is required. * Use the value selected when setting up your Wallet Card in the Partner Portal.
provision.module
String
Required
A Module defined to use in provisioning process in Wallet Card. * Use the value selected when setting up your Wallet Card in the Partner Portal.
provision.identifier
String
Optional
A identifier intended to be used in provisioning process. * Suggestion: {package-name}, {applicationId}, {library}, {promised-identifier}
provision.data
String
Optional
Actual data to be used during the feature provisioning. Promised data fields or format to be passed to the module. * JSON format must be converted to escape string.
Provision Features (feature)
Attribute Name
Description
NFC
NFC communication feature with designated protocol
Provision Types (type)
Attribute Name
Description
SDK
Service Provider Protocol providing SDK
MESSAGE
Message in a promised format is utilized to convey identifiers, credentials, or any sort of dataset.
Provision Modules (module)
Attribute Name
Description
eSE
Embedded Secure Element in mobile devices to provide security features. Samsung Wallet App or any authorized agent with access rights can manage the secure element using this corresponding module. To utilize this corresponding module, the applet to be installed on this module must be provided beforehand, and obtaining authorization for SSD creation and access control might be required. For more detailed requirements, please refer to our technical inquiry.
SE-USIM
Universal Subscriber Identity Module (USIM) functions as a secure data repository, storing essential information including user profiles, contact lists, text messages, and application data. Utilizing advanced security measures like PIN codes and cryptography, the USIM guarantees the integrity and confidentiality of all stored data. Furthermore, it empowers users to securely access network services and authenticate their identities during financial transactions or when handling sensitive information. Consequently, the USIM operates as a trustworthy platform for managing sensitive data and enabling secure communications between users and service providers. However, to utilize this module, an additional Software Development Kit (SDK) may be required for seamless integration and access.
APP
Samsung Wallet Application handles access control data.
Example
'data' field needs to be mutually negotiated with Samsung Wallet team.
Partner Code. * Partner Code or ID from Samsung Pay Partner System.
Query parameters
modelName
String
Required
Device model name Ex) SM-G925K, SM-R730T
serviceType
String
Required
Service type - WALLET : Samsung Wallet
Example
Response
Type
Value
Description
body
resultCode
String
Required
Result code
resultMessage
String
Required
Result message
available
boolean
Required
Service availability
supportKR
boolean
Required
KR service support for the device
Example (Success)
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: xx
{
"resultCode" : "0",
"resultMessage" : "SUCCESS",
"available": "true",
"supportKR": "true"
}
Example (Error)
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
Content-Length: xx
{
"resultCode" : " CMN5N9001",
"resultMessage" : " Internal Server Error"
}
Response
HTTP code
Status code
Description
200
0
Success
400
CMN1N1001
Missing requisite parameter from API request – {0}
400
CMN1N1002
Invalid parameter from API request – {0}
400
CMN1N1003
Invalid parameter length from API request – {0}
400
CMN2N2007
Invalid country code
500
CMN4N8003
DB connection failed
Security Factors
Service Flow
How to Generate Key Factors
OpenSSL is an open-source command-line tool that allows you to perform various SSL-related tasks. This section explains how to create key factors for security with OpenSSL.
Private Key
A private key enables encryption and is the most important component of certificates.
If you want to make it more secure, adding "-des3" on the command will encrypt with password.
Certificate Signing Request (CSR)
Certificate Signing Request (CSR) is a necessary factor to get a signed certificate. The CSR includes the public key and some additional information, such as organization and country.
Let's create a CSR (domain.csr) from the existing private key.
Enter the CSR information to complete the process. The output will look like the following:
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [XX]:KR
State or Province Name (full name) []:Seoul
Locality Name (eg, city) [Default City]:Sample City
Organization Name (eg, company) [Default Company Ltd]:Sample Company
Organizational Unit Name (eg, section) []:Sample section
Common Name (eg, your name or your server's hostname) []:domain
Email Address []:email@email.com
Please enter the following 'extra'attributes
to be sent with your certificate request
A challenge password []:
An optional company name []:
‘password’ is an optional attribute.
The ‘Common Name’ field is important, as it needs to exactly match the Fully Qualified Domain Name (FQDN) of our domain.
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.