v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB

Checkout Sessions

Checkout Sessions Notification

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.

postWebhookcheckoutsessions-notification

Payload

dateTimestring ISO 8601

Date-time when the object was created

Example payload

{
  "dateTime": "2024-05-21T09:18:23.283-07:00",
  "paymentLink": {
    "id": "link_8kdskX8DZ8FR6W3acYPXiyAN"
  },
  "checkoutSession": {
    "id": "chse_wMCUGVZgpf45fWHzKbYWMKmZ",
    "staticFields": {
      "Date of event": "12 April",
      "Invoice number": "ABC2016"
    },
    "customFieldsTitle": "Additional information",
    "customFields": [
      {
        "key": "special_wishes",
        "label": "Special wishes",
        "value": "Happy Holidays"
      }
    ],
    "lastTransaction": {
      "result": [
        {
          "dateTime": "2024-05-21T09:18:23.283-07:00",
          "amount": {
            "total": "10.99",
            "tax": "0.00"
          },
          "transaction": {
            "invoice": "0510093358",
            "authorizationCode": "198399",
            "saleFlag": "S"
          }
        }
      ]
    }
  }
}

Response

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