Unique identifier that is provided to Partner during onboarding.
Partner-Id
UUID
Required
Request-Id echoed back in the response headers
Common HTTP Error Codes
HTTP Code
Description
Application Code
Message
400
Bad Request
400.1
Invalid Data
500
Internal Server Error
500.1
Internal Server Error
503
Service Not Available
503.1
Service Temporarily Unavailable (Retry-After header is required)
503
Service Not Available
503.2
API Temporarily Unavailable (Retry-After header is required)
Registration
Partner server registers a session for the user. As a result, a unique registration ID will be generated. Partner server should make sure that this is called only once for one card.
A welcomeURL will also be returned. Partner server can display the welcomeURL in browser or email. Upon rendering, a QR code will be displayed and users can use their SPay WA to scan the QR code. WelcomeURL has an expiration date, partner server should check if it's still valid before rendering. If it's expired, a GET call will return the new URL.
Request
POST /registrations
Body
registration.email
Description
User email address
Type
String
Validation
Optional
Example
registration.enforceEmailMatching
Description
Enforce only SPay WA with the same email address can provision. Enforcement is only against the email address that's provided by the partner.
Type
Boolean. Default is false.
Validation
Optional
Example
true
registration.hideEmail
Description
Hide email field
Type
Boolean. Default is false
Validation
Optional
Example
registration.phone
Description
User phone number
Type
PhoneNumber
Validation
Optional
Example
registration.enforcePhoneMatching
Description
Enforce only SPay WA with the same phone number can provision. Enforcement is only against the phone number that's provided by the partner.
Type
Boolean
Validation
Optional. Default is false
Example
true
registration.hidePhone
Description
Hide phone field
Type
Boolean
Validation
Optional. Default is false
Example
registration.welcomeCallbackUrl
Description
Callback URL that the Welcome UI will redirect to once the user successfully linked a SPay WA account
Type
URL
Validation
Optional
Example
registration.allowOfflineCommunication
Description
If true, S2P will communicate to the user via email and/or phone number to facilitate the provisioning process
Type
Boolean
Validation
Optional. Default is false.
Example
registration.data
Description
Arbitrary data blob that'll be passed to the device when an account is linked.
Type
Object
Validation
Optional
Example
registration.custom.cardName
Description
Card name that'll show on the welcome page.
Type
String
Validation
Required
Example
registration.custom.cardArtUrl
Description
CardArt URL that'll show on the welcome page
Type
URL
Validation
Required
Example
registration.custom.partnerName
Description
Partner name that'll show on the welcome page.
Type
String
Validation
Required
Example
registration.custom.partnerLogoUrl
Description
Partner Logo URL that'll show on the welcome page.
Type
URL
Validation
Required
Example
registration.custom.partnerTncUrl
Description
Partner TnC URL that'll show on the welcome page.
Type
URL
Validation
Optional
Example
Response
Status
HTTP/1.1 201 Created
Header
Name
Value
Content-Type
application/json
Body
registration.id
Description
Registration ID that identify this session
Type
UUID
Validation
Required
Example
registration.status
Description
Registration status
Type
Enum - PENDING, LINKED
Validation
Required
Example
PENDING
registration.welcomeUrl
Description
This is the URL that partner can show to the user as an iFrame a separate page. It shows the QRCode and optionally user can enter email and phone number
Check existing registration status and/or get new welcomeUrl.
Request
GET /registrations/{regId}
Headers
Name
Value
Validation
partner-id
Partner id value assigned by Samsung Wallet
Required
Response
Status
HTTP/1.1 200 OK
Status
Name
Value
Content-Type
application/json
Body
registration.id
Description
Registration ID that identify this session
Type
UUID
Validation
Required
Example
registration.status
Description
Registration status
Type
Enum - PENDING, LINKED
Validation
Required
Example
PENDING
registration.welcomeUrl
Description
This is the URL that partner can show to the user as an iFrame a separate page. It shows the QRCode and optionally user can enter email and phone number.
Service Temporarily Unavailable (Retry-After header is required)
503
Service Not Available
503.2
API Temporarily Unavailable (Retry-After header is required)
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.