light-mode-image
Learn
API Reference

Google Pass templates

Create a CWT credential Google Pass template

Create a Google Pass template

Creates a Google Pass template based on the provided .zip file. Refer to our Design a Google Pass template guide for more information on how to design the template and how to structure the .zip file.

Analytic events

  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_START
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_FAIL
POST/v2/credentials/compact/digital-pass/google/templates

Authorization

AuthorizationBearer <token>

In: header

Request Body

templatefile

Includes your template files.

Formatbinary
namestring

Insert a name to identify this Google Pass template.

Length1 <= length <= 1024
issuerIdstring

Google Wallet Pass signer issuer ID.

serviceAccountClientEmailstring

Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.

serviceAccountPrivateKeystring

Private key PEM of the Google Cloud Platform service account.

curl -X POST "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/google/templates" \  -F template="string" \  -F name="Certificate of participation" \  -F issuerId="3388000000012346000" \  -F serviceAccountClientEmail="app-user@myproject.iam.gserviceaccount.com" \  -F serviceAccountPrivateKey="string"
{
  "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  "passType": "apple",
  "name": "Certificate of participation",
  "metadata": {
    "issuerId": "3388000000012346000",
    "serviceAccountClientEmail": "app-user@myproject.iam.gserviceaccount.com",
    "payPassId": "3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"
  }
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve all CWT credential Google Pass templates

Retrieve all Google Pass templates

Retrieves a list of all Google Pass templates available on your tenant.

Analytic events

  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL
GET/v2/credentials/compact/digital-pass/google/templates

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/google/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h",
  "data": [
    {
      "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
      "passType": "apple",
      "name": "Certificate of participation",
      "metadata": {
        "issuerId": "3388000000012346000",
        "serviceAccountClientEmail": "app-user@myproject.iam.gserviceaccount.com",
        "payPassId": "3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"
      }
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve a CWT credential Google Pass template

Retrieve a Google Pass template

Retrieves an existing Google Pass template by providing its ID.

Analytic events

  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_START
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL
GET/v2/credentials/compact/digital-pass/google/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Google Pass template ID

Formatuuid
idstring

Template ID

curl -X GET "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/google/templates/string"
{
  "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  "passType": "apple",
  "name": "Certificate of participation",
  "metadata": {
    "issuerId": "3388000000012346000",
    "serviceAccountClientEmail": "app-user@myproject.iam.gserviceaccount.com",
    "payPassId": "3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"
  }
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Update a CWT credential Google Pass template

Update a Google Pass template

Updates a existing Google Pass template by providing its ID and a .zip file. Refer to our Design a Google Pass template guide for more information on how to design the template and how to structure the .zip file.

Analytic events

  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_START
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL
PUT/v2/credentials/compact/digital-pass/google/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Google Pass template ID

idstring

Template ID

Request Body

templatefile

Includes your template files.

Formatbinary
namestring

Insert a name to identify this Google Pass template.

Length1 <= length <= 1024
issuerIdstring

Google Wallet Pass signer issuer ID.

serviceAccountClientEmailstring

Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.

serviceAccountPrivateKeystring

Private key PEM of the Google Cloud Platform service account.

curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/google/templates/string" \  -F template="string" \  -F name="Certificate of participation" \  -F issuerId="3388000000012346000" \  -F serviceAccountClientEmail="app-user@myproject.iam.gserviceaccount.com" \  -F serviceAccountPrivateKey="string"
{
  "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  "passType": "apple",
  "name": "Certificate of participation",
  "metadata": {
    "issuerId": "3388000000012346000",
    "serviceAccountClientEmail": "app-user@myproject.iam.gserviceaccount.com",
    "payPassId": "3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"
  }
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete a CWT credential Google Pass template

Delete a Google Pass template

Deletes an existing Google Pass template by providing its ID.

Analytic events

  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_START
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS
  • CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_FAIL
DELETE/v2/credentials/compact/digital-pass/google/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Google Pass template ID

Formatuuid
idstring

Template ID

curl -X DELETE "https://example.vii.au01.mattr.global/v2/credentials/compact/digital-pass/google/templates/string"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Apple Pass templates

Previous Page

Issuance

Next Page

On this page

Create a CWT credential Google Pass templateRetrieve all CWT credential Google Pass templatesRetrieve a CWT credential Google Pass templateUpdate a CWT credential Google Pass templateDelete a CWT credential Google Pass template