Advances features

Check Service Available Devices

Check Samsung Pay/Wallet service availability for the devices and countries.

Request

Type

Value

Description

Method

GET

URL

https://api-us3.mpay.samsung.com/wallet/cmn/v2.0/device/available

Header

partnerCode

String

Required

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

Provisioning

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.
Case

feature

type

module

identifier

data

Partner provides APDU bundle for eSE

NFC

MESSAGE

eSE

partner-apdu-01

{
"accessKey":"abcdefg","apdus":"{apdu-bundle}"
}

Partner provides SDK for eSE

NFC

SDK

eSE

partner-sdk-ese-01

{
"appPackageName":"com.partner.wallet","appKey":"abcdefaei;fadaf=","refId":"virehgqerurt932m125215","provider":"SEC","deviceId":"0000000000000000","authcode":"43jkl6h3l4"
}

Partner provides SDK for USIM

NFC

SDK

SE-USIM

partner-sdk-usim-01

{
"appPackageName":"com.partner.wallet","appKey":"abcdefaei;fadaf=","refId":"virehgqerurt932m125215","provider":"KT","msisdn":"01012345678","deviceId":"0000000000000000","authcode":"43jkl6h3l4"
}

Partner provides credential that meet a specific protocol

NFC

MESSAGE

APP

partner-protocol-app-01

{
"publicKey":"{publicKey}","message":"{message}"
}

Partner provides credential that meet a specific protocol for eSE

NFC

MESSAGE

eSE

partner-protocol-ese-01

{
"accessKey":"abcdefg","publicKey":"{publicKey}","message":"{message}"
}

NFC feature using Message on APP

NFC

message

app

com.samsung.wallet.applet

{
"format":"ndef","publicKey":"{publicKey}","message":"{message}"
}

Barcode & QR Codes

Presentation Type and Formats

The barcode display type defines how a serial number, barcode, and/or QR code is shown.

Presentation Types (serialType)

Code name

Description

SERIALNUMBER

Serial Number

BARCODE

Barcode

QRCODE

QR code

Presentation Formats (ptFormat)

Code name

Description

BARCODE

Barcode only

BARCODESERIAL

Barcode with serial number

SERIAL

Serial number only

DUALSERIAL

Dual serial number

DUALBARCODE

Dual barcode

DUALBARCODESERIAL

Dual barcode for each serial numbers

BARCODEPIN

Barcode with PIN

QRCODE

QR code only

QRCODESERIAL

QR code with serial number

Barcode Formats (ptSubFormat)

Below are commonly used barcode formats, supported by the ZXing barcode scanning library.

Code name

Description

APIAZTEC

Aztec 2D barcode format

CODABAR

CODABAR 1D format

CODE_39

Code 39 1D format

CODE_93

Code 93 1D format

CODE_128

Code 128 1D format

DATA_MATRIX

Data Matrix 2D barcode format

EAN_8

EAN-8 1D format

EAN_13

EAN-13 1D format

ITF

ITF (Interleaved Two of Five) 1D format

MAXICODE

MaxiCode 2D barcode format

PDF_417

PDF417 format

QR_CODE

QR Code 2D barcode format

RSS_14

RSS 14

RSS_EXPANDED

RSS EXPANDED

UPC_A

UPC-A 1D format

UPC_E

UPC-E 1D format

UPC_EAN_EXTENSION

UPC/EAN extension format. Not a stand-alone format.