Interface IWalletTemplateCreateExtendedInput

The IWalletTemplateCreateExtendedInput collects the Wallet Template details and the brandId and programIds used to construct the wallet template.

interface IWalletTemplateCreateExtendedInput {
    androidPassData: IWalletTemplateAndroidPassData;
    brandId: number;
    defaultMessage?: string;
    fieldMappings: IWalletTemplateFieldMapping[];
    name: string;
    organizationName: string;
    passdata: IWalletTemplatePassData;
    programId: number;
    sharingProhibited?: boolean;
    sharingUrl?: string;
    walletIdentifierId: number;
}

Hierarchy (view full)

Properties

The pass data for the template. This constructs the layout for the Android wallet card.

brandId: number
defaultMessage?: string

The default message for the template. This is used to provide a default message for the card, this is set into the currentMessage on the user's card during generation and will be used to set the currentMessage on the card when the tier is changed.

The field mappings for the template. This maps the fields from the program to the wallet card. The fields are common to both layouts and are referenced with the key on the layout.

name: string

The template name

organizationName: string

The organization name, this will show on the back of apple cards and the title in android cards.

The pass data for the template. This constructs the layout for the Apple wallet card.

programId: number
sharingProhibited?: boolean

If sharing is allowed, this will provide a share option on the card. For Apple cards, if no sharingUrl is provided, the pass file will be shared.

sharingUrl?: string

The sharing URL to be used for sharing the card. This is only used for Apple cards.

walletIdentifierId: number

The wallet identifier id for the template. This is used to determine the wallet identifier for the card and is required for all card types.