Common API data types

Common API Types used within multiple API resources.

References

Reference

A Reference represents a loose reference to another resource in the same Project identified by its id. The typeId indicates the type of the referenced resource. Each resource type has its corresponding Reference type, like ApplicationReference.

`id` String	Unique ID of the referenced resource.
`typeId` ReferenceTypeId	Type of referenced resource.

{
  "typeId": "application",
  "id": "d1229e6f-2b79-441e-b419-180311e52754"
}

ResourceIdentifier

Draft type to create a Reference to a resource. Provide either the id or (wherever supported) the key of the resource to reference, but depending on the API endpoint the response returns a Reference.

Each resource type has its corresponding ResourceIdentifier, like PaymentResourceIdentifier.

`id` String	Unique identifier of the referenced resource. Required if `key` is absent.
`typeId` ReferenceTypeId	Type of referenced resource. If given, it must match the expected ReferenceTypeId of the referenced resource.
`key` String	User-defined unique identifier of the referenced resource. Required if `id` is absent.

ReferenceTypeId

Type of resource the value should reference. Supported resource type identifiers are:

cart: References a Cart.
order: References an Order.
payment: References a Payment.
application: References an Application.
payment-integration: References a Payment Integration.
deployment: References a Connector Deployment.

Representations

CartResourceIdentifier

OrderResourceIdentifier

PaymentResourceIdentifier

Amount

Money in cent amounts for a specific currency.

`centAmount` Int	Amount in the smallest indivisible unit of a currency, such as: Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as `500`). The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as `5`).
`currencyCode` String	Currency code compliant to ISO 4217. Pattern: `^[A-Z]{3}$`

Region

The Region in which the Checkout application is hosted.

europe-west1.gcp: for Europe (Google Cloud, Belgium)
eu-central-1.aws: for Europe (AWS, Frankfurt)
us-central1.gcp: for North America (Google Cloud, Iowa)
us-east-2.aws: for North America (AWS, Ohio)
australia-southeast1.gcp: for Australia (Google Cloud, Sydney)

DateTime

A DateTime is a JSON string representation of UTC date & time in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ), for example:

"2018-10-12T14:00:00.000Z"

CartReference

Reference to a Cart.

`id` String	Unique identifier of the referenced Cart.
`typeId` ReferenceTypeId	`cart` Type of referenced resource.

OrderReference

Reference to an Order.

`id` String	Unique identifier of the referenced Order.
`typeId` ReferenceTypeId	`order` Type of referenced resource.

PaymentReference

Reference to a Payment.

`id` String	Unique identifier of the referenced Payment.
`typeId` ReferenceTypeId	`payment` Type of referenced resource.

CartResourceIdentifier

Resource identifier to a Cart. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

`id` String	Unique identifier of the referenced Cart. Required if `key` is absent.
`typeId` ReferenceTypeId	`cart` Type of referenced resource. If given, it must match the expected ReferenceTypeId of the referenced resource.
`key` String	User-defined unique identifier of the referenced Cart. Required if `id` is absent.

OrderResourceIdentifier

Resource identifier to an Order. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

`id` String	Unique identifier of the referenced Order. Required if `key` is absent.
`typeId` ReferenceTypeId	`order` Type of referenced resource. If given, it must match the expected ReferenceTypeId of the referenced resource.
`key` String	User-defined unique identifier of the referenced Order. Required if `id` is absent.

PaymentResourceIdentifier

Resource identifier to a Payment. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

`id` String	Unique identifier of the referenced Payment. Required if `key` is absent.
`typeId` ReferenceTypeId	`payment` Type of referenced resource. If given, it must match the expected ReferenceTypeId of the referenced resource.
`key` String	User-defined unique identifier of the referenced Payment. Required if `id` is absent.

Localization

CountryCode

Two-digit country code as per ISO 3166-1 alpha-2.

CurrencyCode

Currency code compliant to ISO 4217.

Locale

String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

LocalizedString

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

/^[a-z]{2}(-[A-Z]{2})?$/

Any string parameter matching this regular expression

String used for the specified language.

LocalizedUrl

A localized URL that provides different URL values for different locales.

/^https?://[^s/$.?#].[^s]*$/

Any string parameter matching this regular expression

URL for the specific Locale.

{
  "en": "https://example.com/en",
  "de": "https://example.com/de"
}

Client logging

These objects represent information about which API Client created or modified a resource. For more information, see Client Logging.

CreatedBy

LastModifiedBy

CreatedBy

Information regarding IDs and references that created the Payment Integration.

`clientId` String	ID of the API client that created the PaymentIntegration.
`externalUserId` String	External user ID that created the PaymentIntegration.
`customer` Reference	Customer reference if created by a customer.
`anonymousId` String	Anonymous ID if created by an anonymous user.

LastModifiedBy

Information regarding IDs and references that last modified the Payment Integration.

`clientId` String	ID of the API client that last modified the PaymentIntegration.
`sessionId` String	Session ID associated with the modification of the PaymentIntegration.
`externalUserId` String	External user ID that last modified the PaymentIntegration.
`anonymousId` String	Anonymous ID if the resource was last modified by an anonymous user.
`customer` Reference	Customer reference or customer ID if the resource was last modified by a customer.
`associate` Reference	Associate (customer) reference if the resource was last modified by an associate.
`user` Reference	User reference if the resource was last modified by a platform user.
`isPlatformClient` Boolean	Indicates whether the resource was last modified by a platform client.

Common API data types

References.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Reference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ReferenceTypeId.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Representations.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Amount.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Region.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DateTime.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

CartReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

OrderReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

PaymentReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

CartResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

OrderResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

PaymentResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Localization.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

CountryCode.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

CurrencyCode.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Locale.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

LocalizedString.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

LocalizedUrl.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Client logging.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

CreatedBy.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

LastModifiedBy.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

References

Reference

ResourceIdentifier

ReferenceTypeId

Representations

Amount

Region

DateTime

CartReference

OrderReference

PaymentReference

CartResourceIdentifier

OrderResourceIdentifier

PaymentResourceIdentifier

Localization

CountryCode

CurrencyCode

Locale

LocalizedString

LocalizedUrl

Client logging

CreatedBy

LastModifiedBy