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 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

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