Loyaltyclass

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "walletobjects#loyaltyClass",
  "id": string,
  "version": long,
  "issuerName": string,
  "localizedIssuerName": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "messages": [
    {
      "kind": "walletobjects#walletObjectMessage",
      "header": string,
      "localizedHeader": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "body": string,
      "localizedBody": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "displayInterval": {
        "kind": "walletobjects#timeInterval",
        "start": {
          "date": string
        },
        "end": {
          "date": string
        }
      },
      "id": string,
      "messageType": string
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    "kind": "walletobjects#uri",
    "uri": string,
    "description": string,
    "localizedDescription": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    },
    "id": string
  },
  "locations": [
    {
      "kind": "walletobjects#latLongPoint",
      "latitude": double,
      "longitude": double
    }
  ],
  "reviewStatus": string,
  "review": {
    "comments": string
  },
  "infoModuleData": {
    "labelValueRows": [
      {
        "columns": [
          {
            "label": string,
            "localizedLabel": {
              "kind": "walletobjects#localizedString",
              "translatedValues": [
                {
                  "kind": "walletobjects#translatedString",
                  "language": string,
                  "value": string
                }
              ],
              "defaultValue": {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            },
            "value": string,
            "localizedValue": {
              "kind": "walletobjects#localizedString",
              "translatedValues": [
                {
                  "kind": "walletobjects#translatedString",
                  "language": string,
                  "value": string
                }
              ],
              "defaultValue": {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            }
          }
        ]
      }
    ],
    "showLastUpdateTime": boolean
  },
  "imageModulesData": [
    {
      "mainImage": {
        "kind": "walletobjects#image",
        "sourceUri": {
          "kind": "walletobjects#uri",
          "uri": string,
          "description": string,
          "localizedDescription": {
            "kind": "walletobjects#localizedString",
            "translatedValues": [
              {
                "kind": "walletobjects#translatedString",
                "language": string,
                "value": string
              }
            ],
            "defaultValue": {
              "kind": "walletobjects#translatedString",
              "language": string,
              "value": string
            }
          },
          "id": string
        }
      },
      "id": string
    }
  ],
  "textModulesData": [
    {
      "header": string,
      "body": string,
      "localizedHeader": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "localizedBody": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  ],
  "linksModuleData": {
    "uris": [
      {
        "kind": "walletobjects#uri",
        "uri": string,
        "description": string,
        "localizedDescription": {
          "kind": "walletobjects#localizedString",
          "translatedValues": [
            {
              "kind": "walletobjects#translatedString",
              "language": string,
              "value": string
            }
          ],
          "defaultValue": {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        },
        "id": string
      }
    ]
  },
  "redemptionIssuers": [
    long
  ],
  "countryCode": string,
  "heroImage": {
    "kind": "walletobjects#image",
    "sourceUri": {
      "kind": "walletobjects#uri",
      "uri": string,
      "description": string,
      "localizedDescription": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  },
  "wordMark": {
    "kind": "walletobjects#image",
    "sourceUri": {
      "kind": "walletobjects#uri",
      "uri": string,
      "description": string,
      "localizedDescription": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "multipleDevicesAndHoldersAllowedStatus": string,
  "callbackOptions": {
    "url": string
  },
  "programName": string,
  "localizedProgramName": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "programLogo": {
    "kind": "walletobjects#image",
    "sourceUri": {
      "kind": "walletobjects#uri",
      "uri": string,
      "description": string,
      "localizedDescription": {
        "kind": "walletobjects#localizedString",
        "translatedValues": [
          {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        ],
        "defaultValue": {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      },
      "id": string
    }
  },
  "accountNameLabel": string,
  "localizedAccountNameLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "accountIdLabel": string,
  "localizedAccountIdLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "rewardsTierLabel": string,
  "localizedRewardsTierLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "rewardsTier": string,
  "localizedRewardsTier": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    "kind": "walletobjects#localizedString",
    "translatedValues": [
      {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    ],
    "defaultValue": {
      "kind": "walletobjects#translatedString",
      "language": string,
      "value": string
    }
  },
  "discoverableProgram": {
    "kind": "walletobjects#discoverableProgram",
    "merchantSignupInfo": {
      "signupWebsite": {
        "kind": "walletobjects#uri",
        "uri": string,
        "description": string,
        "localizedDescription": {
          "kind": "walletobjects#localizedString",
          "translatedValues": [
            {
              "kind": "walletobjects#translatedString",
              "language": string,
              "value": string
            }
          ],
          "defaultValue": {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        },
        "id": string
      },
      "signupSharedDatas": [
        string
      ]
    },
    "merchantSigninInfo": {
      "signinWebsite": {
        "kind": "walletobjects#uri",
        "uri": string,
        "description": string,
        "localizedDescription": {
          "kind": "walletobjects#localizedString",
          "translatedValues": [
            {
              "kind": "walletobjects#translatedString",
              "language": string,
              "value": string
            }
          ],
          "defaultValue": {
            "kind": "walletobjects#translatedString",
            "language": string,
            "value": string
          }
        },
        "id": string
      }
    },
    "state": string
  }
}
Property name Value Description Notes
accountIdLabel string The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens. writable
accountNameLabel string The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens. writable
allowMultipleUsersPerObject boolean Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead. writable
callbackOptions nested object Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback. writable
callbackOptions.url string URL for the merchant endpoint that would be called for all user saves and deletes. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. writable
countryCode string Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale. writable
discoverableProgram nested object Information about how the class may be discovered and instantiated from within the Google Pay app.

writable
discoverableProgram.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#discoverableProgram".
discoverableProgram.merchantSigninInfo nested object Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
discoverableProgram.merchantSigninInfo.signinWebsite nested object The URL to direct the user to for the merchant's signin site.
discoverableProgram.merchantSigninInfo.signinWebsite.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
discoverableProgram.merchantSigninInfo.signinWebsite.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
discoverableProgram.merchantSigninInfo.signinWebsite.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.translatedValues[] list Contains the translations for the string. writable
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
discoverableProgram.merchantSigninInfo.signinWebsite.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
discoverableProgram.merchantSigninInfo.signinWebsite.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
discoverableProgram.merchantSignupInfo nested object Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
discoverableProgram.merchantSignupInfo.signupSharedDatas[] list User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.
discoverableProgram.merchantSignupInfo.signupWebsite nested object The URL to direct the user to for the merchant's signup site.
discoverableProgram.merchantSignupInfo.signupWebsite.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
discoverableProgram.merchantSignupInfo.signupWebsite.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
discoverableProgram.merchantSignupInfo.signupWebsite.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.translatedValues[] list Contains the translations for the string. writable
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
discoverableProgram.merchantSignupInfo.signupWebsite.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
discoverableProgram.merchantSignupInfo.signupWebsite.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
discoverableProgram.state string Visibility state of the discoverable program.

Acceptable values are:
  • "disabled"
  • "live"
  • "trustedTesters"
enableSmartTap boolean Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
heroImage nested object Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width. writable
heroImage.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
heroImage.sourceUri nested object The URI for the image. writable
heroImage.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
heroImage.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
heroImage.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
heroImage.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
heroImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
heroImage.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
heroImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
heroImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
heroImage.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
heroImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
heroImage.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
hexBackgroundColor string The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as #ffcc00. You can also use the shorthand version of the RGB triplet which is #rgb, such as #fc0. writable
homepageUri nested object The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object). writable
homepageUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
homepageUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
homepageUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
homepageUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
homepageUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
homepageUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
homepageUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
homepageUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
homepageUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
homepageUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
homepageUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
id string The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
imageModulesData[] list Image module data. If image modules data is also defined on the object, those will be merged with the image data defined on the class. The maximum number of these fields (combined with the object) is 1. writable
imageModulesData[].id string The ID associated with an image module. This field is here to enable ease of management of image modules.
imageModulesData[].mainImage nested object A 100% width image. writable
imageModulesData[].mainImage.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
imageModulesData[].mainImage.sourceUri nested object The URI for the image. writable
imageModulesData[].mainImage.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
imageModulesData[].mainImage.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
imageModulesData[].mainImage.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
imageModulesData[].mainImage.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
imageModulesData[].mainImage.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
infoModuleData nested object Deprecated. Use textModulesData instead. writable
infoModuleData.labelValueRows[] list A list of collections of labels and values. These will be displayed one after the other in a singular column. writable
infoModuleData.labelValueRows[].columns[] list A list of labels and values. These will be displayed in a singular column, one after the other, not in multiple columns, despite the field name. writable
infoModuleData.labelValueRows[].columns[].label string The label for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedLabel nested object Translated strings for the label. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout.

writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue nested object Translated strings for the value. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[] list Contains the translations for the string. writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].localizedValue.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
infoModuleData.labelValueRows[].columns[].value string The value for a specific row and column. Recommended maximum is 15 characters for a two-column layout and 30 characters for a one-column layout. writable
infoModuleData.showLastUpdateTime boolean Deprecated writable
issuerName string The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyClass".
linksModuleData nested object Links module data. If links module data is also defined on the object, both will be displayed. The maximum number of these fields (combined with the object) is 10. writable
linksModuleData.uris[] list The list of URIs. writable
linksModuleData.uris[].description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
linksModuleData.uris[].id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
linksModuleData.uris[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
linksModuleData.uris[].localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
linksModuleData.uris[].localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
linksModuleData.uris[].localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
linksModuleData.uris[].localizedDescription.translatedValues[] list Contains the translations for the string. writable
linksModuleData.uris[].localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
linksModuleData.uris[].localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
linksModuleData.uris[].uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
localizedAccountIdLabel nested object Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens. writable
localizedAccountIdLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedAccountIdLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedAccountIdLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedAccountIdLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedAccountIdLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedAccountIdLabel.translatedValues[] list Contains the translations for the string. writable
localizedAccountIdLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedAccountIdLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedAccountIdLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedAccountNameLabel nested object Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens. writable
localizedAccountNameLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedAccountNameLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedAccountNameLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedAccountNameLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedAccountNameLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedAccountNameLabel.translatedValues[] list Contains the translations for the string. writable
localizedAccountNameLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedAccountNameLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedAccountNameLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName nested object Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. writable
localizedIssuerName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedIssuerName.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedIssuerName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedIssuerName.translatedValues[] list Contains the translations for the string. writable
localizedIssuerName.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedIssuerName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedIssuerName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedProgramName nested object Translated strings for the program_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens. writable
localizedProgramName.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedProgramName.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedProgramName.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedProgramName.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedProgramName.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedProgramName.translatedValues[] list Contains the translations for the string. writable
localizedProgramName.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedProgramName.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedProgramName.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedRewardsTier nested object Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens. writable
localizedRewardsTier.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedRewardsTier.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedRewardsTier.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedRewardsTier.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedRewardsTier.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedRewardsTier.translatedValues[] list Contains the translations for the string. writable
localizedRewardsTier.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedRewardsTier.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedRewardsTier.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedRewardsTierLabel nested object Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens. writable
localizedRewardsTierLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedRewardsTierLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedRewardsTierLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedRewardsTierLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedRewardsTierLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedRewardsTierLabel.translatedValues[] list Contains the translations for the string. writable
localizedRewardsTierLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedRewardsTierLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedRewardsTierLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedSecondaryRewardsTier nested object Translated strings for the secondary_rewards_tier. writable
localizedSecondaryRewardsTier.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedSecondaryRewardsTier.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedSecondaryRewardsTier.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedSecondaryRewardsTier.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedSecondaryRewardsTier.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedSecondaryRewardsTier.translatedValues[] list Contains the translations for the string. writable
localizedSecondaryRewardsTier.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedSecondaryRewardsTier.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedSecondaryRewardsTier.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedSecondaryRewardsTierLabel nested object Translated strings for the secondary_rewards_tier_label. writable
localizedSecondaryRewardsTierLabel.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
localizedSecondaryRewardsTierLabel.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedSecondaryRewardsTierLabel.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedSecondaryRewardsTierLabel.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
localizedSecondaryRewardsTierLabel.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
localizedSecondaryRewardsTierLabel.translatedValues[] list Contains the translations for the string. writable
localizedSecondaryRewardsTierLabel.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
localizedSecondaryRewardsTierLabel.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
localizedSecondaryRewardsTierLabel.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
locations[] list The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID.

This is only supported by the gift cards, loyalty, and offers verticals.
writable
locations[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".
locations[].latitude double The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected. writable
locations[].longitude double The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected. writable
messages[] list An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. writable
messages[].body string The message body. writable
messages[].displayInterval nested object The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided. writable
messages[].displayInterval.end nested object End time of the interval.

Offset is not required. If an offset is provided and start time is set, start must also include an offset.
writable
messages[].displayInterval.end.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
messages[].displayInterval.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#timeInterval".
messages[].displayInterval.start nested object Start time of the interval.

Offset is not required. If an offset is provided and end time is set, end must also include an offset.
writable
messages[].displayInterval.start.date string An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601).

For example:

1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year.

1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information.

Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles.

Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
writable
messages[].header string The message header. writable
messages[].id string The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. writable
messages[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
messages[].localizedBody nested object Translated strings for the message body. writable
messages[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedBody.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
messages[].localizedBody.translatedValues[] list Contains the translations for the string. writable
messages[].localizedBody.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader nested object Translated strings for the message header. writable
messages[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
messages[].localizedHeader.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
messages[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
messages[].localizedHeader.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
messages[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
messages[].messageType string The type of the message. Currently, this can only be set for offers.

Acceptable values are:
  • "expirationNotification": Notification to display for an offer expiration. The displayInterval.start.date sets the time the notification will appear. It can be set up to 30 days prior to the expiration date. If a time span greater than this is specified, then the notification will trigger at the 30 day mark.
  • "text": Renders the message as text on the card details screen. This is the default message type.
writable
multipleDevicesAndHoldersAllowedStatus string Identifies whether multiple users and devices will save the same object referencing this class.

Acceptable values are:
  • "multipleHolders": Multiple users on multiple devices are allowed.
  • "oneUserAllDevices": One user on multiple devices is allowed.
  • "oneUserOneDevice": Intended for use by select partners in limited circumstances. Contact support for additional information.
writable
programLogo.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
programLogo.sourceUri nested object The URI for the image. writable
programLogo.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
programLogo.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
programLogo.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
programLogo.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
programLogo.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
programLogo.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
programLogo.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
programLogo.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
programLogo.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
programLogo.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
programLogo.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
programLogo.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
programLogo.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
programLogo.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable
programName string The program name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens. writable
redemptionIssuers[] list Available only to Smart Tap enabled partners. Contact support for additional guidance. writable
review nested object The review comments set by the platform when a class is marked approved or rejected.
review.comments string The explanation of why the class was marked approved or rejected.
reviewStatus string The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft.

You should keep this field to draft when the class is under development. A draft class cannot be used to create any object.

You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects.

When updating an already approved class you should keep setting this field to underReview.

Acceptable values are:
  • "approved"
  • "draft"
  • "rejected"
  • "underReview"
writable
rewardsTier string The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens. writable
rewardsTierLabel string The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens. writable
secondaryRewardsTier string The secondary rewards tier, such as "Gold" or "Platinum." writable
secondaryRewardsTierLabel string The secondary rewards tier label, such as "Rewards Tier." writable
textModulesData[] list Text module data. If text modules data is also defined on the object, both will be displayed. The maximum number of these fields (combined with the object) is 10. writable
textModulesData[].body string The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].header string The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].id string The ID associated with a text module. This field is here to enable ease of management of text modules.
textModulesData[].localizedBody nested object Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedBody.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedBody.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedBody.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
textModulesData[].localizedBody.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedBody.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedBody.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedBody.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader nested object Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. writable
textModulesData[].localizedHeader.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
textModulesData[].localizedHeader.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedHeader.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
textModulesData[].localizedHeader.translatedValues[] list Contains the translations for the string. writable
textModulesData[].localizedHeader.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
textModulesData[].localizedHeader.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
textModulesData[].localizedHeader.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
version long Deprecated.
wordMark nested object Deprecated.
wordMark.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
wordMark.sourceUri nested object The URI for the image. writable
wordMark.sourceUri.description string The URI's title appearing in the app as text. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens.

Note that in some contexts this text is not used, such as when description is part of an image.
writable
wordMark.sourceUri.id string The ID associated with a uri. This field is here to enable ease of management of uris. writable
wordMark.sourceUri.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#uri".
wordMark.sourceUri.localizedDescription nested object Translated strings for the description. Recommended maximum is 20 characters to ensure full string is displayed on smaller screens. writable
wordMark.sourceUri.localizedDescription.defaultValue nested object Contains the string to be displayed if no appropriate translation is available.

Required for each nested object of kind walletobjects#localizedString.
writable
wordMark.sourceUri.localizedDescription.defaultValue.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
wordMark.sourceUri.localizedDescription.defaultValue.language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.defaultValue.value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#localizedString".
wordMark.sourceUri.localizedDescription.translatedValues[] list Contains the translations for the string. writable
wordMark.sourceUri.localizedDescription.translatedValues[].kind string Identifies what kind of resource this is. Value: the fixed string "walletobjects#translatedString".
wordMark.sourceUri.localizedDescription.translatedValues[].language string Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.localizedDescription.translatedValues[].value string The UTF-8 encoded translated string.

Required for each nested object of kind walletobjects#translatedString.
writable
wordMark.sourceUri.uri string The location of a web page, image, or other resource. URIs in the LinksModuleData module can have different prefixes indicating the type of URI (a link to a web page, a link to a map, a telephone number, or an email address). URIs must have a scheme. writable

Methods

addmessage
Adds a message to the loyalty class referenced by the given class ID.
get
Returns the loyalty class with the given class ID.
insert
Inserts a loyalty class with the given ID and properties.
list
Returns a list of all loyalty classes for a given issuer ID.
patch
Updates the loyalty class referenced by the given class ID. This method supports patch semantics.
update
Updates the loyalty class referenced by the given class ID.