Checkout Messages

Checkout sends Messages to provide feedback about events.

To receive Messages from Checkout, pass the onInfo, onWarn, or onError message handlers with the checkoutFlow or paymentFlow methods when initializing Checkout.

Message structure

Checkout Messages are JSON objects with the following common fields. In addition to these common fields, some Messages also contain a payload field with data about the event.

`code` String	Message code for the event.
`severity` String	Severity level of the event. Can be `info`, `warn`, or `error`.
`message` String	Human-readable description of the event.
`correlationId` String	Unique identifier of the event.

Example Message of severiry level 'error' with payloadjson

{
  "severity": "error",
  "code": "project_deactivated",
  "message": "Project {projectKey} is deactivated.",
  "payload": {
    "project": {
      "key": "{projectKey}"
    }
  },
  "correlationId": "spa/commercetools-checkout/1729263187262/565301612087128"
}

Example Message of severiry level 'info' with payloadjson

{
  "severity": "info",
  "code": "order_created",
  "message": "Order {orderId} created.",
  "payload": {
    "order": {
      "id": "{orderId}"
    }
  },
  "correlationId": "spa/commercetools-checkout/1729263187262/565301612087128"
}

Message types

Application Messages -Application Deactivated

Cart Messages -Cart Empty -Cart Emptied During Checkout -Cart Not Found -Cart With Existing Payment -Add Discount Code Error -Remove Discount Code Error -Discount Not Applicable -Unsupported Country -Shipping Address Missing Error -Shipping Address Does Not Match Cart -Set Shipping Address Error

Checkout Messages -Checkout Loaded -Checkout Started -Checkout Cancelled -Checkout Completed

Configuration Messages -Init Error -Init Timeout -Invalid Locale -Invalid Mode -Expired Session -Failed To Refresh Session -Bad Input Data -No Shipping Methods -Unavailable Locale -Deprecated Fields -Updated Fields

Order Messages -Order Created -Order Creation Error

Project Messages -Project Is Deactivated

Application Messages

Application Deactivated

Generated when the requested Application is deactivated. Activate the Application in the Merchant Center to continue.

`code` String	`"application_disabled"`
`severity` String	`error`
`message` String	Application `{applicationKey}` for `{projectKey}` is disabled.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `project` and `application` objects with the related `key` property.

Cart Messages

Cart Empty

Generated when the Cart for the current checkout is empty. The Cart must contain at least one Line Item.

`code` String	`"cart_empty"`
`severity` String	`error`
`message` String	Cart `{cartId}` is empty.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `cart` object with the `id` property.

Cart Emptied During Checkout

Generated when the Cart was emptied during the checkout process. It is not possible to recover from this, the customer must restart the checkout process.

`code` String	`"cart_emptied_during_checkout"`
`severity` String	`error`
`message` String	Cart `{cartId}` was emptied during checkout.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `cart` object with the `id` property.

Cart Not Found

Generated when the Cart is not found. To start the checkout process, a valid Cart with at least one Line Item is required.

`code` String	`"cart_not_found"`
`severity` String	`error`
`message` String	Cart for `{projectKey}` and session `{sessionId}` not found.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `project` and `session` objects with the related `key` and `id` properties.

Cart With Existing Payment

Generated when trying to add a Payment to a Cart that already references an approved Payment.

`code` String	`"cart_with_exisiting_payment"`
`severity` String	`error`
`message` String	Cart with existing approved payment.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `cart` object with the `id` property.

Add Discount Code Error

Generated when there was an error adding a Discount Code.

`code` String	`"add_discount_code_error"`
`severity` String	`error`
`message` String	Error adding discount code.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `error` object.

Remove Discount Code Error

Generated when there was an error removing the Discount Code.

`code` String	`"remove_discount_code_error"`
`severity` String	`error`
`message` String	Error removing discount code.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `error` object.

Discount Not Applicable

Generated when the Discount Code is not applicable for the current cart.

`code` String	`"discount_code_not_applicable"`
`severity` String	`info`
`message` String	Discount code not applicable.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains string values for `cartId` and the given `discountCode`.

Unsupported Country

Generated when the country of the shipping address and/or billing address associated with the Cart does not match the countries set for the Application.

`code` String	`"unsupported_country"`
`severity` String	`error`
`message` String	Cart `{cartId}` has unsupported country.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `cart` object with the `id` property, `shippingCountry`, `billingCountry`, and the `supportedCountries` array.

Shipping Address Missing Error

Generated when the shipping address is missing for the given Cart.

`code` String	`"shipping_address_missing"`
`severity` String	`error`
`message` String	The shippingAddress field is missing for cart `{cartId}`.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `cart` object with the `id` property.

Shipping Address Does Not Match Cart

Generated when the selected Shipping Method does not match the Cart anymore.

`code` String	`"shipping_method_does_not_match_cart"`
`severity` String	`info`
`message` String	Selected shipping method no longer matches cart.
`correlationId` String	Unique identifier of the event.

Set Shipping Address Error

Generated when the Cart cannot be updated with the shipping address.

`code` String	`"set_shipping_address_error"`
`severity` String	`error`
`message` String	Error setting shipping address.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `errors` array of objects, with the related `code` and `message` properties.

Checkout Messages

Checkout Loaded

Generated when Checkout is loaded and waiting for the configuration properties to be passed with the checkoutFlow or paymentFlow method.

`code` String	`"checkout_loaded"`
`severity` String	`info`
`message` String	Checkout loaded.
`correlationId` String	Unique identifier of the event.

Checkout Started

Generated when the configuration properties are passed successfully with the checkoutFlow or paymentFlow method and the checkout process starts.

`code` String	`"checkout_started"`
`severity` String	`info`
`message` String	Checkout started.
`correlationId` String	Unique identifier of the event.

Checkout Cancelled

Generated when the customer cancels the checkout process.

`code` String	`"checkout_cancelled"`
`severity` String	`info`
`message` String	Checkout cancelled.
`correlationId` String	Unique identifier of the event.

Checkout Completed

Generated when the customer completes the checkout process.

`code` String	`"checkout_completed"`
`severity` String	`info`
`message` String	Checkout for `{orderId}` completed.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `order` object with the `id` property.

Configuration Messages

Init Error

Generated when an error occurs during Checkout's initialization.

`code` String	`"init_error"`
`severity` String	`error`
`message` String	Error during initialization.
`correlationId` String	Unique identifier of the event.

Init Timeout

Generated when Checkout does not receive the configuration properties with the checkoutFlow or paymentFlow method on time.

`code` String	`"init_timeout"`
`severity` String	`error`
`message` String	Timeout error, no init message received.
`correlationId` String	Unique identifier of the event.

Invalid Locale

Generated when the provided locale is invalid.

`code` String	`"invalid_locale"`
`severity` String	`warn`
`message` String	The provided `{locale}` is invalid.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the provided locale string, the related locale field (language or currency), and the used fallback one.

Invalid Mode

Generated when the Application does not support the requested Checkout mode.

`code` String	`"invalid_mode"`
`severity` String	`info`
`message` String	`{mode}` mode requires an application with mode type `{modeTypeRequested}`. Current mode `{modeTypeReceived}`.
`correlationId` String	Unique identifier of the event.

Expired Session

Generated when the Checkout Session is expired.

`code` String	`"expired_session"`
`severity` String	`error`
`message` String	Session is expired.
`correlationId` String	Unique identifier of the event.

Failed To Refresh Session

Generated when the Checkout Session fails to refresh.

`code` String	`"failed_to_refresh_session"`
`severity` String	`error`
`message` String	Failed to refresh session.
`correlationId` String	Unique identifier of the event.

Bad Input Data

Generated when the Checkout properties contains invalid fields.

`code` String	`"invalid_fields"`
`severity` String	`error`
`message` String	Some fields are invalid.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `invalidFields` array of objects with the related `schema`, `path`, `value` and `message` properties.

No Shipping Methods

Generated when no Shipping Method is available for the shipping address of the Cart. This may indicate an incomplete configuration.

`code` String	`"no_shipping_methods"`
`severity` String	`error`
`message` String	There are no shipping methods matching cart.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `cart` object with the `id` property.

Unavailable Locale

Generated when the provided locale is not available for localization. The localization falls back to English.

`code` String	`"unavailable_locale"`
`severity` String	`warn`
`message` String	The provided locale `{locale}` is not available for translated definitions.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `locale` and the `fallback` properties.

Deprecated Fields

Generated when the Checkout properties contains one or more deprecated fields.

`code` String	`"deprecated_fields"`
`severity` String	`warn`
`message` String	Some fields are deprecated.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `deprecatedFields` array.

Updated Fields

Generated when some fields provided in the Checkout initialization request are invalid and have been updated to match our schema. An array of updates will be provided with a sequence of edits used to transform an invalid value into a valid one.

`code` String	`"updated_fields"`
`severity` String	`warn`
`message` String	Some fields are invalid and have been updated.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains two arrays: `invalidFields` contains a list of invalid fields with the related `schema`, `path`, `value` and `message` properties. `updatedFields` contains the updated fields with its related `type`, `path` and `value` properties, where `type` can be `update`\|`insert`\|`delete`.

Order Messages

Order Created

Generated when an Order is created after a successful checkout process.

`code` String	`"order_created"`
`severity` String	`info`
`message` String	Order `{orderId}` created.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `order` object with the `id` property.

Order Creation Error

Generated when an Order that references an approved Payment cannot be created.

`code` String	`"order_creation_error"`
`severity` String	`error`
`message` String	Order creation failed with approved payment.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains `paymentReference`, `sessionId`, and the `errors` array of objects, with the related `code` and `message` properties.

Payments Messages

Payment Connector Error

Generated when the payment Connector triggers an error.

`code` String	`"payment_connector_error"`
`severity` String	`error`
`message` String	Payment connector error.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `connector` object with the `id` property.

Payment Methods Received

Generated when Checkout receives and loads the payment methods configured for the Application.

`code` String	`"payment_methods_received"`
`severity` String	`info`
`message` String	Payment methods received.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `paymentMethods` array of objects with the `type` and `connectorId` properties.

Multiple Payment Method Containers

Generated when multiple containers for vendor payment buttons are found.

`code` String	`"multiple_vendor_button_containers"`
`severity` String	`warn`
`message` String	Multiple vendor button containers detected, this may cause issues.
`correlationId` String	Unique identifier of the event.

No Payment Methods

Generated when no payment method is set up for an Application. Add at least one Payment method to the Application in the Merchant Center.

`code` String	`"no_payment_methods"`
`severity` String	`error`
`message` String	There are no payment methods configured.
`correlationId` String	Unique identifier of the event.

Payment Method Loading

Generated when the selected payment method is loading.

`code` String	`"payment_method_loading"`
`severity` String	`info`
`message` String	Payment method loading.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `method` object with the `type` and `connectorId` properties.

Payment Method Loading Error

Generated when the loading of the selected payment method fails.

`code` String	`"payment_method_loading_error"`
`severity` String	`error`
`message` String	Payment method loading failed.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `method` object with the `type` and `connectorId` properties.

Payment Method Loaded

Generated when the selected payment method is loaded.

`code` String	`"payment_method_loaded"`
`severity` String	`info`
`message` String	Payment method loaded.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `method` object with the `type` and `connectorId` properties.

Payment Method Selected

Generated when the customer selects the payment method.

`code` String	`"payment_method_selected"`
`severity` String	`info`
`message` String	Payment method selected.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `method` object with the `type` and `hasVendorButton` properties.

Payment Method Selection Confirmation

Generated when the customer has entered the payment method information and moves to the next step.

`code` String	`"payment_method_selection_confirmation"`
`severity` String	`info`
`message` String	Payment method selected.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `method` object with the `type` and `hasVendorButton` properties.

Payment Method Selection Confirmation Failed

Generated when the selection of the payment method by the customer is not successful.

`code` String	`"payment_method_selection_confirmation_failed"`
`severity` String	`info`
`message` String	Payment method selection failed.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `method` object with the `type` property.

Payment Started

Generated when the payment starts.

`code` String	`"payment_started"`
`severity` String	`info`
`message` String	Payment started.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `method` object with the `type` property.

Payment Failed

Generated when the payment fails.

`code` String	`"payment_failed"`
`severity` String	`error`
`message` String	Payment failed.
`correlationId` String	Unique identifier of the event.

Payment Cancelled

Generated when the customer cancels the payment (for example, by closing the browser's window).

`code` String	`"payment_cancelled"`
`severity` String	`info`
`message` String	Payment cancelled.
`correlationId` String	Unique identifier of the event.

Payment Validation Failed

Generated when Checkout and the payment service provider (PSP) do not validate the payment information entered by the customer.

`code` String	`"payment_validation_failed"`
`severity` String	`info`
`message` String	Payment validation failed.
`correlationId` String	Unique identifier of the event.

Payment Validation Passed

Generated when Checkout and the payment service provider (PSP) validate the payment information entered by the customer.

`code` String	`"payment_validation_passed"`
`severity` String	`info`
`message` String	Payment validation passed.
`correlationId` String	Unique identifier of the event.

Payment Validation Started

Generated when the validation of the payment information entered by the customer starts.

`code` String	`"payment_validation_started"`
`severity` String	`info`
`message` String	Payment validation started.
`correlationId` String	Unique identifier of the event.

Payment Verification Started

Generated when Checkout starts verifying the payment authorization given by the payment service provider (PSP).

`code` String	`"payment_verification_started"`
`severity` String	`info`
`message` String	Payment verification started.
`correlationId` String	Unique identifier of the event.

Payment Verification Timeout

Generated when the verification of the payment authorization times out.

`code` String	`"payment_verification_timeout"`
`severity` String	`error`
`message` String	Payment verification timeout.
`correlationId` String	Unique identifier of the event.

External Terms And Conditions Pending

Generated in Payment Only mode when the customer hasn't accepted the terms and conditions yet.

`code` String	`"external_terms_and_conditions_pending"`
`severity` String	`info`
`message` String	External terms and conditions pending.
`correlationId` String	Unique identifier of the event.

Project Messages

Project Is Deactivated

Generated when the Checkout projectKey is deactivated and cannot be initialized. To activate it, contact the Checkout support team.

`code` String	`"project_deactivated"`
`severity` String	`error`
`message` String	Project `{projectKey}` is deactivated.
`correlationId` String	Unique identifier of the event.
`payload` Object	Contains the `project` object with the `key` property.