Boarding Pass
boarding pass' cards support one-off transit types such as airlines, trains, buses, ferries, and etc boarding passes in wallet can remind the user of boarding time and help during check-in depending on the integration level, it can provide status information updates related to flights, and journeys, such as boarding gate changes or cancellations wallet card type wallet card type wallet card subtype boardingpass airlines, trains, buses, others airlines buses trains wallet card data fields attributes type value description attributes {fields} titlestring 32 required main title e g , 'boarding pass' transittypestring 16 optional transit type * this will be deprecated groupingidstring 32 optional identifier used to group related cards orderidstring 32 optional unique identifier for an order providerlogostring 256 required url of the logo image the file size should not exceed than 256 kb providerlogo darkurlstring 256 required url of the logo image in dark mode the file size should not exceed 256 kb providerlogo lighturlstring 256 required url of the logo image in light mode the file size should not exceed 256 kb providernamestring 32 required display name of the boarding pass provider userstring 64 conditional passenger name * required if subtype is airlines usertypestring 32 optional passenger type i e , classification of passengers, like child, adult transitoperatorstring 64 optional operator name vehiclenumberstring 32 conditional transit or route number i e , flight number on airlines * required if subtype is airlines transitclassstring 32 optional transit class i e , premium class for buses transitfarestring 32 optional general fare or purchase fare coachnumberstring 16 optional identifier assigned to each individual carriage e g , b4 seatclassstring 32 conditional seat class * required if subtype is airlines seatnumberstring 16 required individual number of the passenger seat e g , a-9, free seatfacingstring 16 optional direction in which the seat is oriented within a carriage it indicates whether the seat is positioned to face the direction of travel or face the opposite direction e g , forward, backward reservationnumberstring 32 required number of the transit reservation boardingprioritystring 32 optional information on whether entitles the passenger to board before others i e , if the passengers are pregnant boardingseqnostring 32 optional boarding sequence number boardinggroupstring 8 optional value of boarding group or zone e g , b boardingtimelong 13 optional boarding time epoch timestamp in milliseconds boardingtime utcoffsetstring 8 conditional utc offset of boarding time at the departure point * required if boardingtime exist gateclosingtimelong 13 optional boarding gate closing time epoch timestamp in milliseconds gateclosingtime utcoffsetstring 8 conditional utc offset of gate closing time at the departure point * required if gateclosingtime exist baggageallowancestring 16 optional baggage allowance departnamestring 32 conditional name of the departure point * required if subtype is airlines departcodestring 8 conditional code for the departure point * required if subtype is airlines departterminalstring 8 conditional terminal name of the departure point * required if subtype is airlines departgatestring 8 optional gate name of the departure point estimatedoractualstartdatelong 13 conditional departure time epoch timestamp in milliseconds, i e , the estimated time the aircraft plans to pull from the gate, or the actual time the aircraft already pulled from the gate * required if subtype is airlines estimatedoractualstartdate utcoffsetstring 8 conditional utc offset of time at the departure point * required if estimatedoractualstartdate exists arrivenamestring 32 conditional name of the arrival point * required if subtype is airlines arrivecodestring 8 conditional code for the arrival point * required if subtype is airlines arriveterminalstring 8 optional terminal name of the arrival point arrivegatestring 8 optional gate name of the arrival point estimatedoractualenddatelong 13 conditional arrival time epoch timestamp in milliseconds, i e , the estimated time the aircraft plans to reach the destination gate not the runway , or the actual time it reached the gate * required if subtype is airlines estimatedoractualenddate utcoffsetstring 8 conditional utc offset of time at the arrival point * required if estimatedoractualenddate exists locationsstring 1024 optional list of locations where the card can be used * see location format bgcolorstring 8 required color of the card art e g , #00ffff fontcolorstring 8 optional color of the font on the card art acceptable values dark, light blinkcolorstring 8 optional color of the blinking effect which indicates that a card cannot be captured in the indicator area e g , #00ffff applinklogostring 256 required app link image url the file size should not exceed 256 kb applinknamestring 32 required app link name applinkdatastring 256 required information about the partner app link extrainfostring 512 optional additional information to be delivered to customers * see additional information format noticedescstring 5000 optional text of the notice * long content is allowed * see additional information format csinfostring 512 optional providers’ customer service informationusing data in json format converted to escape string* allowed items call, email, or website* see below for an example displaytsaprecheckynstring 1 optional flag whether to display the tsa precheck image either ‘y’ or ‘n’ image size 68x20 / 140x20 membershipstatuslevelstring 256 optional image url for the status level of the airline alliance or own membership i e , airline skyteam, star alliance image size 68x20 / 140x20 barcode valuestring 4096 optional actual data that is delivered when the barcode/qr code is scanned barcode serialtypestring 32 optional presentation type e g , serialnumber, barcode, * see barcode format barcode ptformatstring 32 optional presentation format e g , barcode, qrcode, serial, *see barcode format barcode ptsubformatstring 32 optional presentation sub-format e g , code_128, qr_code, * see barcode format barcode errorcorrectionlevelstring 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 example airline boarding pass { "card" { "type" "boardingpass", "subtype" "airlines", "data" [ { "refid" "se16138353212584800001", "createdat" 1612660039000, "updatedat" 1612660039000, "language" "en", "attributes" { "title" "oo air boarding pass", "transittype" "airline", "groupingid" "se867132687321", "providerlogo" "https // /logoimage png", "providerlogo darkurl" "https // /logoimage png", "providername" "oo air", "user" "gil dong hong", "vehiclenumber" "se123", "seatclass" "economy plus", "seatnumber" "a15", "reservationnumber" "a238473-1", "boardingseqno" "32", "boardingtime" 1612660039000, "boardingtime utcoffset" "utc+09 00", "baggageallowance" "15kg", "departname" "seoul/incheon", "departcode" "inc", "departterminal" "c", "departgate" "1", "estimatedoractualstartdate" 1612660039000, "estimatedoractualstartdate utcoffset" "utc+09 00", "arrivename" "san francisco", "arrivecode" "sfo", "arriveterminal" "a", "arrivegate" "11", "estimatedoractualenddate" 1612660039000, "estimatedoractualenddate utcoffset" "utc-08 00", "bgcolor" "#ff00ff", "fontcolor" "dark", "applinklogo" "https // /applinklogo png", "applinkname" "oo airline", "applinkdata" "https //www ooairline com", "csinfo" "{\"call\" \"0000-0000\",\"email\" \"samsungwallet@samsungwallet com\",\"website\" \"https //www samsungwallet com/cs/\"}", "barcode value" "cs16138353212584806754fg1802", "barcode serialtype" "barcode", "barcode ptformat" "qrcodeserial", "barcode ptsubformat" "qr_code" }, "localization" [ { "language" "ko", "attributes" { "title" "oo 항공 탑승권", "providername" "oo 항공", "user" "홍 길동" } } ] } ] } } grouped bus boarding passes { "card" { "type" "boardingpass", "subtype" "buses", "data" [ { "refid" "ref-202211300001", "createdat" 1669782394000, "updatedat" 1669782394000, "language" "en", "attributes" { "title" "samsung bus boarding pass", "transittype" "bus", "groupingid" "grp-20221130001", "providerlogo" "https // /logoimage png", "providerlogo darkurl" "https // /logoimagedark png", "providername" "samsung bus", "user" "galaxy kim", "usertype" "adult", "transitoperator" "samsung transport co ", "seatnumber" "7-a", "reservationnumber" "rsvno-202211300001", "transitclass" "premium", "transitfare" "12,500 won", "boardingtime" 1671926400000, "boardingtime utcoffset" "utc+09 00", "departname" "east-seoul bus terminal", "departgate" "14", "estimatedoractualstartdate" 1671928200000, "estimatedoractualstartdate utcoffset" "utc+09 00", "arrivename" "suwon bus terminal", "bgcolor" "#f1c232", "fontcolor" "dark", "applinklogo" "https // /applinklogo png", "applinkname" "samsung bus", "applinkdata" "https //www samsung-bus com", "csinfo" "{\"call\" \"0000-0000\",\"email\" \"samsungwallet@samsungwallet com\",\"website\" \"https //www samsungwallet com/cs/\"}", "barcode value" "161383532125848067541802", "barcode serialtype" "barcode", "barcode ptformat" "qrcodeserial", "barcode ptsubformat" "qr_code" }, "localization" [ { "language" "ko", "attributes" { "title" "삼성버스 탑승권", "providername" "삼성버스", "user" "김 은하", "transitfare" "12,500 원" } } ] }, { "refid" "ref-202211300002", "createdat" 1669782394000, "updatedat" 1669782394000, "language" "en", "attributes" { "title" "samsung bus boarding pass", "transittype" "bus", "groupingid" "grp-20221130001", "providerlogo" "https // /logoimage png", "providerlogo darkurl" "https // /logoimagedark png", "providername" "samsung bus", "user" "samsung sam", "usertype" "child", "transitoperator" "samsung transport co ", "seatnumber" "7-b", "reservationnumber" "rsvno-202211300002", "transitclass" "preminum", "transitfare" "9,000 won", "boardingtime" 1671926400000, "boardingtime utcoffset" "utc+09 00", "departname" "east-seoul bus terminal", "departgate" "14", "estimatedoractualstartdate" 1671928200000, "estimatedoractualstartdate utcoffset" "utc+09 00", "arrivename" "suwon bus terminal", "bgcolor" "#f1c232", "fontcolor" "#000000", "applinklogo" "https // /applinklogo png", "applinkname" "samsung bus", "applinkdata" "https //www samsung-bus com", "csinfo" "{\"call\" \"0000-0000\",\"email\" \"samsungwallet@samsungwallet com\",\"website\" \"https //www samsungwallet com/cs/\"}", "barcode value" "161383532125848067541802", "barcode serialtype" "barcode", "barcode ptformat" "qrcodeserial", "barcode ptsubformat" "qr_code" }, "localization" [ { "language" "ko", "attributes" { "title" "삼성버스 탑승권", "providername" "삼성버스", "user" "사만다 삼성", "transitfare" "9,000 원" } } ] } ] } }