REST Resource: termsOfService

  • The TermsOfService message outlines the legal agreements merchants must accept to use specific features or services.

  • Merchants can access and accept the latest terms of service through dedicated methods like termsOfService.retrieveLatest and termsOfService.accept.

  • The TermsOfService message includes details like region code, kind, external status, and a file URI for the terms of service document.

  • Important fields within the TermsOfService message include name, region code, kind, external status, and file URI.

  • Several methods are available for interacting with terms of service, including accepting, retrieving a specific version, and retrieving the latest version.

Resource: TermsOfService

The TermsOfService message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see Terms of Service.

This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given kind and region through termsOfService.retrieveLatest, and accept them as required through termsOfService.accept.

JSON representation 
{
  "name": string,
  "regionCode": string,
  "kind": enum (TermsOfServiceKind),
  "external": boolean,
  "fileUri": string
}
Fields
name

string

Identifier. The resource name of the terms of service version. Format: termsOfService/{version}
regionCode

string

Region code as defined by CLDR. This is either a country where the ToS applies specifically to that country or 001 when the same TermsOfService can be signed in any country. However note that when signing a ToS that applies globally we still expect that a specific country is provided (this should be merchant business country or program country of participation).
kind

enum (TermsOfServiceKind)

The Kind this terms of service version applies to.
external

boolean

Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API.
fileUri

string

URI for terms of service file that needs to be displayed to signing users.

Methods

accept

 Accepts a TermsOfService.

get

 Retrieves the TermsOfService associated with the provided version.

retrieveLatest

 Retrieves the latest version of the TermsOfService for a given kind and region_code.