id cards also known as gift certificate, gift voucher or gift token links urls to get balance and transactions history in real time is provided in the partners portal if a partner needs to integrate communication between samsung wallet server and the partner’s server to support the feature, the partner has to set the links in partners portal wallet card type wallet card subtype giftcard others type value description attributes {fields} 1 title string 32 required main title e g , samsung gift card 2 eventid string 36 optional if full cancelation of the event occurs, find and process all gift cards with this id 3 orderid string 36 optional a unique identifier for an order 4 subtitle1 string 32 optional the auxiliary field which displays supporting information 5 logoimage string 256 optional logo image url to be displayed in the card item the file size should not exceed 256 kb 6 logoimage darkurl string 256 optional logo image url in dark mode the file size should not exceed 256 kb 7 logoimage lighturl string 256 optional logo image url in light mode the file size should not exceed 256 kb 8 providername string 32 required gift card provider name 9 user string 64 optional name of person who holds the gift card 10 preventcaptureyn string 1 optional flag whether this wallet card view prevents screen capture either 'y' or 'n', the default value is 'n' 11 startdate long 13 optional start date display start date epoch timestamp in milliseconds 12 enddate long 13 optional end date display end date epoch timestamp in milliseconds 13 locations string 1024 optional list of locations where the gift card can be used * see location format 14 noticedesc string 1024 optional text of the notice * long content is allowed * see additional information format 15 csinfo string 512 optional set value to json object call, email, website * see the example below 16 applinklogo string 256 required app link image url the file size should not exceed 256 kb 17 applinkname string 32 required app link name 18 applinkdata string 256 required information about the partner app link 19 bgimage string 256 optional url for card art background image 20 mainimg string 256 optional url for gift card image the file size should not exceed 512 kb 21 bgcolor string 8 optional color of the card art e g ,#00ffff 22 fontcolor string 8 optional color of the font on the card art acceptable values dark, light 23 blinkcolor string 8 optional color of the blinking effect which indicates that a card cannot be captured in the indicator area e g , #00ffff 24 barcode value string 4096 optional barcode data, serial number 25 barcode serialtype string 32 optional presentation type e g , serialnumber, barcode *see barcode format 26 barcode ptformat string 32 optional presentation format e g , barcode, qrcode, serial *see barcode format 27 barcode ptsubformat string 32 optional presentation sub-format e g , code_128, qr_code * see barcode format 28 barcode pin string 16 optional pin to show with a barcode 29 barcode errorcorrectionlevel string 4 optional amount of redundancy or error correction data included in the code there are four error correction levels available in qr codes * code options l/m/q/h 30 merchantid string 36 optional merchant identifier 31 merchantname string 32 optional merchant name to display 32 amount string 32 optional initial balance this is going to be shown as received e g , $1,000 33 balance string 32 optional remaining balance this is going to be shown as received e g , $1,000 34 summaryurl string 256 optional web url that show details, such as balance or transactions history example { "card" { "type" "giftcard", "subtype" "others", "data" [ { "refid" "b3fdc982-28c9-47a3-b02f-d484779698a7", "createdat" 1672574400000, "updatedat" 1672574400000, "language" "en", "attributes" { "title" "samsung gift card", "eventid" "event-001", "logoimage" "https //gpp walletsvc samsung com/mcs/images/contents/wallet_intro_logo png", "logoimage darkurl" "https //gpp walletsvc samsung com/mcs/images/contents/wallet_intro_logo png", "providername" "samsung gift card provider", "user" "ms jane doe", "noticedesc" "<ul><li>gift card test</li></ul>", "csinfo" "{\"call\" \"555 123-4567\", \"email\" \"cs@email com\", \"website\" \"https //homepage com/cs\"}", "applinklogo" "https //play-lh googleusercontent com/znfa1roz7hpv9j-jiacbjmjudl2x-fnuwte0oyvbbcwvf5vpzoqqikbxgk7d-aptvag=w240-h480-rw", "applinkname" "gift card link", "applinkdata" "https //www samsung com/", "bgcolor" "#0a1a4f", "fontcolor" "light", "blinkcolor" "#00ffff", "barcode value" "cs16138353212584806754fg1802", "barcode serialtype" "qrcode", "barcode ptformat" "qrcodeserial", "barcode ptsubformat" "qr_code" } } ] } } loyalty 'loyalty' cards support enrolling loyalty cards also known as membership links urls to get points in real time can be provided in the partners portal if a partner needs to integrate communication between samsung wallet server and the partner’s server to support the feature, the partner has to set the links in the partners portal wallet card type wallet card subtype loyalty others type value description attributes {fields} 1 title string 32 required main title e g ,samsung loyalty card 2 eventid string 36 optional if full cancelation of the event occurs, find and process all loyalty cards with this id 3 groupingid string 36 optional identifier used to group related cards 4 orderid string 36 optional a unique identifier for an order 5 mainimg string 256 optional url for main loyalty card image the file size should not exceed 512 kb 6 subtitle1 string 32 optional the auxiliary field which displays supporting information 7 logoimage string 256 optional logo image url to be displayed in the card item the file size should not exceed 256 kb 8 logoimage darkurl string 256 optional logo image url in dark mode the file size should not exceed 256 kb 9 logoimage lighturl string 256 optional logo image url in light mode the file size should not exceed 256 kb 10 providername string 32 required loyalty card provider name 11 preventcaptureyn string 1 optional flag whether this wallet card view prevents screen capture either 'y' or 'n', the default value is 'n' 12 startdate long 13 optional start date display start date epoch timestamp in milliseconds 13 enddate long 13 optional end date display end date epoch timestamp in milliseconds 14 locations string 1024 optional list of locations where the card can be used * see location format 15 noticedesc string 1024 optional text of the notice * long content is allowed * see additional information format 16 csinfo string 512 optional set value to json object call, email, website or social media which supports facebook, pinterest, x twitter and instagram * see the example below 17 applinklogo string 256 required app link image url the file size should not exceed 256 kb 18 applinkname string 32 required app link name 19 applinkdata string 256 required information about the partner app link 20 bgimage string 256 optional background image for a card art 21 bgcolor string 8 optional color of the card art e g , #00ffff 22 fontcolor string 8 optional color of the font on the card art acceptable values dark, light 23 blinkcolor string 8 optional color of the blinking effect which indicates that a card cannot be captured in the indicator area e g , #00ffff 24 barcode value string 4096 optional barcode data, serial number 25 barcode serialtype string 32 optional presentation type e g , serialnumber, barcode * see barcode format 26 barcode ptformat string 32 optional presentation format e g , barcode, qrcode, serial * see barcode format 27 barcode ptsubformat string 32 optional presentation sub-format e g , code_128, qr_code *see barcode format 28 barcode errorcorrectionlevel string 4 optional amount of redundancy or error correction data included in the code there are four error correction levels available in qr codes * code options l/m/q/h 29 merchantid string 36 optional merchant identifier 30 merchantname string 32 optional merchant name to display 31 amount string 32 optional total amount of points or initial balance this is going to be shown as received it is recommended to use a one letter currency symbol e g , $ 1,000, 1,000p 32 balance string 32 optional available points or remaining balance this is going to be shown as received it is recommended to use a one letter currency symbol e g , $ 1,000, 1,000p 33 summaryurl string 256 optional webpage url that shows details, such as balance or transactions history example { "card" { "type" "loyalty", "subtype" "others", "data" [{ "refid" "b3fdc982-28c9-47a3-b02f-d484779698a8", "createdat" 1672574400000, "updatedat" 1672574400000, "language" "en", "attributes" { "title" "samsung loyalty card", "eventid" "event-001", "logoimage" "https //gpp walletsvc samsung com/mcs/images/contents/wallet_intro_logo png", "logoimage darkurl" "https //gpp walletsvc samsung com/mcs/images/contents/wallet_intro_logo png", "providername" "samsung loyalty card provider", "noticedesc" "<ul><li>loyalty card test</li></ul>", "csinfo" "{\"call\" \"555 123-4567\", \"email\" \"cs@email com\", \"website\" \"https //homepage com/cs\"}", "applinklogo" "https //play-lh googleusercontent com/znfa1roz7hpv9j-jiacbjmjudl2x-fnuwte0oyvbbcwvf5vpzoqqikbxgk7d-aptvag=w240-h480-rw", "applinkname" "loyalty card link", "applinkdata" "https //www samsung com/", "bgcolor" "#0a1a4f", "barcode value" "cs16138353212584806754fg1802", "barcode serialtype" "qrcode", "barcode ptformat" "qrcodeserial", "barcode ptsubformat" "qr_code", "amount" "1,000p", "balance" "500p" } } ] } } id card 'id card' cards are used to present identification for employees, students, drivers, guests, etc wallet card type wallet card subtype idcard employees, nationals, students, drivers, guests, others type value description attributes {fields} 1 title string 32 required main title of cardse g , commercial access, employee badge 2 holdername string 64 required name of card holders 3 secondholdername string 64 optional second name of card holders 4 organization string 64 optional organization of card holders belongingi e , name of department, division, affiliation, association or team 5 position string 64 optional position of card holders 6 identifier string 64 required unique id value 7 idnumber string 64 optional representative value for an idi e , id number, document number 8 address string 256 optional address of card holders 9 placeoflocation string 64 optional place of location associated with the cardholder 10 idphoto string 128k optional holder’s photo image data encoded base64the file size should not be greater than 128 kb 11 idphoto format string 32 optional image file formate g , jpeg, png* unsupported image formats may exist 12 idphoto status string 16 optional status of the dataallowed value unchanged 13 document string 1024k optional first document of identity 14 document format string 32 optional document format- allowed value pdf, jpeg, png 15 document status string 16 optional status of the dataallowed value unchanged 16 provisioningtype string 16 optional a value indicating how to provision content that affects card featuresallowed value sdk, ese, usim, token 17 provisioningfactor string 512 optional elements to complete provisioning 18 issuedate long 13 required issue date epoch timestamp in milliseconds 19 birthdate string 16 optional date of birth 20 gender string 16 optional gender of card holders 21 classification string 16 optional classified identity type 22 expiry long 13 optional expiry date in timestamp format issued data is cleaned up after it expires epoch timestamp in milliseconds 23 contacts string 32 optional personal contact information such as phone number 24 uiccid string 32 optional universal ic card id * deprecated 25 logoimage string 256 optional logo image url to be displayed in card item the file size should not exceed 256 kb 26 logoimage darkurl string 256 optional logo image url in dark mode the file size should not exceed 256 kb* if this value does not exist, logoimage will be substituted 27 logoimage lighturl string 256 optional logo image url in light mode the file size should not exceed 256 kb* if this value does not exist, logoimage will be substituted 28 logotext string 16 optional text as an alternative to logoimage 29 providername string 32 required content provider name 30 issuername string 32 optional place of issue or issuing authority name 31 extrainfo string 512 optional additional information* see additional information format 32 noticedesc string 1024 optional text of the notice * long content is allowed * see additional information format 33 csinfo string 512 required set value to json object call, email, website * see the example below 34 privacymodeyn string 1 optional whether or not to require user authentication when using the card either ‘y’ or ‘n’* default ‘n’ 35 applinklogo string 256 optional app link image url the file size should not exceed 256 kb 36 applinkname string 32 optional app link name 37 applinkdata string 256 optional information about the partner app link 38 locations string 1024 optional list of locations where the card can be used* see location format 39 coverimage string 256 optional card cover image url the file size should not exceed 512 kb 40 bgimage string 256 optional card background image url the file size should not exceed 512 kb 41 bgcolor string 8 optional color of the card art support hex color code e g , #015aaa 42 fontcolor string 8 optional color of the font on the card art allowed value black, white 43 blinkcolor string 8 optional color of the blinking effect in the indicator area support hex color code e g , #015aaa 44 preventcaptureyn string 1 optional flag whether this wallet card view prevents screen capture either 'y' or 'n' * default 'n' 45 barcode value string 4096 optional barcode data, serial number 46 barcode serialtype string 32 optional presentation type e g , serialnumber, barcode, * see barcode format 47 barcode ptformat string 32 optional presentation format e g , barcode, qrcode, serial, * see barcode format 48 barcode ptsubformat string 32 optional presentation sub-format e g , code_128, qr_code, * see barcode format 49 barcode errorcorrectionlevel string 4 optional amount of redundancy or error correction data included in the code there are four error correction levels available in qr codes - code options l/m/q/h * default l 50 barcode interval string 4 optional update interval if support for dynamic updates epoch timestamp in milliseconds example * employee id card { "card" { "type" "idcard", "subtype" "employees", "data" [{ "refid" "20000130003", "createdat" 1658385817000, "updatedat" 1658385817000, "language" "en", "attributes" { "title" "employee id card", "holdername" "kim samsung", "secondholdername" " samsung ", "organization" "digital wallet, mx", "position" "professional", "identifier" "2306070003", "idphoto" "{base64 encoded image data}", "idphoto format" "jpeg", "issuedate" "1658385817000", "expiry" "1765855665000", "logoimage" "https // /logo png", "providername" "mobile id", "extrainfo" “{\"count\" 1,\"info\" [{\"title\" \"shortcode\",\"content\" [\"404457\"]}]} ", "noticedesc" "{\"count\" 2,\"info\" [{\"title\" \"notice1\",\"content\" [\"description1\",\"description2\"]},{\"title\" \"notice2\",\"content\" [\"description1\",\"description2\"]}]}", "csinfo" "{\"call\" \"555 123-4567\", \"email\" \"cs@email com\", \"website\" \"https //homepage com/cs\"}", "applinkname" "mobile id one", "applinklogo" "https // /applinklogo png", "applinkdata" "https //www applinkorweblink com", "coverimage" "https // /card/cover png", "bgimage" "https // /card/background png", "fontcolor" "#000000" }, "localization" [{ "language" "ko", "attributes" { "title" "사원증", "holdername" "김삼성", "secondholdername" "kim samsung", "providername" "모바일 아이디", "extrainfo" "{\"count\" 1,\"info\" [{\"title\" \"접근 권한\",\"content\" [\"지역1\",\"지역2\"]}]}" } }] }] } } * national id card { "card" { "type" "idcard", "subtype" "nationals", "data" [{ "refid" "identitycard-bpo1r3e5-3313-0991-z404-sq12994414u8", "createdat" 1658385817000, "updatedat" 1658385817000, "language" "en", "attributes" { "title" "national id card", "holdername" "kim samsung", "secondholdername" " samsung ", "organization" "digital wallet, mx", "position" "professional", "identifier" "2306070003", "idphoto" "{base64 encoded image data}", "idphoto format" "jpeg", "document" "{base64 encoded pdf data}", "document format" "pdf", "issuedate" "1658385817000", "expiry" "1765855665000", "logoimage" "https // /logo png", "provisioningtype" "token", "provisioningfactor" "eyjhbgcioijiuzi1niisinr5cci6ikpxvcj9 eyjzdwiioiixmjm0nty3odkwiiwibmftzsi6ikpvag4grg9liiwiawf0ijoxnte2mjm5mdiyfq sflkxwrjsmekkf2qt4fwpmejf36pok6yjv_adqssw5c", "providername" "samsung electronics", "extrainfo" "{\"count\" 1,\"info\" [{\"title\" \"shortcode\",\"content\" [\"404457\"]}]}", "noticedesc" "{\"count\" 2,\"info\" [{\"title\" \"notice1\",\"content\" [\"description1\",\"description2\"]},{\"title\" \"notice2\",\"content\" [\"description1\",\"description2\"]}]}", "csinfo" "{\"call\" \"555 123-4567\", \"email\" \"cs@email com\", \"website\" \"https //homepage com/cs\"}", "applinkname" "samsung electronics", "applinklogo" "https // /applinklogo png", "applinkdata" "https //www applinkorweblink com", "coverimage" "https // /card/cover png", "bgimage" "https // /card/background png", "fontcolor" "#000000", "barcode value" "5728306720836720763017601", "barcode serialtype" "qrcode", "barcode ptformat" "qrcode", "barcode ptsubformat" "qr_code", "barcode interval" "300000" }, "localization" [{ "language" "ko", "attributes" { "title" "신분증", "holdername" "김삼성", "secondholdername" "kim samsung", "providername" "삼성전자" } }] }] } } generic card 'generic card' is defined for registering various forms of cards that aren't defined as other types partners can customize the items on the generic card to display by connecting them with card data wallet card type wallet card subtype generic others type value description attributes {fields} 1 title string 32 required main title 2 subtitle string 32 optional the auxiliary field which displays supporting information 3 providername string 32 required provider name 4 eventid string 32 optional event identifier 5 groupingid string 32 optional identifier used to group related cards 6 startdate long 13 required start date display start date epoch timestamp in milliseconds 7 startdate relativenotitime string 4 optional the relative time from startdate in minutes to provide a notification to the usere g , 5, 10, 15, 30, 60, and up to 2880 8 enddate long 13 optional end date display end date epoch timestamp in milliseconds 9 enddate relativenotitime string 4 optional the relative time from enddate in minutes to provide a notification to the usere g , 5, 10, 15, 30, 60, and up to 2880 10 mainimg string 256 required url for main image the file size should not exceed 512 kb 11 logoimage string 256 optional logo image url to be displayed in card item the file size should not exceed 256 kb 12 logoimage darkurl string 256 optional logo image url in dark mode the file size should not exceed 256 kb* if this value does not exist, logoimage will be substituted 13 logoimage lighturl string 256 optional logo image url in light modethe file size should not exceed 256 kb* if this value does not exist, logoimage will be substituted 14 coverimage string 256 optional card cover image urlthe file size should not exceed 512 kb 15 bgimage string 256 optional card background image urlthe file size should not exceed 512 kb 16 text{i} string 64 optional text item i 1~15 17 image{i} string 128k optional image item i 1~5 18 image{i} lighturl string 256 optional image item in light mode 19 image{i} darkurl string 256 optional image item in dark mode 20 image{i} status string 16 optional image item status 21 timestamp{i} long 13 optional timestamp item i 1~5 22 timestamp{i} utcoffset string 8 optional utc offset of timestamp 23 serial{i} string 4096 optional serial item i 1~2 24 serial{i} serialtype string 32 optional presentation typee g , serialnumber, barcode, * see barcode format 25 serial{i} ptformat string 32 optional presentation formate g , barcode, qrcode, serial, * see barcode format 26 serial{i} ptsubformat string 32 optional presentation sub-formate g , code_128, qr_code, * see barcode format 27 serial{i} errorcorrectionlevel string 4 optional amount of redundancy or error correction data included in the code there are four error correction levels available in qr codes - code options l/m/q/h 28 noticedesc string 1024 required notice description * long content is allowed * see additional information format 29 csinfo string 512 optional cs informationset value to json object calls or emails or websites * see below for an example 30 providerviewlink string 512 optional link to additional information from the provider* see links format 31 privacymodeyn string 1 optional whether or not to require user authentication when using the cardeither ‘y’ or ‘n’* default ‘n’ 32 bgcolor string 8 optional color of the card art e g , #00ffff 33 fontcolor string 8 optional color of the font on the card art acceptable values dark, light 34 blinkcolor string 8 optional color of the blinking effect in the indicator areae g , #00ffff 35 preventcaptureyn string 1 optional flag whether this wallet card view prevents screen capture either 'y' or 'n'* default 'n' 36 nonetworksupportyn string 1 optional sets whether to support to open the wallet card under 'no network' status either 'y' or 'n'* default 'n' 37 applinklogo string 256 required app link image url the file size should not exceed 256 kb 38 applinkname string 32 required app link name 39 applinkdata string 256 required information about the partner app link 40 locations string 1024 optional list of locations where the card can be used * see location format example { "card" { "type" "generic", "subtype" "others", "data" [{ "createdat" 1661745824345, "updatedat" 1661745824345, "language" "en", "refid" "refid-012345", "attributes" { "title" "samsung generic card", "subtitle" "personal members", "providername" "samsung", "startdate" 1661751274000, "startdate utcoffset" "utc+9", "enddate" 1761778000000, "enddate utcoffset" "utc+9", "enddate relativenotitime" "1440", "text1" "13047623", "text2" "silver", "text3" "suwon station branch", "text4" "031 000-1235", "timestamp1" 1761751274000, "timestamp1 utcoffset" "utc+9", "mainimg" "https //www samsung com/images/main png", "image1" "https //www samsung com/images/image1 png", "image1 darkurl" "https //www samsung com/images/dark png", "image1 lighturl" "https //www samsung com/images/light png", "serial1 value" ">1180mm2241b7c 0000000000000298060000000000 0 090870907 ", "serial1 serialtype" "qrcode", "serial1 ptformat" "qrcode", "serial1 ptsubformat" "qr_code", "bgcolor" "#ff5000", "fontcolor" "light", "noticedesc" "{\"count\" 2,\"info\" [{\"title\" \"notice1\",\"content\" [\"description1\",\"description2\"]},{\"title\" \"notice2\",\"content\" [\"description1\",\"description2\"]}]}", "csinfo" "{\"calls\" [{\"emergency\" \"555 123-4567\"},{\"customer service\" \"555 123-9876\"}],\"emails\" [{\"cs team\" \"cs@atwsample com\"}],\"websites\" [{\"faq\" \"https //atwhomepage com/faq\"},{\"support\" \"https //atwhomepage com/support\"}]}", "providerviewlink" "{\"count\" 1,\"info\" [{\"link\" \"https //samsung external info link/refid-012345\",\"type\" \"web\",\"text\" \"see more information\"}]}", "applinkdata" "https //www samsung com/", "applinklogo" "https //www samsung com/logo png", "applinkname" "samsung" }, "localization" [{ "language" "ko", "attributes" { "title" "삼성 제네릭 카드", "subtitle" "개인 멤버스", "providername" "삼성", "text2" "실버 등급", "text3" "수원역점" } }] }] } }