Google Pay

Manage your domain enrollments to process payments via Google Pay.

Enroll an entity to the Google Pay Service

Enroll an entity to the Google Pay Service.

You must accept the Google terms of service to use this feature.

SecurityOAuth2: OAuth
Request
Request Body schema: application/json
entity_id
required
string

The unique identifier of the entity to enroll.

email_address
required
string

The email address of the user accepting the Google terms of service.

accept_terms_of_service
required
boolean

Indicates acceptance of the Google terms of service. Must be true to proceed with enrollment.

Responses
201

Enrolled successfully.

401

Unauthorized.

422

Invalid request payload.

500

Internal server error.

post/googlepay/enrollments
Request samples
application/json
{
  • "entity_id": "ent_uzm3uxtssvmuxnyrfdffcyjxeu",
  • "email_address": "test@gmail.com",
  • "accept_terms_of_service": true
}
Response samples
application/json
{
  • "tosAcceptedTime": "2014-10-02T15:01:23Z",
  • "state": "ACTIVE"
}

Register a web domain for an enrolled entity

Associates a web domain with the specified enrolled entity.

SecurityOAuth2: OAuth
Request
path Parameters
entity_id
required
string

Unique identifier of the entity.

Request Body schema: application/json
web_domain
required
string <hostname>

The web domain to register for an actively enrolled entity.

Responses
204

Domain registered successfully (no content).

401

Unauthorized.

404

Entity not found.

422

Invalid domain format or missing parameter.

500

Internal server error.

post/googlepay/enrollments/{entity_id}/domain
Request samples
application/json
{
  • "web_domain": "some.example.com"
}
Response samples
application/json
{
  • "error_codes": [
    ],
  • "error_type": "invalid_request",
  • "request_id": "string"
}

Get registered domains for an entity

Retrieves all web domains registered for the specified entity.

SecurityOAuth2: OAuth
Request
path Parameters
entity_id
required
string

Unique identifier of the entity.

Responses
200

Successfully retrieved list of domains.

401

Unauthorized.

404

Entity was not found or no domains are registered.

500

Internal server error.

get/googlepay/enrollments/{entity_id}/domains
Request samples
Response samples
application/json
{
  • "domains": [
    ]
}

Get enrollment state

Returns the current enrollment state of an entity.

SecurityOAuth2: OAuth
Request
path Parameters
entity_id
required
string

Unique identifier of the entity.

Responses
200

Successfully retrieved enrollment state.

401

Unauthorized.

404

Entity not found.

500

Internal server error.

get/googlepay/enrollments/{entity_id}/state
Request samples
Response samples
application/json
{
  • "state": "ACTIVE"
}