Common Types

Common API Types used within multiple API resources.

Representations

Reference -ApplicationReference -CartReference -OrderReference -PaymentReference -PaymentIntegrationReference

Resource Identifier -ApplicationResourceIdentifier -CartResourceIdentifier -OrderResourceIdentifier -PaymentResourceIdentifier -PaymentIntegrationResourceIdentifier

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)
us-central1.gcp: for North America (Google Cloud, Iowa)
australia-southeast1.gcp: for Australia (Google Cloud, Sydney)

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.

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"

Reference

A Reference represents a loose reference to another resource, and each resource type has its corresponding Reference type, like CartReference.

ApplicationReference

Reference to an Application.

`id` String	Unique identifier of the referenced Application.
`typeId` ReferenceTypeId	`application` Type of referenced resource.

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.

PaymentIntegrationReference

Reference to a Payment Integration.

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

Resource Identifier

Draft type to create a Reference to a resource.

ApplicationResourceIdentifier

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

`id` String	Unique identifier of the referenced Application. Required if `key` is absent.
`typeId` ReferenceTypeId	`application` 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 Application. Required if `id` is absent.

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.

PaymentIntegrationResourceIdentifier

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

`id` String	Unique identifier of the referenced Payment Integration. Required if `key` is absent.
`typeId` ReferenceTypeId	`payment-integration` 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 Integration. Required if `id` is absent.

Common Types

Representations.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Amount.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Region.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ReferenceTypeId.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DateTime.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Reference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ApplicationReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

CartReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

OrderReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentIntegrationReference.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Resource Identifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ApplicationResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

CartResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

OrderResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

PaymentIntegrationResourceIdentifier.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}