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

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


Card Data Format

Key

 Description
provision.data
String

 (Required)
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.dynamicYn
String

 (Optional)
This value is set when dynamically refreshing provision.data. With the "interval" item, you can set the validity period of the data.
* This value can be specified when configuring the wallet card in the partner portal, but the value transmitted as card data takes precedence.
provision.interval
String

 (Conditional)
The valid time of provision.data. Once this time has elapsed, provision.data is updated. (Unit: Seconds)
* This value can be specified when configuring the wallet card in the partner portal, but the value transmitted as card data takes precedence.

Data Sample

Key

 Description
provision.data
String

 (Optional)
The parent object where this object is defined: Card data from Wallet Cards & Attributes
* JSON format must be converted to escape string.

The following provisionData structure is provided as an example only. Actual field definitions and usage must be determined through coordination with the Samsung Wallet team. These fields are for reference purposes only and should not be used without prior agreement. The structure and contents of provisionData may vary depending on implementation requirements and must be finalized through mutual discussion.

Provision Data

Key

 Description
Message
String

 (Required)
The data to be provisioned to the card. This may contain plaintext, signed, or encrypted content depending on the messageType.
messageEncoding
String

 (Optional)
Specifies the encoding format of the message. Common values are "hex", "base64", or "utf-8".
keyInfo
Object

 (Optional)
Key information object
keyInfo.type
String

 (Optional)
Defines the kind of key material being provided. It must be either "public_key" or "certificate", depending on what the client is sending.
keyInfo.data
String

 (Required)
Contains the actual key content. This can either be a Base64-encoded public key or a full X.509 certificate string in PEM format, depending on the specified type.
keyInfo.algorithm
String

 (Required)
Specifies the cryptographic algorithm associated with the key. Only the Elliptic Curve (EC) algorithm is supported, and this field must be set to "EC".
keyInfo.encodingFormat
String

 (Optional)
Indicates the encoding format used for the key data. Typical values are "base64", "pem", or "der", which help the server parse and process the data correctly.

[JSON Format example]

{
    "message": "4E46432053616D73756E672057616C6C6574",
    "messageEncoding": "hex",
    "keyInfo": {
        "type": "public_key",
        "data": "MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE...",
        "algorithm": "EC",
        "encodingFormat": "base64"
    }
}

[Actual data (escaped) example]]

"provision.data": "{\"message\":\"4E46432053616D73756E672057616C6C6574\",\"messageType\":\"plaintext\",\"messageEncoding\":\"hex\",\"keyInfo\":{\"type\":\"public_key\",\"data\":\"MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE...\",\"algorithm\":\"EC\",\"encodingFormat\":\"base64\"}}"

Barcode & QR Codes

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

Card Data Format


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
SHIPPING

 Shipping (Online use only)
CALLORDER

 Call Order (Online use only)
URL

 URL Serial (Online use only)

[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
AZTEC

 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

Data Sample


Case

 Data set
1D barcode with serial as UPC-A type

 "barcode.value": "www.samsung.com",
"barcode.serialType": "BARCODE",
"barcode.ptFormat": "BARCODESERIAL",
"barcode.ptSubFormat": "UPC_A"
2D barcode as QR code type

 ""barcode.value": "www.samsung.com",
"barcode.serialType": " QRCODE",
"barcode.ptFormat": "QRCODE",
"barcode.ptSubFormat": "QR_CODE"
2D barcode as AZTEC type which has 300 seconds valid time (Dynamic QR)

 "barcode.value": "www.samsung.com",
"barcode.serialType": " QRCODE",
"barcode.ptFormat": "QRCODE",
"barcode.ptSubFormat": "AZTEC",
"barcode.interval":"300"
Serial number

 "barcode.value": "1234567890",
"barcode.serialType": "SERIALNUMBER",
"barcode.ptFormat": "SERIAL"