---
title: "Get enrollment state"
method: GET
path: "/googlepay/enrollments/{entity_id}/state"
tags: ["Google Pay"]
---

# Get enrollment state

`GET /googlepay/enrollments/{entity_id}/state`

## Request

- Base URL: `https://{prefix}.api.checkout.com`
- URL: `https://{prefix}.api.checkout.com/googlepay/enrollments/{entity_id}/state`
- 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/:entity_id/state/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the current enrollment state of an entity.

## Path parameters

- `entity_id` string, required

## Response `200`

Successfully retrieved enrollment state.

- GooglePayEnrollmentStateResponse
  - `state` 'ACTIVE' | 'INACTIVE', required: The current enrollment state of the entity.

## Other responses

- `401`: Unauthorized.
- `404`: Entity not found.
- `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)
