Google Pay Passes API
  1. loyaltyclass
Google Pay Passes API
  • eventticketclass
    • /walletobjects/v1/eventTicketClass
      GET
    • /walletobjects/v1/eventTicketClass
      POST
    • /walletobjects/v1/eventTicketClass/{resourceId}
      GET
    • /walletobjects/v1/eventTicketClass/{resourceId}
      PATCH
    • /walletobjects/v1/eventTicketClass/{resourceId}
      PUT
    • /walletobjects/v1/eventTicketClass/{resourceId}/addMessage
      POST
  • eventticketobject
    • /walletobjects/v1/eventTicketObject
      GET
    • /walletobjects/v1/eventTicketObject
      POST
    • /walletobjects/v1/eventTicketObject/{resourceId}
      GET
    • /walletobjects/v1/eventTicketObject/{resourceId}
      PATCH
    • /walletobjects/v1/eventTicketObject/{resourceId}
      PUT
    • /walletobjects/v1/eventTicketObject/{resourceId}/addMessage
      POST
    • /walletobjects/v1/eventTicketObject/{resourceId}/modifyLinkedOfferObjects
      POST
  • flightclass
    • /walletobjects/v1/flightClass
      GET
    • /walletobjects/v1/flightClass
      POST
    • /walletobjects/v1/flightClass/{resourceId}
      GET
    • /walletobjects/v1/flightClass/{resourceId}
      PATCH
    • /walletobjects/v1/flightClass/{resourceId}
      PUT
    • /walletobjects/v1/flightClass/{resourceId}/addMessage
      POST
  • flightobject
    • /walletobjects/v1/flightObject
      GET
    • /walletobjects/v1/flightObject
      POST
    • /walletobjects/v1/flightObject/{resourceId}
      GET
    • /walletobjects/v1/flightObject/{resourceId}
      PATCH
    • /walletobjects/v1/flightObject/{resourceId}
      PUT
    • /walletobjects/v1/flightObject/{resourceId}/addMessage
      POST
  • giftcardclass
    • /walletobjects/v1/giftCardClass
    • /walletobjects/v1/giftCardClass
    • /walletobjects/v1/giftCardClass/{resourceId}
    • /walletobjects/v1/giftCardClass/{resourceId}
    • /walletobjects/v1/giftCardClass/{resourceId}
    • /walletobjects/v1/giftCardClass/{resourceId}/addMessage
  • giftcardobject
    • /walletobjects/v1/giftCardObject
    • /walletobjects/v1/giftCardObject
    • /walletobjects/v1/giftCardObject/{resourceId}
    • /walletobjects/v1/giftCardObject/{resourceId}
    • /walletobjects/v1/giftCardObject/{resourceId}
    • /walletobjects/v1/giftCardObject/{resourceId}/addMessage
  • issuer
    • /walletobjects/v1/issuer
    • /walletobjects/v1/issuer
    • /walletobjects/v1/issuer/{resourceId}
    • /walletobjects/v1/issuer/{resourceId}
    • /walletobjects/v1/issuer/{resourceId}
  • jwt
    • /walletobjects/v1/jwt
  • loyaltyclass
    • /walletobjects/v1/loyaltyClass
      GET
    • /walletobjects/v1/loyaltyClass
      POST
    • /walletobjects/v1/loyaltyClass/{resourceId}
      GET
    • /walletobjects/v1/loyaltyClass/{resourceId}
      PATCH
    • /walletobjects/v1/loyaltyClass/{resourceId}
      PUT
    • /walletobjects/v1/loyaltyClass/{resourceId}/addMessage
      POST
  • loyaltyobject
    • /walletobjects/v1/loyaltyObject
    • /walletobjects/v1/loyaltyObject
    • /walletobjects/v1/loyaltyObject/{resourceId}
    • /walletobjects/v1/loyaltyObject/{resourceId}
    • /walletobjects/v1/loyaltyObject/{resourceId}
    • /walletobjects/v1/loyaltyObject/{resourceId}/addMessage
    • /walletobjects/v1/loyaltyObject/{resourceId}/modifyLinkedOfferObjects
  • offerclass
    • /walletobjects/v1/offerClass
    • /walletobjects/v1/offerClass
    • /walletobjects/v1/offerClass/{resourceId}
    • /walletobjects/v1/offerClass/{resourceId}
    • /walletobjects/v1/offerClass/{resourceId}
    • /walletobjects/v1/offerClass/{resourceId}/addMessage
  • offerobject
    • /walletobjects/v1/offerObject
    • /walletobjects/v1/offerObject
    • /walletobjects/v1/offerObject/{resourceId}
    • /walletobjects/v1/offerObject/{resourceId}
    • /walletobjects/v1/offerObject/{resourceId}
    • /walletobjects/v1/offerObject/{resourceId}/addMessage
  • permissions
    • /walletobjects/v1/permissions/{resourceId}
    • /walletobjects/v1/permissions/{resourceId}
  • smarttap
    • /walletobjects/v1/smartTap
  • transitclass
    • /walletobjects/v1/transitClass
    • /walletobjects/v1/transitClass
    • /walletobjects/v1/transitClass/{resourceId}
    • /walletobjects/v1/transitClass/{resourceId}
    • /walletobjects/v1/transitClass/{resourceId}
    • /walletobjects/v1/transitClass/{resourceId}/addMessage
  • transitobject
    • /walletobjects/v1/transitObject
    • /walletobjects/v1/transitObject
    • /walletobjects/v1/transitObject/{resourceId}
    • /walletobjects/v1/transitObject/{resourceId}
    • /walletobjects/v1/transitObject/{resourceId}
    • /walletobjects/v1/transitObject/{resourceId}/addMessage
  • valuablesclasses
    • /walletobjects/v1/valuablesclasses
  • walletobjects
    • /walletobjects/v1/valuablesclassescount
  1. loyaltyclass

/walletobjects/v1/loyaltyClass

POST
/walletobjects/v1/loyaltyClass
loyaltyclass
Inserts an loyalty class with the given ID and properties.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://walletobjects.googleapis.com//walletobjects/v1/loyaltyClass' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountIdLabel": "string",
    "accountNameLabel": "string",
    "allowMultipleUsersPerObject": true,
    "callbackOptions": {
        "updateRequestUrl": "string",
        "url": "string"
    },
    "classTemplateInfo": {
        "cardBarcodeSectionDetails": {
            "firstBottomDetail": {
                "fieldSelector": {
                    "fields": [
                        {
                            "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                            "fieldPath": "string"
                        }
                    ]
                }
            },
            "firstTopDetail": {
                "fieldSelector": {
                    "fields": [
                        {
                            "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                            "fieldPath": "string"
                        }
                    ]
                }
            },
            "secondTopDetail": {
                "fieldSelector": {
                    "fields": [
                        {
                            "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                            "fieldPath": "string"
                        }
                    ]
                }
            }
        },
        "cardTemplateOverride": {
            "cardRowTemplateInfos": [
                {
                    "oneItem": {
                        "item": {
                            "firstValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            },
                            "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                            "secondValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            }
                        }
                    },
                    "threeItems": {
                        "endItem": {
                            "firstValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            },
                            "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                            "secondValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            }
                        },
                        "middleItem": {
                            "firstValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            },
                            "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                            "secondValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            }
                        },
                        "startItem": {
                            "firstValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            },
                            "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                            "secondValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            }
                        }
                    },
                    "twoItems": {
                        "endItem": {
                            "firstValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            },
                            "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                            "secondValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            }
                        },
                        "startItem": {
                            "firstValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            },
                            "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                            "secondValue": {
                                "fields": [
                                    {
                                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                        "fieldPath": "string"
                                    }
                                ]
                            }
                        }
                    }
                }
            ]
        },
        "detailsTemplateOverride": {
            "detailsItemInfos": [
                {
                    "item": {
                        "firstValue": {
                            "fields": [
                                {
                                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                    "fieldPath": "string"
                                }
                            ]
                        },
                        "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
                        "secondValue": {
                            "fields": [
                                {
                                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                                    "fieldPath": "string"
                                }
                            ]
                        }
                    }
                }
            ]
        },
        "listTemplateOverride": {
            "firstRowOption": {
                "fieldOption": {
                    "fields": [
                        {
                            "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                            "fieldPath": "string"
                        }
                    ]
                },
                "transitOption": "TRANSIT_OPTION_UNSPECIFIED"
            },
            "secondRowOption": {
                "fields": [
                    {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                    }
                ]
            },
            "thirdRowOption": {
                "fields": [
                    {
                        "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                        "fieldPath": "string"
                    }
                ]
            }
        }
    },
    "countryCode": "string",
    "discoverableProgram": {
        "merchantSigninInfo": {
            "signinWebsite": {
                "description": "string",
                "id": "string",
                "kind": "string",
                "localizedDescription": {
                    "defaultValue": {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    },
                    "kind": "string",
                    "translatedValues": [
                        {
                            "kind": "string",
                            "language": "string",
                            "value": "string"
                        }
                    ]
                },
                "uri": "string"
            }
        },
        "merchantSignupInfo": {
            "signupSharedDatas": [
                "SHARED_DATA_TYPE_UNSPECIFIED"
            ],
            "signupWebsite": {
                "description": "string",
                "id": "string",
                "kind": "string",
                "localizedDescription": {
                    "defaultValue": {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    },
                    "kind": "string",
                    "translatedValues": [
                        {
                            "kind": "string",
                            "language": "string",
                            "value": "string"
                        }
                    ]
                },
                "uri": "string"
            }
        },
        "state": "STATE_UNSPECIFIED"
    },
    "enableSmartTap": true,
    "heroImage": {
        "kind": "string",
        "sourceUri": {
            "description": "string",
            "localizedDescription": {
                "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                },
                "kind": "string",
                "translatedValues": [
                    {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    }
                ]
            },
            "uri": "string"
        }
    },
    "hexBackgroundColor": "string",
    "homepageUri": {
        "description": "string",
        "id": "string",
        "kind": "string",
        "localizedDescription": {
            "defaultValue": {
                "kind": "string",
                "language": "string",
                "value": "string"
            },
            "kind": "string",
            "translatedValues": [
                {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                }
            ]
        },
        "uri": "string"
    },
    "id": "string",
    "imageModulesData": [
        {
            "id": "string",
            "mainImage": {
                "kind": "string",
                "sourceUri": {
                    "description": "string",
                    "localizedDescription": {
                        "defaultValue": {
                            "kind": "string",
                            "language": "string",
                            "value": "string"
                        },
                        "kind": "string",
                        "translatedValues": [
                            {
                                "kind": "string",
                                "language": "string",
                                "value": "string"
                            }
                        ]
                    },
                    "uri": "string"
                }
            }
        }
    ],
    "infoModuleData": {
        "labelValueRows": [
            {
                "columns": [
                    {
                        "label": "string",
                        "localizedLabel": {
                            "defaultValue": {
                                "kind": "string",
                                "language": "string",
                                "value": "string"
                            },
                            "kind": "string",
                            "translatedValues": [
                                {
                                    "kind": "string",
                                    "language": "string",
                                    "value": "string"
                                }
                            ]
                        },
                        "localizedValue": {
                            "defaultValue": {
                                "kind": "string",
                                "language": "string",
                                "value": "string"
                            },
                            "kind": "string",
                            "translatedValues": [
                                {
                                    "kind": "string",
                                    "language": "string",
                                    "value": "string"
                                }
                            ]
                        },
                        "value": "string"
                    }
                ]
            }
        ],
        "showLastUpdateTime": true
    },
    "issuerName": "string",
    "kind": "string",
    "linksModuleData": {
        "uris": [
            {
                "description": "string",
                "id": "string",
                "kind": "string",
                "localizedDescription": {
                    "defaultValue": {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    },
                    "kind": "string",
                    "translatedValues": [
                        {
                            "kind": "string",
                            "language": "string",
                            "value": "string"
                        }
                    ]
                },
                "uri": "string"
            }
        ]
    },
    "localizedAccountIdLabel": {
        "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
        },
        "kind": "string",
        "translatedValues": [
            {
                "kind": "string",
                "language": "string",
                "value": "string"
            }
        ]
    },
    "localizedAccountNameLabel": {
        "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
        },
        "kind": "string",
        "translatedValues": [
            {
                "kind": "string",
                "language": "string",
                "value": "string"
            }
        ]
    },
    "localizedIssuerName": {
        "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
        },
        "kind": "string",
        "translatedValues": [
            {
                "kind": "string",
                "language": "string",
                "value": "string"
            }
        ]
    },
    "localizedProgramName": {
        "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
        },
        "kind": "string",
        "translatedValues": [
            {
                "kind": "string",
                "language": "string",
                "value": "string"
            }
        ]
    },
    "localizedRewardsTier": {
        "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
        },
        "kind": "string",
        "translatedValues": [
            {
                "kind": "string",
                "language": "string",
                "value": "string"
            }
        ]
    },
    "localizedRewardsTierLabel": {
        "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
        },
        "kind": "string",
        "translatedValues": [
            {
                "kind": "string",
                "language": "string",
                "value": "string"
            }
        ]
    },
    "localizedSecondaryRewardsTier": {
        "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
        },
        "kind": "string",
        "translatedValues": [
            {
                "kind": "string",
                "language": "string",
                "value": "string"
            }
        ]
    },
    "localizedSecondaryRewardsTierLabel": {
        "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
        },
        "kind": "string",
        "translatedValues": [
            {
                "kind": "string",
                "language": "string",
                "value": "string"
            }
        ]
    },
    "locations": [
        {
            "kind": "string",
            "latitude": 0,
            "longitude": 0
        }
    ],
    "messages": [
        {
            "body": "string",
            "displayInterval": {
                "end": {
                    "date": "string"
                },
                "kind": "string",
                "start": {
                    "date": "string"
                }
            },
            "header": "string",
            "id": "string",
            "kind": "string",
            "localizedBody": {
                "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                },
                "kind": "string",
                "translatedValues": [
                    {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    }
                ]
            },
            "localizedHeader": {
                "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                },
                "kind": "string",
                "translatedValues": [
                    {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    }
                ]
            },
            "messageType": "MESSAGE_TYPE_UNSPECIFIED"
        }
    ],
    "multipleDevicesAndHoldersAllowedStatus": "STATUS_UNSPECIFIED",
    "programLogo": {
        "kind": "string",
        "sourceUri": {
            "description": "string",
            "localizedDescription": {
                "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                },
                "kind": "string",
                "translatedValues": [
                    {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    }
                ]
            },
            "uri": "string"
        }
    },
    "programName": "string",
    "redemptionIssuers": [
        "string"
    ],
    "review": {
        "comments": "string"
    },
    "reviewStatus": "REVIEW_STATUS_UNSPECIFIED",
    "rewardsTier": "string",
    "rewardsTierLabel": "string",
    "secondaryRewardsTier": "string",
    "secondaryRewardsTierLabel": "string",
    "textModulesData": [
        {
            "body": "string",
            "header": "string",
            "id": "string",
            "localizedBody": {
                "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                },
                "kind": "string",
                "translatedValues": [
                    {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    }
                ]
            },
            "localizedHeader": {
                "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                },
                "kind": "string",
                "translatedValues": [
                    {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    }
                ]
            }
        }
    ],
    "version": "string",
    "wordMark": {
        "kind": "string",
        "sourceUri": {
            "description": "string",
            "localizedDescription": {
                "defaultValue": {
                    "kind": "string",
                    "language": "string",
                    "value": "string"
                },
                "kind": "string",
                "translatedValues": [
                    {
                        "kind": "string",
                        "language": "string",
                        "value": "string"
                    }
                ]
            },
            "uri": "string"
        }
    }
}'
Response Response Example
{
  "accountIdLabel": "string",
  "accountNameLabel": "string",
  "allowMultipleUsersPerObject": true,
  "callbackOptions": {
    "updateRequestUrl": "string",
    "url": "string"
  },
  "classTemplateInfo": {
    "cardBarcodeSectionDetails": {
      "firstBottomDetail": {
        "fieldSelector": {
          "fields": [
            {
              "dateFormat": "DATE_FORMAT_UNSPECIFIED",
              "fieldPath": "string"
            }
          ]
        }
      },
      "firstTopDetail": {
        "fieldSelector": {
          "fields": [
            {
              "dateFormat": "DATE_FORMAT_UNSPECIFIED",
              "fieldPath": "string"
            }
          ]
        }
      },
      "secondTopDetail": {
        "fieldSelector": {
          "fields": [
            {
              "dateFormat": "DATE_FORMAT_UNSPECIFIED",
              "fieldPath": "string"
            }
          ]
        }
      }
    },
    "cardTemplateOverride": {
      "cardRowTemplateInfos": [
        {
          "oneItem": {
            "item": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            }
          },
          "threeItems": {
            "endItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            },
            "middleItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            },
            "startItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            }
          },
          "twoItems": {
            "endItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            },
            "startItem": {
              "firstValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              },
              "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
              "secondValue": {
                "fields": [
                  {
                    "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                    "fieldPath": "string"
                  }
                ]
              }
            }
          }
        }
      ]
    },
    "detailsTemplateOverride": {
      "detailsItemInfos": [
        {
          "item": {
            "firstValue": {
              "fields": [
                {
                  "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                  "fieldPath": "string"
                }
              ]
            },
            "predefinedItem": "PREDEFINED_ITEM_UNSPECIFIED",
            "secondValue": {
              "fields": [
                {
                  "dateFormat": "DATE_FORMAT_UNSPECIFIED",
                  "fieldPath": "string"
                }
              ]
            }
          }
        }
      ]
    },
    "listTemplateOverride": {
      "firstRowOption": {
        "fieldOption": {
          "fields": [
            {
              "dateFormat": "DATE_FORMAT_UNSPECIFIED",
              "fieldPath": "string"
            }
          ]
        },
        "transitOption": "TRANSIT_OPTION_UNSPECIFIED"
      },
      "secondRowOption": {
        "fields": [
          {
            "dateFormat": "DATE_FORMAT_UNSPECIFIED",
            "fieldPath": "string"
          }
        ]
      },
      "thirdRowOption": {
        "fields": [
          {
            "dateFormat": "DATE_FORMAT_UNSPECIFIED",
            "fieldPath": "string"
          }
        ]
      }
    }
  },
  "countryCode": "string",
  "discoverableProgram": {
    "merchantSigninInfo": {
      "signinWebsite": {
        "description": "string",
        "id": "string",
        "kind": "string",
        "localizedDescription": {
          "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
          },
          "kind": "string",
          "translatedValues": [
            {
              "kind": "string",
              "language": "string",
              "value": "string"
            }
          ]
        },
        "uri": "string"
      }
    },
    "merchantSignupInfo": {
      "signupSharedDatas": [
        "SHARED_DATA_TYPE_UNSPECIFIED"
      ],
      "signupWebsite": {
        "description": "string",
        "id": "string",
        "kind": "string",
        "localizedDescription": {
          "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
          },
          "kind": "string",
          "translatedValues": [
            {
              "kind": "string",
              "language": "string",
              "value": "string"
            }
          ]
        },
        "uri": "string"
      }
    },
    "state": "STATE_UNSPECIFIED"
  },
  "enableSmartTap": true,
  "heroImage": {
    "kind": "string",
    "sourceUri": {
      "description": "string",
      "localizedDescription": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "uri": "string"
    }
  },
  "hexBackgroundColor": "string",
  "homepageUri": {
    "description": "string",
    "id": "string",
    "kind": "string",
    "localizedDescription": {
      "defaultValue": {
        "kind": "string",
        "language": "string",
        "value": "string"
      },
      "kind": "string",
      "translatedValues": [
        {
          "kind": "string",
          "language": "string",
          "value": "string"
        }
      ]
    },
    "uri": "string"
  },
  "id": "string",
  "imageModulesData": [
    {
      "id": "string",
      "mainImage": {
        "kind": "string",
        "sourceUri": {
          "description": "string",
          "localizedDescription": {
            "defaultValue": {
              "kind": "string",
              "language": "string",
              "value": "string"
            },
            "kind": "string",
            "translatedValues": [
              {
                "kind": "string",
                "language": "string",
                "value": "string"
              }
            ]
          },
          "uri": "string"
        }
      }
    }
  ],
  "infoModuleData": {
    "labelValueRows": [
      {
        "columns": [
          {
            "label": "string",
            "localizedLabel": {
              "defaultValue": {
                "kind": "string",
                "language": "string",
                "value": "string"
              },
              "kind": "string",
              "translatedValues": [
                {
                  "kind": "string",
                  "language": "string",
                  "value": "string"
                }
              ]
            },
            "localizedValue": {
              "defaultValue": {
                "kind": "string",
                "language": "string",
                "value": "string"
              },
              "kind": "string",
              "translatedValues": [
                {
                  "kind": "string",
                  "language": "string",
                  "value": "string"
                }
              ]
            },
            "value": "string"
          }
        ]
      }
    ],
    "showLastUpdateTime": true
  },
  "issuerName": "string",
  "kind": "string",
  "linksModuleData": {
    "uris": [
      {
        "description": "string",
        "id": "string",
        "kind": "string",
        "localizedDescription": {
          "defaultValue": {
            "kind": "string",
            "language": "string",
            "value": "string"
          },
          "kind": "string",
          "translatedValues": [
            {
              "kind": "string",
              "language": "string",
              "value": "string"
            }
          ]
        },
        "uri": "string"
      }
    ]
  },
  "localizedAccountIdLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "localizedAccountNameLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "localizedIssuerName": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "localizedProgramName": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "localizedRewardsTier": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "localizedRewardsTierLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "localizedSecondaryRewardsTier": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "localizedSecondaryRewardsTierLabel": {
    "defaultValue": {
      "kind": "string",
      "language": "string",
      "value": "string"
    },
    "kind": "string",
    "translatedValues": [
      {
        "kind": "string",
        "language": "string",
        "value": "string"
      }
    ]
  },
  "locations": [
    {
      "kind": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "messages": [
    {
      "body": "string",
      "displayInterval": {
        "end": {
          "date": "string"
        },
        "kind": "string",
        "start": {
          "date": "string"
        }
      },
      "header": "string",
      "id": "string",
      "kind": "string",
      "localizedBody": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedHeader": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "messageType": "MESSAGE_TYPE_UNSPECIFIED"
    }
  ],
  "multipleDevicesAndHoldersAllowedStatus": "STATUS_UNSPECIFIED",
  "programLogo": {
    "kind": "string",
    "sourceUri": {
      "description": "string",
      "localizedDescription": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "uri": "string"
    }
  },
  "programName": "string",
  "redemptionIssuers": [
    "string"
  ],
  "review": {
    "comments": "string"
  },
  "reviewStatus": "REVIEW_STATUS_UNSPECIFIED",
  "rewardsTier": "string",
  "rewardsTierLabel": "string",
  "secondaryRewardsTier": "string",
  "secondaryRewardsTierLabel": "string",
  "textModulesData": [
    {
      "body": "string",
      "header": "string",
      "id": "string",
      "localizedBody": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "localizedHeader": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "version": "string",
  "wordMark": {
    "kind": "string",
    "sourceUri": {
      "description": "string",
      "localizedDescription": {
        "defaultValue": {
          "kind": "string",
          "language": "string",
          "value": "string"
        },
        "kind": "string",
        "translatedValues": [
          {
            "kind": "string",
            "language": "string",
            "value": "string"
          }
        ]
      },
      "uri": "string"
    }
  }
}

Request

Body Params application/json
accountIdLabel
string 
optional
The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
accountNameLabel
string 
optional
The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
allowMultipleUsersPerObject
boolean 
optional
Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
callbackOptions
object (CallbackOptions) 
optional
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.
updateRequestUrl
string 
optional
URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. Please contact Google support before using this field.
url
string 
optional
The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables.
classTemplateInfo
object (ClassTemplateInfo) 
optional
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
cardBarcodeSectionDetails
object (CardBarcodeSectionDetails) 
optional
Specifies extra information to be displayed above and below the barcode.
cardTemplateOverride
object (CardTemplateOverride) 
optional
Override for the card view.
detailsTemplateOverride
object (DetailsTemplateOverride) 
optional
Override for the details view (beneath the card view).
listTemplateOverride
object (ListTemplateOverride) 
optional
Override for the passes list view.
countryCode
string 
optional
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.
discoverableProgram
object (DiscoverableProgram) 
optional
Information about how the class may be discovered and instantiated from within the Google Pay app.
merchantSigninInfo
object (DiscoverableProgramMerchantSigninInfo) 
optional
Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
merchantSignupInfo
object (DiscoverableProgramMerchantSignupInfo) 
optional
Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
state
enum<string> 
optional
Visibility state of the discoverable program.
Allowed values:
STATE_UNSPECIFIEDTRUSTED_TESTERStrustedTestersLIVEliveDISABLEDdisabled
enableSmartTap
boolean 
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
heroImage
object (Image) 
optional
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.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
sourceUri
object (ImageUri) 
optional
The URI for the image.
hexBackgroundColor
string 
optional
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.
homepageUri
object (Uri) 
optional
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).
id
string 
optional
Required. 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
array[object (ImageModuleData) {2}] 
optional
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
id
string 
optional
The ID associated with an image module. This field is here to enable ease of management of image modules.
mainImage
object (Image) 
optional
A 100% width image.
infoModuleData
object (InfoModuleData) 
optional
Deprecated. Use textModulesData instead.
labelValueRows
array[object (LabelValueRow) {1}] 
optional
A list of collections of labels and values. These will be displayed one after the other in a singular column.
showLastUpdateTime
boolean 
optional
issuerName
string 
optional
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyClass".
linksModuleData
object (LinksModuleData) 
optional
Links module data. If links module data is also defined on the object, both will be displayed.
uris
array[object (Uri) {5}] 
optional
The list of URIs.
localizedAccountIdLabel
object (LocalizedString) 
optional
Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
localizedAccountNameLabel
object (LocalizedString) 
optional
Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
localizedIssuerName
object (LocalizedString) 
optional
Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
localizedProgramName
object (LocalizedString) 
optional
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.
localizedRewardsTier
object (LocalizedString) 
optional
Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
localizedRewardsTierLabel
object (LocalizedString) 
optional
Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
localizedSecondaryRewardsTier
object (LocalizedString) 
optional
Translated strings for the secondary_rewards_tier.
localizedSecondaryRewardsTierLabel
object (LocalizedString) 
optional
Translated strings for the secondary_rewards_tier_label.
locations
array[object (LatLongPoint) {3}] 
optional
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.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".
latitude
number <double>
optional
The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
longitude
number <double>
optional
The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
messages
array[object (Message) {8}] 
optional
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.
body
string 
optional
The message body.
displayInterval
object (TimeInterval) 
optional
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.
header
string 
optional
The message header.
id
string 
optional
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.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
localizedBody
object (LocalizedString) 
optional
Translated strings for the message body.
localizedHeader
object (LocalizedString) 
optional
Translated strings for the message header.
messageType
enum<string> 
optional
The type of the message. Currently, this can only be set for offers.
Allowed values:
MESSAGE_TYPE_UNSPECIFIEDTEXTtextEXPIRATION_NOTIFICATIONexpirationNotification
multipleDevicesAndHoldersAllowedStatus
enum<string> 
optional
Identifies whether multiple users and devices will save the same object referencing this class.
Allowed values:
STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice
programLogo
object (Image) 
optional
Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
programName
string 
optional
Required. 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.
redemptionIssuers
array[string <int64>]
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
review
object (Review) 
optional
The review comments set by the platform when a class is marked approved or rejected.
comments
string 
optional
reviewStatus
enum<string> 
optional
Required. 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.
Allowed values:
REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft
rewardsTier
string 
optional
The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
rewardsTierLabel
string 
optional
The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
secondaryRewardsTier
string 
optional
The secondary rewards tier, such as "Gold" or "Platinum."
secondaryRewardsTierLabel
string 
optional
The secondary rewards tier label, such as "Rewards Tier."
textModulesData
array[object (TextModuleData) {5}] 
optional
Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
body
string 
optional
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.
header
string 
optional
The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
id
string 
optional
The ID associated with a text module. This field is here to enable ease of management of text modules.
localizedBody
object (LocalizedString) 
optional
Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
localizedHeader
object (LocalizedString) 
optional
Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
version
string <int64>
optional
Deprecated
wordMark
object (Image) 
optional
Deprecated.
Examples

Responses

🟢200Successful response
application/json
Body
accountIdLabel
string 
optional
The account ID label, such as "Member ID." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
accountNameLabel
string 
optional
The account name label, such as "Member Name." Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
allowMultipleUsersPerObject
boolean 
optional
Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.
callbackOptions
object (CallbackOptions) 
optional
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.
updateRequestUrl
string 
optional
URL for the merchant endpoint that would be called to request updates. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables. Please contact Google support before using this field.
url
string 
optional
The HTTPS url configured by the merchant. The URL should be hosted on HTTPS and robots.txt should allow the URL path to be accessible by UserAgent:Google-Valuables.
classTemplateInfo
object (ClassTemplateInfo) 
optional
Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.
cardBarcodeSectionDetails
object (CardBarcodeSectionDetails) 
optional
Specifies extra information to be displayed above and below the barcode.
cardTemplateOverride
object (CardTemplateOverride) 
optional
Override for the card view.
detailsTemplateOverride
object (DetailsTemplateOverride) 
optional
Override for the details view (beneath the card view).
listTemplateOverride
object (ListTemplateOverride) 
optional
Override for the passes list view.
countryCode
string 
optional
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.
discoverableProgram
object (DiscoverableProgram) 
optional
Information about how the class may be discovered and instantiated from within the Google Pay app.
merchantSigninInfo
object (DiscoverableProgramMerchantSigninInfo) 
optional
Information about the ability to signin and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNIN is enabled.
merchantSignupInfo
object (DiscoverableProgramMerchantSignupInfo) 
optional
Information about the ability to signup and add a valuable for this program through a merchant site. Used when MERCHANT_HOSTED_SIGNUP is enabled.
state
enum<string> 
optional
Visibility state of the discoverable program.
Allowed values:
STATE_UNSPECIFIEDTRUSTED_TESTERStrustedTestersLIVEliveDISABLEDdisabled
enableSmartTap
boolean 
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
heroImage
object (Image) 
optional
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.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#image".
sourceUri
object (ImageUri) 
optional
The URI for the image.
hexBackgroundColor
string 
optional
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.
homepageUri
object (Uri) 
optional
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).
id
string 
optional
Required. 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
array[object (ImageModuleData) {2}] 
optional
Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
id
string 
optional
The ID associated with an image module. This field is here to enable ease of management of image modules.
mainImage
object (Image) 
optional
A 100% width image.
infoModuleData
object (InfoModuleData) 
optional
Deprecated. Use textModulesData instead.
labelValueRows
array[object (LabelValueRow) {1}] 
optional
A list of collections of labels and values. These will be displayed one after the other in a singular column.
showLastUpdateTime
boolean 
optional
issuerName
string 
optional
Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#loyaltyClass".
linksModuleData
object (LinksModuleData) 
optional
Links module data. If links module data is also defined on the object, both will be displayed.
uris
array[object (Uri) {5}] 
optional
The list of URIs.
localizedAccountIdLabel
object (LocalizedString) 
optional
Translated strings for the account_id_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
localizedAccountNameLabel
object (LocalizedString) 
optional
Translated strings for the account_name_label. Recommended maximum length is 15 characters to ensure full string is displayed on smaller screens.
localizedIssuerName
object (LocalizedString) 
optional
Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.
localizedProgramName
object (LocalizedString) 
optional
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.
localizedRewardsTier
object (LocalizedString) 
optional
Translated strings for the rewards_tier. Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
localizedRewardsTierLabel
object (LocalizedString) 
optional
Translated strings for the rewards_tier_label. Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
localizedSecondaryRewardsTier
object (LocalizedString) 
optional
Translated strings for the secondary_rewards_tier.
localizedSecondaryRewardsTierLabel
object (LocalizedString) 
optional
Translated strings for the secondary_rewards_tier_label.
locations
array[object (LatLongPoint) {3}] 
optional
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.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".
latitude
number <double>
optional
The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.
longitude
number <double>
optional
The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.
messages
array[object (Message) {8}] 
optional
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.
body
string 
optional
The message body.
displayInterval
object (TimeInterval) 
optional
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.
header
string 
optional
The message header.
id
string 
optional
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.
kind
string 
optional
Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
localizedBody
object (LocalizedString) 
optional
Translated strings for the message body.
localizedHeader
object (LocalizedString) 
optional
Translated strings for the message header.
messageType
enum<string> 
optional
The type of the message. Currently, this can only be set for offers.
Allowed values:
MESSAGE_TYPE_UNSPECIFIEDTEXTtextEXPIRATION_NOTIFICATIONexpirationNotification
multipleDevicesAndHoldersAllowedStatus
enum<string> 
optional
Identifies whether multiple users and devices will save the same object referencing this class.
Allowed values:
STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice
programLogo
object (Image) 
optional
Required. The logo of the loyalty program or company. This logo is displayed in both the details and list views of the app.
programName
string 
optional
Required. 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.
redemptionIssuers
array[string <int64>]
optional
Available only to Smart Tap enabled partners. Contact support for additional guidance.
review
object (Review) 
optional
The review comments set by the platform when a class is marked approved or rejected.
comments
string 
optional
reviewStatus
enum<string> 
optional
Required. 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.
Allowed values:
REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft
rewardsTier
string 
optional
The rewards tier, such as "Gold" or "Platinum." Recommended maximum length is 7 characters to ensure full string is displayed on smaller screens.
rewardsTierLabel
string 
optional
The rewards tier label, such as "Rewards Tier." Recommended maximum length is 9 characters to ensure full string is displayed on smaller screens.
secondaryRewardsTier
string 
optional
The secondary rewards tier, such as "Gold" or "Platinum."
secondaryRewardsTierLabel
string 
optional
The secondary rewards tier label, such as "Rewards Tier."
textModulesData
array[object (TextModuleData) {5}] 
optional
Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
body
string 
optional
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.
header
string 
optional
The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
id
string 
optional
The ID associated with a text module. This field is here to enable ease of management of text modules.
localizedBody
object (LocalizedString) 
optional
Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
localizedHeader
object (LocalizedString) 
optional
Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
version
string <int64>
optional
Deprecated
wordMark
object (Image) 
optional
Deprecated.
Previous
/walletobjects/v1/loyaltyClass
Next
/walletobjects/v1/loyaltyClass/{resourceId}
Built with