Bording 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 subtype
boardingpass

 airlines, trains, buses, others

Airlines

Figure 1: Sample UI: Boarding pass - Airlines

Buses

Figure 2: Sample UI: Boarding Pass - Buses

Trains

Figure3: Sample UI: Boarding Pass - Buses

Wallet Card data fields

Attributes

Type

 Value

 Description
attributes.{fields}

 title
String (32)

 (Required)
Main title.
e.g., 'BOARDING PASS'.
transitType
String (16)

 (Optional)
Transit type.
* This will be deprecated.
groupingId
String (32)

 (Optional)
Identifier used to group related cards
orderId
String (32)

 (Optional)
Unique identifier for an order
providerLogo
String (256)

 (Required)
URL of the logo image.
The file size should not exceed than 256 kB.
providerLogo.darkUrl
String (256)

 (Required)
URL of the logo image in dark mode.
The file size should not exceed 256 kB.
providerLogo.lightUrl
String (256)

 (Required)
URL of the logo image in light mode.
The file size should not exceed 256 kB.
providerName
String (32)

 (Required)
Display name of the boarding pass provider
user
String (64)

 (Conditional)
Passenger Name.
* Required if subType is airlines
userType
String (32)

 (Optional)
Passenger type
i.e., Classification of passengers, like Child, Adult.
transitOperator
String (64)

 (Optional)
Operator name
vehicleNumber
String (32)

 (Conditional)
Transit or route number
i.e., Flight number on airlines.
* Required if subType is airlines.
transitClass
String (32)

 (Optional)
Transit class
i.e., Premium class for buses.
transitFare
String (32)

 (Optional)
General fare or purchase fare
coachNumber
String (16)

 (Optional)
Identifier assigned to each individual carriage.
e.g., B4.
seatClass
String (32)

 (Conditional)
Seat class.
* Required if subType is airlines
seatNumber
String (16)

 (Required)
Individual number of the passenger seat.
e.g., A-9, Free.
seatFacing
String (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.
reservationNumber
String (32)

 (Required)
Number of the transit reservation
boardingPriority
String (32)

 (Optional)
Information on whether entitles the passenger to board before others.
i.e., if the passengers are pregnant.
boardingSeqNo
String (32)

 (Optional)
Boarding sequence number
boardingGroup
String (8)

 (Optional)
Value of boarding group or zone.
e.g., B.
boardingTime
Long (13)

 (Optional)
Boarding time.
Epoch timestamp in milliseconds.
boardingTime.utcOffset
String (8)

 (Conditional)
UTC offset of boarding time at the departure point.
* Required if boardingTime exist
gateClosingTime
Long (13)

 (Optional)
Boarding gate closing time.
Epoch timestamp in milliseconds.
gateClosingTime.utcOffset
String (8)

 (Conditional)
UTC offset of gate closing time at the departure point.
* Required if gateClosingTime exist
baggageAllowance
String (16)

 (Optional)
Baggage allowance
departName
String (32)

 (Conditional)
Name of the departure point.
* Required if subType is airlines.
departCode
String (8)

 (Conditional)
Code for the departure point.
* Required if subType is airlines.
departTerminal
String (8)

 (Conditional)
Terminal name of the departure point.
* Required if subType is airlines.
departGate
String (8)

 (Optional)
Gate name of the departure point
estimatedOrActualStartDate
Long (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. utcOffset
String (8)

 (Conditional)
UTC offset of time at the departure point.
* Required if estimatedOrActualStartDate exists.
arriveName
String (32)

 (Conditional)
Name of the arrival point.
* Required if subType is airlines.
arriveCode
String (8)

 (Conditional)
Code for the arrival point.
* Required if subType is airlines.
arriveTerminal
String (8)

 (Optional)
Terminal name of the arrival point
arriveGate
String (8)

 (Optional)
Gate name of the arrival point
estimatedOrActualEndDate
Long (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. utcOffset
String (8)

 (Conditional)
UTC offset of time at the arrival point.
* Required if estimatedOrActualEndDate exists.
locations
String (1024)

 (Optional)
List of locations where the card can be used.
* See Location format.
bgColor
String (8)

 (Required)
Color of the card art.
e.g., #00FFFF.
fontColor
String (8)

 (Optional)
Color of the font on the card art.
Acceptable values: dark, light.
blinkColor
String (8)

 (Optional)
Color of the blinking effect which indicates that a card cannot be captured in the Indicator area.
e.g., #00FFFF.
appLinkLogo
String (256)

 (Required)
App link image URL.
The file size should not exceed 256 kB.
appLinkName
String (32)

 (Required)
App link name.
appLinkData
String (256)

 (Required)
Information about the partner app link.
extraInfo
String (512)

 (Optional)
Additional information to be delivered to customers.
* See Additional Information format.
noticeDesc
String (5000)

 (Optional)
Text of the notice.
* Long content is allowed.
* See Additional Information format.
csInfo
String (512)

 (Optional)
Providers’ customer service Information
Using data in JSON format converted to escape string
* Allowed items: call, email, or website
* See below for an example.
displayTSAPreCheckYn
String (1)

 (Optional)
Flag whether to display the TSA PreCheck image. Either ‘Y’ or ‘N’.
Image size: 68x20 / 140x20
membershipStatusLevel
String (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.value
String (4096)

 (Optional)
Actual data that is delivered when the barcode/QR code is scanned.
barcode.serialType
String (32)

 (Optional)
Presentation type.
e.g., SERIALNUMBER, BARCODE, ...
* See Barcode format.
barcode.ptFormat
String (32)

 (Optional)
Presentation format.
e.g., BARCODE, QRCODE, SERIAL, ...
*See Barcode format.
barcode.ptSubFormat
String (32)

 (Optional)
Presentation sub-format.
e.g., CODE_128, QR_CODE, ...
* See Barcode format.
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

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 원"
                        }
                    }
                ]
            }
        ]
    }
}

Business Support for Special Purposes

Server APIs are provided for cases where it is necessary to manage a large number of cards. Cards created through API can also be checked and managed in the same way on the ‘Wallet Partners Portal'.

Changes to each card status can be processed at the ‘Wallet Partners Portal', and information on how to change them should be checked through the Partner Server Portal Guide. The attributes related to the server API are as follows.

Attributes

Type

 Value

 Description
Payload object

 cardTemplate
Object

 (Required)
Wallet card template object
cardTemplate.prtnrId
String (32)

 (Required)
Partner ID
cardTemplate.templateRefId
String(19)

 (Required)
Partner Template ID
cardTemplate.title
String(32)

 (Required)
Wallet Card Name
cardTemplate.countryCode
String(2)

 (Conditional)
The Main (Headquarters) Location.
* Required when creating a template
cardTemplate.cardType
String(100)

 (Conditional)
This value is set to “boardingpass”.
* Required when creating a template
cardTemplate.subType
String(100)

 (Conditional)
Select from these values: “airlines”, “trains”, or “buses”.
* Required when creating a template
cardTemplate.prtnrAppPckgName
String(128)

 (Optional)
The Application Package Name.
cardTemplate.appLogoImg
String(200)

 (Optional)
The banner logo image URL.
cardTemplate.noNetworkSupportYn
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.shareButtonExposureYN
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'Y'.
cardTemplate.privacyModeYn
String(1)

 (Optional)
This must be set to either 'Y' or 'N'.
* Default: 'N'.
cardTemplate.preventCaptureYn
String(1)

 (Optional)
This value is a screen capture prevention flag that defines whether the content view prevents screen capture.
cardTemplate.state
String(15)

 (Optional)
Wallet card's state
* Default: 'DRAFT'
cardTemplate.testingModeOff
String(1)

 (Optional)
TestMode Off.
This must be set to either 'Y' or 'N'.
* Default: ‘N’.
Available only when updating templates.
cardTemplate.desc
String(500)

 (Optional)
Description

 
{
  "cardTemplate": {
    "prtnrId": "4082825513190138240",
    "templateRefId": "2138240408282551312",
    "title": "Wallet Card Title",
    "prtnrAppPckgName": "prtnrAppPckgName",
    "countryCode": "US",
    "desc": "desc",
    "cardType": "boardingpass",
    "subType": "airlines",
    "appLogoImg": "http://www.yourdomain.com/banner_logo_image.png",
    "noNetworkSupportYn": "N"
    "shareButtonExposureYN": "Y"
    "privacyModeYn": "N"
    "preventCaptureYn": "N"
  }
}