---
title: "Checkout Sessions Notification"
method: POST
path: "checkoutsessions-notification"
tags: ["Checkout Sessions"]
---

# Checkout Sessions Notification

`POST checkoutsessions-notification` (webhook)

This is an outbound HTTP POST message from the Shift4 gateway to the merchant's environment that provides a status of the checkout session. This notification request will be sent from Shift4 to the URL provided in the merchant's boarding configuration.

This requires the interface vendor to establish a listening service to receive these requests.

## Payload

- object
  - `event` object
    - `type` 'checkout_session_completed' — Occurs when the status of the Checkout Session is updated. | Value | Description | |-----------------------------------------|---------------------------------------------------| | checkout_session_completed | Checkout session has been completed. |
  - `dateTime` string, ISO 8601 — Date-time when the object was created
  - `paymentLink` object
    - `id` string — Identifier of Payment Link
  - `checkoutSession` CheckoutSessionResponse
    - `id` string — Identifier of a Checkout Session
    - `staticFields` CheckoutSessionStaticFields — List of information displayed on the payment page
    - `customFieldsTitle` string — Title of custom fields section
    - `customFields` object[] — List of custom fields that were collected from customer on the payment page
      - `key` string, required — Identifier of custom field
      - `label` string, required — Label of custom field
      - `optional` boolean — If this flag is set to true, then customer was not required to provide any value for this custom field
      - `value` string — The value that was provided by the customer for this custom field
    - `lastTransaction` CheckoutSessionLastTransaction — Contains the API response from the last transaction processed. See the [Sale Response Body](/apis/payments-platform-rest/openapi/transactions/transactionssale#transactions/transactionssale/response&c=200) for the full response structure.

## Acknowledgement `200`

Return 200 status to indicate that the Notification was received successfully.

---

[API](https://skmtc.dev/shift4/apis/shift4-payment-api.md) · [All operations](https://skmtc.dev/shift4/apis/shift4-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/shift4/shift4-payment-api/revisions/2f85c87cc9e5/schema)