Checkout Sessions Notification

Checkout Sessions Notification
Webhook

Request

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 is sent to the webhookUrl set on the Checkout Session. For a Checkout Session created by opening a Payment Link, the link's webhookUrl is used instead.

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

Bodyapplication/json

dateTimestring, (date-time)

Timestamp of the most recent event for this checkout session

Example:"2024-05-21T09:18:23.283-07:00"

eventobject

Most recent event associated with this checkout session

customerobject

Customer associated with this checkout session

paymentLinkobject

Payment link this checkout session was created from

checkoutSessionobject

Checkout session details

metadataobject

Key-value object containing additional custom data supplied when the checkout session was created. This is never displayed to customer on the payment page.

POST

checkoutsessions-notification

Payload

{
  "dateTime": "2024-05-21T09:18:23.283-07:00",
  "event": {
    "type": "checkout_session_created"
  },
  "customer": {
    "id": "cust_oM1i4j7EsIY7W5vqqF76diGw",
    "emailAddress": "jordan.smith@example.com",
    "phoneNumber": "+12025550123",
    "phoneCountry": "US",
    "firstName": "Jordan",
    "middleName": "Riley",
    "lastName": "Smith",
    "addressLine1": "Evergreen Terrace 742",
    "postalCode": "94043",
    "addressCity": "Mountain View",
    "addressRegion": "CA",
    "addressCountry": "US"
  },
  "paymentLink": {
    "id": "link_8kdskX8DZ8FR6W3acYPXiyAN"
  },
  "checkoutSession": {
    "id": "chse_wMCUGVZgpf45fWHzKbYWMKmZ",
    "action": "payment",
    "clientSecret": "chcs_II2TvLWBrzFniRdjLpgo2zIflaTCzZ5BGPngPZEu0XasgwYRBCHEpyqE0tO9pYocvoOl8alO9w91CAeW0bl3nrTfO9JH4zFDt8pXB2eyoOpOBeuD3XuxPnGKOiTjor0D0vwRfdMR7moSj3K9yLDktQy6KcoZEa9SgP5DHiXg30L1X26EKy4XCxqBdeB4dcC4osPiXBwJqFfhKsKxG4RUD8I8CCeUfvbXnCVSokauaT0AUEk7pkF3TBgN3Q",
    "url": "https://pay.shift4.com/chse_wMCUGVZgpf45fWHzKbYWMKmZ",
    "status": "active",
    "redirectUrl": "https://example.com/checkout/complete",
    "allowSavedCards": true,
    "locale": "en",
    "lastOpened": "2024-05-21T09:18:23.283-07:00",
    "expiresAt": "2024-05-21T09:18:23.283-07:00",
    "collectBillingAddress": true,
    "collectShippingAddress": true,
    "customFieldsTitle": "Additional information",
    "customFieldsTitleTranslations": {
      "property1": "string",
      "property2": "string"
    },
    "customFields": [
      {
        "key": "special_wishes",
        "label": "Special wishes",
        "value": "Happy Holidays",
        "optional": true
      }
    ],
    "staticFields": {
      "property1": "string",
      "property2": "string"
    },
    "capture": true,
    "vendorReference": "ref_123456789",
    "webhookUrl": "string",
    "lineItems": [
      {
        "product": { … },
        "quantity": 1
      }
    ],
    "lastTransaction": {
      "property1": null,
      "property2": null
    },
    "customerCreationPolicy": "create"
  },
  "metadata": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

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