Google Wallet Wallet Media API

The Wallet Media API from Google Wallet — 2 operation(s) for wallet media.

GitHub OpenAPI

Operations 2

POST /walletobjects/v1/transitObject/{resourceId}/uploadRotatingBarcodeValues Upload media #
GET /walletobjects/v1/transitObject/{resourceId}/downloadRotatingBarcodeValues Download media #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/google-wallet:google-wallet-media-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

google-wallet-media-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Google Wallet Media API
  version: v1
  description: Generated from Google's published Discovery document for Google Wallet API (walletobjects v1, revision 20261111). 2 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://walletobjects.googleapis.com
tags:
- name: Media
paths:
  /walletobjects/v1/transitObject/{resourceId}/uploadRotatingBarcodeValues:
    post:
      operationId: walletobjects.media.upload
      summary: Upload media
      description: Uploads rotating barcode values for the transit object referenced by the given object ID. Note the max upload size is specified in google3/production/config/cdd/apps-upload/customers/payments-consumer-passes/config.gcl and enforced by Scotty.
      parameters:
      - name: resourceId
        in: path
        required: true
        description: The unique identifier for an object. This ID must be unique across all objects 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 '-'.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransitObjectUploadRotatingBarcodeValuesRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransitObjectUploadRotatingBarcodeValuesResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/wallet_object.issuer
      - apiKey: []
      x-google-media-upload:
        protocols:
          simple:
            path: /upload/walletobjects/v1/transitObject/{resourceId}/uploadRotatingBarcodeValues
            multipart: true
        accept:
        - '*/*'
      tags:
      - Media
  /walletobjects/v1/transitObject/{resourceId}/downloadRotatingBarcodeValues:
    get:
      operationId: walletobjects.media.download
      summary: Download media
      description: Downloads rotating barcode values for the transit object referenced by the given object ID.
      parameters:
      - name: resourceId
        in: path
        required: true
        description: The unique identifier for an object. This ID must be unique across all objects 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 '-'.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Media'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/wallet_object.issuer
      - apiKey: []
      tags:
      - Media
components:
  schemas:
    MediaRequestInfo:
      type: object
      description: Extra information added to operations that support Scotty media requests.
      properties:
        requestId:
          type: string
          description: The Scotty request ID.
        totalBytesIsEstimated:
          description: Whether the total bytes field contains an estimated data.
          type: boolean
        diffObjectVersion:
          type: string
          description: Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.
        finalStatus:
          description: The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929
          type: integer
          format: int32
        totalBytes:
          description: The total size of the file.
          type: string
          format: int64
        physicalHeaders:
          description: The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs.
          format: byte
          type: string
        notificationType:
          description: The type of notification received from Scotty.
          type: string
          enum:
          - START
          - PROGRESS
          - END
          - RESPONSE_SENT
          - ERROR
        customData:
          description: Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
          type: string
        requestReceivedParamsServingInfo:
          description: The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()
          format: byte
          type: string
        currentBytes:
          description: The number of current bytes uploaded or downloaded.
          type: string
          format: int64
    DiffChecksumsResponse:
      description: Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
      properties:
        chunkSizeBytes:
          description: The chunk size of checksums. Must be a multiple of 256KB.
          type: string
          format: int64
        objectSizeBytes:
          format: int64
          type: string
          description: The total size of the server object.
        objectLocation:
          $ref: '#/components/schemas/CompositeMedia'
          description: If set, calculate the checksums based on the contents and return them to the caller.
        objectVersion:
          type: string
          description: The object version of the object the checksums are being returned for.
        checksumsLocation:
          $ref: '#/components/schemas/CompositeMedia'
          description: Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
      type: object
    ContentTypeInfo:
      description: Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.
      properties:
        fromHeader:
          description: The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
          type: string
        fromUrlPath:
          description: The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
          type: string
        fromFusionId:
          type: string
          description: The content type of the file detected by Fusion ID. go/fusionid
        fusionIdDetectionMetadata:
          format: byte
          description: Metadata information from Fusion ID detection. Serialized FusionIdDetectionMetadata proto. Only set if from_fusion_id is set.
          type: string
        bestGuess:
          type: string
          description: Scotty's best guess of what the content type of the file is.
        fromFileName:
          description: The content type of the file derived from the file extension of the original file name used by the client.
          type: string
        fromBytes:
          type: string
          description: The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
      type: object
    DiffUploadRequest:
      type: object
      properties:
        objectInfo:
          $ref: '#/components/schemas/CompositeMedia'
          description: The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
        objectVersion:
          type: string
          description: The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
        checksumsInfo:
          $ref: '#/components/schemas/CompositeMedia'
          description: The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
      description: A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
    TransitObjectUploadRotatingBarcodeValuesResponse:
      description: Response for uploading rotating barcode values.
      type: object
      properties: {}
    TransitObjectUploadRotatingBarcodeValuesRequest:
      description: Request to upload rotating barcode values.
      properties:
        blob:
          $ref: '#/components/schemas/Media'
          description: A reference to the rotating barcode values payload that was uploaded.
        mediaRequestInfo:
          $ref: '#/components/schemas/MediaRequestInfo'
          description: Extra information about the uploaded media.
      type: object
    Media:
      properties:
        compositeMedia:
          type: array
          description: 'A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.'
          items:
            $ref: '#/components/schemas/CompositeMedia'
        referenceType:
          description: Describes what the field reference contains.
          type: string
          enum:
          - PATH
          - BLOB_REF
          - INLINE
          - GET_MEDIA
          - COMPOSITE_MEDIA
          - BIGSTORE_REF
          - DIFF_VERSION_RESPONSE
          - DIFF_CHECKSUMS_RESPONSE
          - DIFF_DOWNLOAD_RESPONSE
          - DIFF_UPLOAD_REQUEST
          - DIFF_UPLOAD_RESPONSE
          - COSMO_BINARY_REFERENCE
          - ARBITRARY_BYTES
        token:
          description: A unique fingerprint/version id for the media data
          type: string
        algorithm:
          description: Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
          type: string
          deprecated: true
        diffDownloadResponse:
          $ref: '#/components/schemas/DiffDownloadResponse'
          description: Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
        bigstoreObjectRef:
          format: byte
          type: string
          description: Use object_id instead.
          deprecated: true
        cosmoBinaryReference:
          format: byte
          description: A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
          type: string
        blobRef:
          description: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
          format: byte
          type: string
          deprecated: true
        md5Hash:
          format: byte
          description: Scotty-provided MD5 hash for an upload.
          type: string
        path:
          description: Path to the data, set if reference_type is PATH
          type: string
        sha256Hash:
          format: byte
          type: string
          description: Scotty-provided SHA256 hash for an upload.
        contentTypeInfo:
          $ref: '#/components/schemas/ContentTypeInfo'
          description: Extended content type information provided for Scotty uploads.
        objectId:
          $ref: '#/components/schemas/ObjectId'
          description: Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
        downloadParameters:
          $ref: '#/components/schemas/DownloadParameters'
          description: Parameters for a media download.
        mediaId:
          type: string
          description: Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
          format: byte
        diffVersionResponse:
          $ref: '#/components/schemas/DiffVersionResponse'
          description: Set if reference_type is DIFF_VERSION_RESPONSE.
        hashVerified:
          type: boolean
          description: For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
        contentType:
          type: string
          description: MIME type of the data
        sha1Hash:
          type: string
          description: Scotty-provided SHA1 hash for an upload.
          format: byte
        inline:
          type: string
          description: Media data, set if reference_type is INLINE
          format: byte
        diffUploadRequest:
          $ref: '#/components/schemas/DiffUploadRequest'
          description: Set if reference_type is DIFF_UPLOAD_REQUEST.
        timestamp:
          format: uint64
          type: string
          description: Time at which the media data was last updated, in milliseconds since UNIX epoch
        crc32cHash:
          format: uint32
          description: 'For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.'
          type: integer
        length:
          description: Size of the data, in bytes
          type: string
          format: int64
        diffChecksumsResponse:
          $ref: '#/components/schemas/DiffChecksumsResponse'
          description: Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
        filename:
          description: Original file name
          type: string
        isPotentialRetry:
          description: '|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.'
          type: boolean
        blobstore2Info:
          $ref: '#/components/schemas/Blobstore2Info'
          description: Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
        diffUploadResponse:
          $ref: '#/components/schemas/DiffUploadResponse'
          description: Set if reference_type is DIFF_UPLOAD_RESPONSE.
        hash:
          description: 'Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.'
          type: string
          deprecated: true
        sha512Hash:
          type: string
          description: Scotty-provided SHA512 hash for an upload.
          format: byte
      description: A reference to data stored on the filesystem, on GFS or in blobstore.
      type: object
    CompositeMedia:
      description: A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
      properties:
        cosmoBinaryReference:
          format: byte
          description: A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
          type: string
        length:
          type: string
          description: Size of the data, in bytes
          format: int64
        referenceType:
          description: Describes what the field reference contains.
          enum:
          - PATH
          - BLOB_REF
          - INLINE
          - BIGSTORE_REF
          - COSMO_BINARY_REFERENCE
          type: string
        blobRef:
          description: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
          format: byte
          type: string
          deprecated: true
        md5Hash:
          type: string
          description: MD5 hash for the payload.
          format: byte
        crc32cHash:
          type: integer
          description: crc32.c hash for the payload.
          format: uint32
        path:
          type: string
          description: Path to the data, set if reference_type is PATH
        sha1Hash:
          description: SHA-1 hash for the payload.
          type: string
          format: byte
        blobstore2Info:
          $ref: '#/components/schemas/Blobstore2Info'
          description: Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
        inline:
          format: byte
          description: Media data, set if reference_type is INLINE
          type: string
        objectId:
          $ref: '#/components/schemas/ObjectId'
          description: Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    ObjectId:
      type: object
      description: This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.
      properties:
        objectName:
          type: string
          description: The name of the object.
        bucketName:
          description: The name of the bucket to which this object belongs.
          type: string
        generation:
          description: Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
          type: string
          format: int64
    DiffUploadResponse:
      type: object
      properties:
        objectVersion:
          type: string
          description: The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
        originalObject:
          $ref: '#/components/schemas/CompositeMedia'
          description: The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
      description: Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
    Blobstore2Info:
      type: object
      description: Information to read/write to blobstore2.
      properties:
        uploadFragmentListCreationInfo:
          type: string
          format: byte
          description: A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
        blobGeneration:
          format: int64
          description: The blob generation id.
          type: string
        uploadMetadataContainer:
          description: Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
          format: byte
          type: string
        readToken:
          description: The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
          type: string
        downloadReadHandle:
          type: string
          format: byte
          description: Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
        downloadExternalReadToken:
          format: byte
          description: A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
          type: string
        blobId:
          description: The blob id, e.g., /blobstore/prod/playground/scotty
          type: string
    DiffDownloadResponse:
      type: object
      properties:
        objectLocation:
          $ref: '#/components/schemas/CompositeMedia'
          description: The original object location.
      description: Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
    DiffVersionResponse:
      description: Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
      type: object
      properties:
        objectVersion:
          type: string
          description: The version of the object stored at the server.
        objectSizeBytes:
          format: int64
          description: The total size of the server object.
          type: string
    DownloadParameters:
      description: Parameters specific to media downloads.
      properties:
        allowGzipCompression:
          type: boolean
          description: A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
        ignoreRange:
          description: Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
          type: boolean
      type: object
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/wallet_object.issuer: 'Private Service: https://www.googleapis.com/auth/wallet_object.issuer'
externalDocs:
  url: https://developers.google.com/pay/passes
x-provenance:
  method: harvested
  publisher: Google
  source: https://walletobjects.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261111)