Interface IWalletTemplatePassData

The WalletTemplatePassData object contains the configuration for the Apple Wallet layout of the template.

interface IWalletTemplatePassData {
    associatedStoreIdentifiers?: number[];
    auxiliaryFields?: string[];
    backFields?: string[];
    backgroundColor?: string;
    barCodes: BarCode[];
    description?: string;
    expirationDate?: string;
    foregroundColor?: string;
    groupingIdentifier?: string;
    headerFields?: string[];
    images: Image<AppleImageStyles>[];
    includeLogoText?: boolean;
    labelColor?: string;
    nfcField?: NFCField;
    passStyle: BambuPassStyles;
    primaryFields?: string[];
    relevantDate?: string;
    secondaryFields?: string[];
    subheader?: string;
}

Properties

associatedStoreIdentifiers?: number[]
auxiliaryFields?: string[]

The auxilary fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed. *This is not used on all card styles.

backFields?: string[]

The back fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed.

backgroundColor?: string

The background color of the apple card.

barCodes: BarCode[]

If you want to apply barcodes to the card, you can define them here. Typically you only have 1 barcode per card.

description?: string

The description of the card.

expirationDate?: string

The expiration date of this card. This card will be moved to the expired section of the device wallet once expired.

foregroundColor?: string

The text color of the apple card.

groupingIdentifier?: string

The pass grouping identifier used to group multiple cards together on a single device.

headerFields?: string[]

The header fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed.

The images for the card. These are used to construct the card layout. The images styles used are dependant on the passStyle.

includeLogoText?: boolean

Will show the android header on the card if true.

labelColor?: string

The label color of the apple card.

nfcField?: NFCField

This will apply an NFC to the card, if NFC is supported by your certificate.

passStyle: BambuPassStyles

The pass style can be one of the following:

  • storeCard
  • giftCard
  • eventTicket
  • coupon
  • generic
  • profile
primaryFields?: string[]

The primary fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed. *This is not used on all card styles.

relevantDate?: string

The relevantDate of this card. Applicable to events and coupons, will cause a message to be displayed on the card.

secondaryFields?: string[]

The secondary fields for the card. These are used to construct the card layout. You add the key of the field you want to set here in the sequence you want them to be displayed.

subheader?: string

The subtitle of the card.