Advances Features
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 nameex 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 note before using this item, see the provisioning type under 'advanced settings' in the wallet card settings created in the partner portal it is mandatory to configure cards according to their purpose and method the data format corresponding to provision data should include items agreed upon in advance please contact technical support to inquire about the method of providing access functions the json string needs to be delivered as an escaped string card data format key description provision datastring 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 dynamicynstring 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 datastring 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 messagestring required the data to be provisioned to the card this may contain plaintext, signed, or encrypted content depending on the messagetype messageencodingstring optional specifies the encoding format of the message common values are "hex", "base64", or "utf-8" keyinfoobject optional key information object keyinfo typestring 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 datastring 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 algorithmstring 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 encodingformatstring 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 note to enable dynamic qr functionality, please refer to the wallet card settings in the partner portal 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 see also https //zxing github io/zxing/apidocs/com/google/zxing/barcodeformat html 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 note the json string needs to be delivered as a escaped string 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"