---
title: "Enroll an entity to the Google Pay Service"
method: POST
path: "/googlepay/enrollments"
tags: ["Google Pay"]
---

# Enroll an entity to the Google Pay Service

`POST /googlepay/enrollments`

## Request

- Base URL: `https://{prefix}.api.checkout.com`
- URL: `https://{prefix}.api.checkout.com/googlepay/enrollments`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `string` scopes: `vault:gpayme-enrollment`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/googlepay/enrollments/post.ts> (a function with typed inputs; its response is checked against the schema)

Enroll an entity to the Google Pay Service. 

You must accept the <a href="https://payments.developers.google.com/terms/sellertos">Google terms of service</a> to use this feature.

## Request body

- GooglePayEnrollmentRequest
  - `entity_id` string, required: The unique identifier of the entity to enroll.
  - `email_address` string, required: The email address of the user accepting the <a href=https://payments.developers.google.com/terms/sellertos>Google terms of service</a>.
  - `accept_terms_of_service` boolean, required: Indicates acceptance of the <a href=https://payments.developers.google.com/terms/sellertos>Google terms of service</a>. Must be true to proceed with enrollment.

## Response `201`

Enrolled successfully.

- GooglePayEnrollmentResponse
  - `merchant_id` string: The Google Pay merchant ID associated with the entity.
  - `tos_accepted_time` string, date-time, required: An ISO 8601 timestamp of when the [Google terms of service](https://payments.developers.google.com/terms/sellertos) were accepted.
  - `state` 'ACTIVE' | 'INACTIVE', required: The current enrollment state of the entity.

## Other responses

- `401`: Unauthorized.
- `422`: Invalid request payload.
- `500`: Internal server error.

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)