MCP Tools Reference: paydeveloper.googleapis.com

Tool: list_pass_classes

Retrieves a comprehensive list of all pass classes registered in the Google Wallet business console associated with the authenticated user. This tool provides essential information for developers managing Wallet passes like loyalty cards, gift cards, or flights.

The following sample demonstrate how to use curl to invoke the list_pass_classes MCP tool.

Curl Request 
                  
curl --location 'https://paydeveloper.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_pass_classes",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Input Schema

Request message for listing pass classes of an issuer.

ListPassClassesRequest

JSON representation 
{
  "issuerId": string,
  "passType": enum (PassType),
  "view": enum (PassClassView)
}
Fields
issuerId

string (int64 format)

Required. The unique identifier of the issuer for which to list pass classes.
passType

enum (PassType)

Optional. The type of pass class to list. If unspecified, all types of pass classes will be returned.
view

enum (PassClassView)

Optional. Specifies the level of detail to be returned for each pass class.

Output Schema

Response message for listing pass classes of an issuer.

ListPassClassesResponse

JSON representation 
{
  "passClasses": [
    {
      object (PassClass)
    }
  ]
}
Fields
passClasses[]

object (PassClass)

The pass classes of the issuer.

PassClass

JSON representation 
{

  // Union field resource can be only one of the following:
  "loyaltyClass": {
    object (LoyaltyClass)
  },
  "giftCardClass": {
    object (GiftCardClass)
  },
  "offerClass": {
    object (OfferClass)
  },
  "eventTicketClass": {
    object (EventTicketClass)
  },
  "flightClass": {
    object (FlightClass)
  },
  "transitClass": {
    object (TransitClass)
  },
  "genericClass": {
    object (GenericClass)
  }
  // End of list of possible types for union field resource.
}
Fields

Union field resource.

resource can be only one of the following:
loyaltyClass

object (LoyaltyClass)

Optional. The loyalty class of the issuer.
giftCardClass

object (GiftCardClass)

Optional. The gift card class of the issuer.
offerClass

object (OfferClass)

Optional. The offer class of the issuer.
eventTicketClass

object (EventTicketClass)

Optional. The event ticket class of the issuer.
flightClass

object (FlightClass)

Optional. The flight class of the issuer.
transitClass

object (TransitClass)

Optional. The transit class of the issuer.
genericClass

object (GenericClass)

Optional. The generic class of the issuer.

LoyaltyClass

JSON representation 
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "programName": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "programLogoUri": string,
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Fields
id

string

Optional. The id of the loyalty class.
issuerName

string

Optional. The issuer name of the loyalty class.
localizedIssuerName

object (LocalizedString)

Optional. The localized issuer name of the loyalty class.
programName

string

Optional. The program name of the loyalty class.
localizedProgramName

object (LocalizedString)

Optional. The localized program name of the loyalty class.
programLogoUri

string

Optional. The program logo of the loyalty class.
hexBackgroundColor

string

Optional. The background color of the loyalty class. The format is a hex color string, e.g. "#RRGGBB".
heroImageUri

string

Optional. The banner image displayed on the front of the loyalty class.
discoverableProgram

object (DiscoverableProgram)

Optional. The information about how the loyalty class may be discovered and instantiated from within Google Wallet.
classTemplateInfo

object (ClassTemplateInfo)

Optional. The template information about how the loyalty class should be displayed.

LocalizedString

JSON representation 
{
  "translatedValues": [
    {
      object (TranslatedString)
    }
  ],
  "defaultValue": {
    object (TranslatedString)
  }
}
Fields
translatedValues[]

object (TranslatedString)

Optional. The translated strings for the string.
defaultValue

object (TranslatedString)

Optional. The string to be displayed if no appropriate translation is available.

TranslatedString

JSON representation 
{
  "languageCode": string,
  "value": string
}
Fields
languageCode

string

Optional. The BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT".
value

string

Optional. The UTF-8 encoded translated string.

DiscoverableProgram

JSON representation 
{
  "merchantSignupInfo": {
    object (MerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (MerchantSigninInfo)
  },
  "state": enum (State)
}
Fields
merchantSignupInfo

object (MerchantSignupInfo)

Optional. The information about the ability to signup and add a valuable for this discoverable program through a merchant site.
merchantSigninInfo

object (MerchantSigninInfo)

Optional. The information about the ability to signin and add a valuable for this discoverable program through a merchant site.
state

enum (State)

Output only. The state of the discoverable program.

MerchantSignupInfo

JSON representation 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Fields
signupWebsite

object (Uri)

Optional. The website to sign up for the discoverable program.
signupSharedDatas[]

enum (SharedDataType)

Optional. The 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.

Uri

JSON representation 
{
  "uri": string,
  "description": string,
  "localizedDescription": {
    object (LocalizedString)
  }
}
Fields
uri

string

Optional. The URI.
description

string

Optional. The URI's title appearing in Google Wallet as text.
localizedDescription

object (LocalizedString)

Optional. The translated strings of the URI's title appearing in Google Wallet as text.

MerchantSigninInfo

JSON representation 
{
  "signinWebsite": {
    object (Uri)
  }
}
Fields
signinWebsite

object (Uri)

Optional. The website to sign in for the discoverable program.

ClassTemplateInfo

JSON representation 
{
  "cardBarcodeSectionDetails": {
    object (CardBarcodeSectionDetails)
  },
  "cardTemplateOverride": {
    object (CardTemplateOverride)
  },
  "detailsTemplateOverride": {
    object (DetailsTemplateOverride)
  },
  "listTemplateOverride": {
    object (ListTemplateOverride)
  }
}
Fields
cardBarcodeSectionDetails

object (CardBarcodeSectionDetails)

Optional. The extra information to be displayed above and below the barcode.
cardTemplateOverride

object (CardTemplateOverride)

Optional. The template override for the card view.
detailsTemplateOverride

object (DetailsTemplateOverride)

Optional. The template override for the details view.
listTemplateOverride

object (ListTemplateOverride)

Optional. The template override for the passes list view.

CardBarcodeSectionDetails

JSON representation 
{
  "firstTopDetail": {
    object (BarcodeSectionDetail)
  },
  "firstBottomDetail": {
    object (BarcodeSectionDetail)
  },
  "secondTopDetail": {
    object (BarcodeSectionDetail)
  }
}
Fields
firstTopDetail

object (BarcodeSectionDetail)

Optional. The optional information to be displayed above the barcode. If secondTopDetail is defined, this will be displayed to the start side of this detail section.
firstBottomDetail

object (BarcodeSectionDetail)

Optional. The optional information to be displayed below the barcode.
secondTopDetail

object (BarcodeSectionDetail)

Optional. The optional second piece of information to be displayed above the barcode. If firstTopDetail is defined, this will be displayed to the end side of this detail section.

BarcodeSectionDetail

JSON representation 
{
  "fieldSelector": {
    object (FieldSelector)
  }
}
Fields
fieldSelector

object (FieldSelector)

Optional. The reference to an existing text-based or image field to be displayed.

FieldSelector

JSON representation 
{
  "fields": [
    {
      object (FieldReference)
    }
  ]
}
Fields
fields[]

object (FieldReference)

Optional. The field references to use with field overrides. If more than one reference is supplied, then the first one that references a non-empty field will be displayed.

FieldReference

JSON representation 
{
  "fieldPath": string,
  "dateFormat": enum (DateFormat)
}
Fields
fieldPath

string

Optional. The path to the field being referenced, prefixed with "object" or "class" and separated with dots.
dateFormat

enum (DateFormat)

Optional. The date format to render date/time fields.

CardTemplateOverride

JSON representation 
{
  "cardRowTemplateInfos": [
    {
      object (CardRowTemplateInfo)
    }
  ]
}
Fields
cardRowTemplateInfos[]

object (CardRowTemplateInfo)

Optional. The template information about rows in the card view. At most three rows are allowed to be specified.

CardRowTemplateInfo

JSON representation 
{

  // Union field row_template can be only one of the following:
  "oneItem": {
    object (CardRowOneItem)
  },
  "twoItems": {
    object (CardRowTwoItems)
  },
  "threeItems": {
    object (CardRowThreeItems)
  }
  // End of list of possible types for union field row_template.
}
Fields
Union field row_template. The template for a row containing one, two, or three items. row_template can be only one of the following:
oneItem

object (CardRowOneItem)

Optional. The template for a row containing one item.
twoItems

object (CardRowTwoItems)

Optional. The template for a row containing two items.
threeItems

object (CardRowThreeItems)

Optional. The template for a row containing three items.

CardRowOneItem

JSON representation 
{
  "item": {
    object (TemplateItem)
  }
}
Fields
item

object (TemplateItem)

Optional. The item to be displayed in the row. This item will be centered.

TemplateItem

JSON representation 
{
  "firstValue": {
    object (FieldSelector)
  },
  "secondValue": {
    object (FieldSelector)
  },
  "predefinedItem": enum (PredefinedItem)
}
Fields
firstValue

object (FieldSelector)

Optional. The reference to the first field to be displayed.
secondValue

object (FieldSelector)

Optional. The reference to the second field to be displayed.
predefinedItem

enum (PredefinedItem)

Optional. The predefined item to be displayed.

CardRowTwoItems

JSON representation 
{
  "startItem": {
    object (TemplateItem)
  },
  "endItem": {
    object (TemplateItem)
  }
}
Fields
startItem

object (TemplateItem)

Optional. The item to be displayed at the start of the row. This item will be aligned to the left.
endItem

object (TemplateItem)

Optional. The item to be displayed at the end of the row. This item will be aligned to the right.

CardRowThreeItems

JSON representation 
{
  "startItem": {
    object (TemplateItem)
  },
  "middleItem": {
    object (TemplateItem)
  },
  "endItem": {
    object (TemplateItem)
  }
}
Fields
startItem

object (TemplateItem)

Optional. The item to be displayed at the start of the row. This item will be aligned to the left.
middleItem

object (TemplateItem)

Optional. The item to be displayed in the middle of the row. This item will be centered between the start and end items.
endItem

object (TemplateItem)

Optional. The item to be displayed at the end of the row. This item will be aligned to the right.

DetailsTemplateOverride

JSON representation 
{
  "detailsItemInfos": [
    {
      object (DetailsItemInfo)
    }
  ]
}
Fields
detailsItemInfos[]

object (DetailsItemInfo)

Optional. The template information about the items displayed in the details list.

DetailsItemInfo

JSON representation 
{
  "item": {
    object (TemplateItem)
  }
}
Fields
item

object (TemplateItem)

Optional. The item to be displayed in the details list.

ListTemplateOverride

JSON representation 
{
  "firstRowOption": {
    object (FirstRowOption)
  },
  "secondRowOption": {
    object (FieldSelector)
  }
}
Fields
firstRowOption

object (FirstRowOption)

Optional. The reference to the field to be displayed in the first row.
secondRowOption

object (FieldSelector)

Optional. The reference to the field to be displayed in the second row.

FirstRowOption

JSON representation 
{
  "transitOption": enum (TransitOption),
  "fieldOption": {
    object (FieldSelector)
  }
}
Fields
transitOption

enum (TransitOption)

Optional. The transit option to be displayed in the first row.
fieldOption

object (FieldSelector)

Optional. The reference to the field to be displayed in the first row.

GiftCardClass

JSON representation 
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "merchantName": string,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "programLogoUri": string,
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "homePageUri": {
    object (Uri)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Fields
id

string

Optional. The id of the gift card class.
issuerName

string

Optional. The issuer name of the gift card class.
localizedIssuerName

object (LocalizedString)

Optional. The localized issuer name of the gift card class.
merchantName

string

Optional. The merchant name of the gift card class.
localizedMerchantName

object (LocalizedString)

Optional. The localized merchant name of the gift card class.
programLogoUri

string

Optional. The program logo of the gift card class.
hexBackgroundColor

string

Optional. The background color of the gift card class. The format is a hex color string, e.g. "#RRGGBB".
heroImageUri

string

Optional. The banner image displayed on the front of the gift card class.
homePageUri

object (Uri)

Optional. The website of the application's home page.
classTemplateInfo

object (ClassTemplateInfo)

Optional. The template information about how the gift card class should be displayed.

OfferClass

JSON representation 
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "provider": string,
  "localizedProvider": {
    object (LocalizedString)
  },
  "title": string,
  "localizedTitle": {
    object (LocalizedString)
  },
  "titleImageUri": string,
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "redemptionChannel": enum (RedemptionChannel),
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Fields
id

string

Optional. The id of the offer class.
issuerName

string

Optional. The issuer name of the offer class.
localizedIssuerName

object (LocalizedString)

Optional. The localized issuer name of the offer class.
provider

string

Optional. The provider of the offer class.
localizedProvider

object (LocalizedString)

Optional. The localized provider of the offer class.
title

string

Optional. The title of the offer class.
localizedTitle

object (LocalizedString)

Optional. The localized title of the offer class.
titleImageUri

string

Optional. The title image of the offer class.
hexBackgroundColor

string

Optional. The background color of the offer class. The format is a hex color string, e.g. "#RRGGBB".
heroImageUri

string

Optional. The banner image displayed on the front of the offer class.
redemptionChannel

enum (RedemptionChannel)

Optional. The redemption channel of the offer class.
classTemplateInfo

object (ClassTemplateInfo)

Optional. The template information about how the offer class should be displayed.

EventTicketClass

JSON representation 
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "logoUri": string,
  "eventName": {
    object (LocalizedString)
  },
  "venue": {
    object (EventVenue)
  },
  "dateTime": {
    object (EventDateTime)
  },
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Fields
id

string

Optional. The id of the event ticket class.
issuerName

string

Optional. The issuer name of the event ticket class.
localizedIssuerName

object (LocalizedString)

Optional. The localized issuer name of the event ticket class.
logoUri

string

Optional. The logo of the event ticket class.
eventName

object (LocalizedString)

Optional. The name of the event.
venue

object (EventVenue)

Optional. The venue of the event.
dateTime

object (EventDateTime)

Optional. The information about the date and time of the event.
hexBackgroundColor

string

Optional. The background color of the event ticket class. The format is a hex color string, e.g. "#RRGGBB".
heroImageUri

string

Optional. The banner image displayed on the front of the event ticket class.
classTemplateInfo

object (ClassTemplateInfo)

Optional. The template information about how the event ticket class should be displayed.

EventVenue

JSON representation 
{
  "name": {
    object (LocalizedString)
  },
  "address": {
    object (LocalizedString)
  }
}
Fields
name

object (LocalizedString)

Optional. The name of the venue.
address

object (LocalizedString)

Optional. The address of the venue.

EventDateTime

JSON representation 
{
  "start": string,
  "end": string
}
Fields
start

string

Optional. The date/time when the event starts. If the event spans multiple days, it should be the start date/time on the first day. The format is an ISO 8601 extended format date/time without an offset, and the time may be specified up to millisecond precision, e.g. 2027-03-05T06:30:00.
end

string

Optional. The date/time when the event ends. If the event spans multiple days, it should be the end date/time on the last day. The format is an ISO 8601 extended format date/time without an offset, and the time may be specified up to millisecond precision, e.g. 2027-03-05T06:30:00.

FlightClass

JSON representation 
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "flightHeader": {
    object (FlightHeader)
  },
  "origin": {
    object (AirportInfo)
  },
  "destination": {
    object (AirportInfo)
  },
  "localScheduledDepartureDateTime": string,
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Fields
id

string

Optional. The id of the flight class.
issuerName

string

Optional. The issuer name of the flight class.
localizedIssuerName

object (LocalizedString)

Optional. The localized issuer name of the flight class.
flightHeader

object (FlightHeader)

Optional. The information about the flight carrier and number.
origin

object (AirportInfo)

Optional. The information about the origin airport.
destination

object (AirportInfo)

Optional. The information about the destination airport.
localScheduledDepartureDateTime

string

Optional. The scheduled date and time when the aircraft is expected to depart the gate (not the runway). The format is an ISO 8601 extended format date/time without an offset, and the time may be specified up to millisecond precision, e.g. 2027-03-05T06:30:00. This should be the local date/time at the airport (not a UTC time).
hexBackgroundColor

string

Optional. The background color of the flight class. The format is a hex color string, e.g. "#RRGGBB".
heroImageUri

string

Optional. The banner image displayed on the front of the flight class.
classTemplateInfo

object (ClassTemplateInfo)

Optional. The template information about how the flight class should be displayed.

FlightHeader

JSON representation 
{
  "carrier": {
    object (FlightCarrier)
  },
  "flightNumber": string
}
Fields
carrier

object (FlightCarrier)

Optional. The information about the flight carrier.
flightNumber

string

Optional. The flight number without the carrier IATA code. The field contains only digits, e.g. "123".

FlightCarrier

JSON representation 
{
  "carrierIataCode": string,
  "carrierIcaoCode": string,
  "airlineLogoUri": string
}
Fields
carrierIataCode

string

Optional. The two character IATA airline code of the carrier.
carrierIcaoCode

string

Optional. The three character ICAO airline code of the carrier.
airlineLogoUri

string

Optional. The logo of the airline described by the carrier IATA code.

AirportInfo

JSON representation 
{
  "airportIataCode": string,
  "terminal": string,
  "gate": string
}
Fields
airportIataCode

string

Optional. The three character IATA airport code, e.g. "SFO".
terminal

string

Optional. The terminal name, e.g. "I".
gate

string

Optional. The gate name, e.g. "B59".

TransitClass

JSON representation 
{
  "id": string,
  "issuerName": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "hexBackgroundColor": string,
  "heroImageUri": string,
  "transitType": enum (TransitType),
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Fields
id

string

Optional. The id of the transit class.
issuerName

string

Optional. The issuer name of the transit class.
localizedIssuerName

object (LocalizedString)

Optional. The localized issuer name of the transit class.
hexBackgroundColor

string

Optional. The background color of the transit class. The format is a hex color string, e.g. "#RRGGBB".
heroImageUri

string

Optional. The banner image displayed on the front of the transit class.
transitType

enum (TransitType)

Optional. The transit type of the transit class.
classTemplateInfo

object (ClassTemplateInfo)

Optional. The template information about how the transit class should be displayed.

GenericClass

JSON representation 
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  }
}
Fields
id

string

Optional. The id of the generic class.
classTemplateInfo

object (ClassTemplateInfo)

Optional. The template information about how the generic class should be displayed.

Tool Annotations

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌