Fields

​countryCode

Optional

String

Country/Region code.

currencyCode

Optional

String

Currency unit.

allowMultiUser

Optional

String

Whether a pass can be claimed by multiple users. The options are true and false. If this field does not exist or is set to false, a pass can be claimed by one user only.

status

Optional

Status

Status information that you have defined, including the status of a pass and the time when the pass expires.

relatedPassIds

Optional

List<RelatedPassIds>

ID of a linked pass, if any. This object is only available for a loyalty card instance and is used to associate with a coupon instance under the same user account. Do not set this object in the loyalty card model.

locationList

Optional

List<LocationList>

Geographical location. This parameter can be used if the pass supports geofence notifications.

barCode

Optional

BarCode

Barcode or QR code, which is displayed when a pass is used. Leave this parameter empty if the barcode or QR code need not be displayed.

commonFields

Optional

List<ValueObject>

List of common displayable fields, namely, common attributes of a type of pass. For details about the fields used by each type of pass, please refer to UI Design.

appendFields

Optional

List<ValueObject>

List of additional displayable fields, which are defined by the issuer to distinguish the same type of passes in different scenarios. For details about the fields used by each type of pass, please refer to UI Design.

messageList

Optional

List<ValueObject>

Notification for a pass, which is irrelevant with the common displayable fields of the pass. It is used to notify users, for example, of using the pass in a given period of time. The parameter label is mandatory.

timeList

Optional

List<ValueObject>

List of time information.

imageList

Optional

List<ValueObject>

List of images that are displayed in a succession on the pass details page, for example, hotel pictures and services that are displayed successively on the hotel loyalty card.

ticketInfoList

Optional

List<ValueObject>

Description of a ticket stub that you have defined. This parameter is available only for transit passes.

urlList

Optional

List<ValueObject>

Links to be shown on a pass. The label field is mandatory.

localized

Optional

List<Localized>

Local language, which is defined here and referenced by other fields through the corresponding key when the fields need to be displayed in the local language.