API Guidelines
add to samsung wallet" link is used when additional card registration associated with this wallet card is provided * this is a required field, especially when the state is "migrated" data[] oldrefidstring 128 conditional if a new refid is provided, it specifies the value of the associated previous refid * this is a required field, especially when the state is "migrated" data[] fields string 128 optional wallet cards attributes which has been updated can be specified using commas , as separators it is used when 'data[] state' is updated e g balance,barcode value* supported wallet card types generic [example] post /wltex/cards/12584806754/notification [headers] authorization {jwt auth token} x-smcs-partner-id partner-id-0001 x-request-id req-202303140003 [payload] [case 1 in general cases] { "card" { "type" "ticket", "data" [ { "refid" "ref-ticket-0001", "state" "updated" } ] } } [case 2 in case of deletion] { "card" { "type" "boardingpass", "data" [ { "refid" "ref-boardingpass-0001", "state" "deleted" } ] } } [case 3 when a specific field is updated] { "card" { "type" "idcard", "data" [ { "refid" "ref-idcard-0001", "state" "updated", "fields" "balance" } ] } } [case 4 the card is migrated] { "card" { "type" "idcard", "data" [ { "refid" "bjd8w6reda", "state" "migrated", "oldrefid" "dg76s8dfewr", "atwlink" "{atw link with the new refid}" } ] } } [response] type value description http status 200 ok204 no content payload n/a example 200 ok [result] http status code description 200 ok success 204 no content card doesn’t exist 400 bad request requests cannot or will not be processed the request due to something that is perceived to be a client error 401 unauthorized authorization token is invalid or expired 500 internal server error server encountered an unexpected condition that prevented it from fulfilling the request 503 service unavailable server is not ready to handle the request batch update notification updating multiple contents by sending batch update to samsung server [request] type value description method post url {cc2}/wltex/cards/{cardid}/batch/updates headers authorization string 1024 required credential token the token can have prefix "bearer" as an authorization type, e g , bearer <credentials> * see rest api authorization token jwt / jws x-smcs-partner-id string 32 required partner id x-request-id string 32 required request identifier randomly generated uuid string path parameters cardid string 2 required wallet card identifier granted from partner portal payload cardobject required wallet card object card typestring 16 required wallet card type *see wallet cards card data[]array of object required wallet card data container data[] eventidstring 32 required a unique event identifier defined by the content provider data[] statestring 16 optional wallet card statee g , active, updated, expired, redeemed, held, deleted, suspended * see card states for details [example] post /wltex/cards/12584806754/batch/notification [headers] authorization {jwt auth token} x-smcs-partner-id partner-id-0001 x-request-id req-202303140003 [payload] case 1 in general cases { "card" { "type" "ticket", "data" [ { "eventid" "event-0001", "state" "updated" } ] } } case 2 in case of deletion { "card" { "type" "boardingpass", "data" [ { " eventid " " event-0001", "state" "deleted" } ] } } [response] type value description http status 200 ok204 no content payload n/a example 200 ok [result] http status code description 200 ok success 204 no content card doesn’t exist 400 bad request requests cannot or will not be processed the request due to something that is perceived to be a client error 401 unauthorized authorization token is invalid or expired 500 internal server error server encountered an unexpected condition that prevented it from fulfilling the request 503 service unavailable server is not ready to handle the request cancel notification allows partners to inform samsung wallet when a card such as for performances, sports, movies, or journeys needs to be cancelled when a cancellation occurs, this api enables partners to set the related card s to an expired status this ensures that users no longer have valid access to events or services that have been cancelled, such as a concert, flight, or movie screening [request] type value description method post url {cc2}/wltex/cards/{cardid}/cancels headers authorization string 1024 required credential token the token can have prefix "bearer" as an authorization type, e g , bearer <credentials> *see rest api authorization token jwt / jws x-smcs-partner-id string 32 required partner id x-request-id string 32 required request identifier randomly generated uuid string path parameters cc2 string 2 conditional country code cc2 from send card state * required if using public domain cardid string 32 required wallet card identifier granted from the partners portal payload card object required wallet card object card type string 16 required wallet card type * see wallet cards card data[] array of object required wallet card data container data[] eventid string 32 conditional required if card type has been set as ‘ticket’ data[] vehicle number string 32 conditional required if "card type" has been set as "boardingpass" data[] estimated oractualstartdate long 13 data[] state string 16 required wallet card state e g , canceled* see card states for details [example] post /wltex/cards/12584806754/notification [headers] authorization eyjjdhkioijuvrlliwidmvyijoxlcjwyxj0bmvyswqioiixmjg1o x-smcs-partner-id partner-id-0001 x-request-id req-202303140003 [payload] * a movie ticket has been canceled { "card" { "type" "ticket", "data" [ { "refid" "event-722164a1a7", "state" "canceled" } ] } } [response] type value description http status 200 ok payload n/a example 200 ok [result] http status code description 200 ok success 204 no content card doesn’t exist 400 bad request requests cannot or will not be processed the request due to something that is perceived to be a client error 401 unauthorized authorization token is invalid or expired 500 internal server error server encountered an unexpected condition that prevented it from fulfilling the request 503 service unavailable server is not ready to handle the request get reference ids partners can call this api to get basic information regarding card refids based on the eventid this api will require the eventid attribute in each card type also, the filter option must be enabled for the eventid attribute in order for this api to work [request] type value description method post url wltex/cards/{cardid}?eventid={eventid}&type={type} headers authorizationstring 1024 required credential token the token can have prefix "bearer" as an authorization type e g , bearer <credentials>* see rest api authorization token jwt / jws x-smcs-cc2string 2 required country code cc2 x-request-idstring 32 required request identifier randomly generated uuid string path parameters cardidstring 32 required wallet card identifier granted from partner portal query parameter eventidstring 32 required event id typestring 32 required type of card boardingpass, ticket, coupon, etc payload n/a [example] get /wltex/cards/12584806754?eventid=testing&type=boardingpass [headers] authorization {jwt auth token} x-request-id req-202303140004 x-smcs-cc2 us [response] type value description http status 200 ok payload countstring required number of refids refidsstring array required list of reference ids [example] "count" “1”, “refids” [“12345”] [result] http status code description 200 ok success 400 bad request requests cannot or will not be processed the request due to something that is perceived to be a client error 401 unauthorized authorization token is invalid or expired 500 internal server error server encountered an unexpected condition that prevented it from fulfilling the request 503 service unavailable server is not ready to handle the request