Google Pass templates

Create a CWT credential Google Pass template

POST/v2/credentials/compact/digital-pass/google/templates

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.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/digital-pass/google/templates" \  -F template="string" \  -F name="string" \  -F issuerId="string" \  -F serviceAccountClientEmail="string" \  -F serviceAccountPrivateKey="string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "issuerId": "string",    "serviceAccountClientEmail": "string",    "payPassId": "string"  }}

Retrieve all CWT credential Google Pass templates

GET/v2/credentials/compact/digital-pass/google/templates

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact/digital-pass/google/templates"

{  "nextCursor": "string",  "data": [    {      "id": "string",      "passType": "apple",      "name": "string",      "metadata": {        "issuerId": "string",        "serviceAccountClientEmail": "string",        "payPassId": "string"      }    }  ]}

Retrieve a CWT credential Google Pass template

GET/v2/credentials/compact/digital-pass/google/templates/{id}

Retrieves an existing Google Pass template by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Google Pass template ID

Formatuuid

id*string

Template ID

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact/digital-pass/google/templates/string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "issuerId": "string",    "serviceAccountClientEmail": "string",    "payPassId": "string"  }}

Update a CWT credential Google Pass template

PUT/v2/credentials/compact/digital-pass/google/templates/{id}

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.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Google Pass template ID

id*string

Template ID

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/compact/digital-pass/google/templates/string" \  -F template="string" \  -F name="string" \  -F issuerId="string" \  -F serviceAccountClientEmail="string" \  -F serviceAccountPrivateKey="string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "issuerId": "string",    "serviceAccountClientEmail": "string",    "payPassId": "string"  }}

Delete a CWT credential Google Pass template

DELETE/v2/credentials/compact/digital-pass/google/templates/{id}

Deletes an existing Google Pass template by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Google Pass template ID

Formatuuid

id*string

Template ID

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/compact/digital-pass/google/templates/string"

Empty

Create a CWT credential Google Pass template

POST/v2/credentials/compact/digital-pass/google/templates

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

template*file

Includes your template files.

Formatbinary

name*string

Insert a name to identify this Google Pass template.

Length1 <= length <= 1024

issuerId*string

Google Wallet Pass signer issuer ID.

serviceAccountClientEmail*string

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

serviceAccountPrivateKey*string

Private key PEM of the Google Cloud Platform service account.

Response Body

`application/json`

curl -X POST "https://example.com/v2/credentials/compact/digital-pass/google/templates" \  -F template="string" \  -F name="string" \  -F issuerId="string" \  -F serviceAccountClientEmail="string" \  -F serviceAccountPrivateKey="string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "issuerId": "string",    "serviceAccountClientEmail": "string",    "payPassId": "string"  }}

Retrieve all CWT credential Google Pass templates

GET/v2/credentials/compact/digital-pass/google/templates

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

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact/digital-pass/google/templates"

{  "nextCursor": "string",  "data": [    {      "id": "string",      "passType": "apple",      "name": "string",      "metadata": {        "issuerId": "string",        "serviceAccountClientEmail": "string",        "payPassId": "string"      }    }  ]}

Retrieve a CWT credential Google Pass template

GET/v2/credentials/compact/digital-pass/google/templates/{id}

Retrieves an existing Google Pass template by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Google Pass template ID

Formatuuid

id*string

Template ID

Response Body

`application/json`

curl -X GET "https://example.com/v2/credentials/compact/digital-pass/google/templates/string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "issuerId": "string",    "serviceAccountClientEmail": "string",    "payPassId": "string"  }}

Update a CWT credential Google Pass template

PUT/v2/credentials/compact/digital-pass/google/templates/{id}

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Google Pass template ID

id*string

Template ID

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

template*file

Includes your template files.

Formatbinary

name*string

Insert a name to identify this Google Pass template.

Length1 <= length <= 1024

issuerId*string

Google Wallet Pass signer issuer ID.

serviceAccountClientEmail*string

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

serviceAccountPrivateKey*string

Private key PEM of the Google Cloud Platform service account.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/credentials/compact/digital-pass/google/templates/string" \  -F template="string" \  -F name="string" \  -F issuerId="string" \  -F serviceAccountClientEmail="string" \  -F serviceAccountPrivateKey="string"

{  "id": "string",  "passType": "apple",  "name": "string",  "metadata": {    "issuerId": "string",    "serviceAccountClientEmail": "string",    "payPassId": "string"  }}

Delete a CWT credential Google Pass template

DELETE/v2/credentials/compact/digital-pass/google/templates/{id}

Deletes an existing Google Pass template by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_STARTCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESSCREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Google Pass template ID

Formatuuid

id*string

Template ID

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/credentials/compact/digital-pass/google/templates/string"

Empty

Google Pass templates

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

Google Pass templates

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`