v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB

Checkout Sessions

List Checkout Sessions

Used to retrieve a list of checkout sessions via the Payment Links system

Integration Methods:

Host Direct

See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.

get/checkoutsessions/list

Headers

InterfaceVersionstring required

Example:2.1

Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =

InterfaceNamestring required

Example:ForwardPOS

Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

CompanyNamestring required

Example:PAWS

Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

AccessTokenstring uuid required

Example:EA79FB05-3AA7-4500-AF9A-73F986FF2C1D

A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.

Limitnumber

Maximum number of returned objects

StartingAfterIdstring

Cursor used for pagination (getting the next page). For example, if you make a list request and receive 10 objects, where the last object has id=some-example-id - then you can make another request with startingAfterId=some-example-id to get the next page of that list.

EndingBeforeIdstring

Cursor used for pagination (getting the previous page). For example, if you make a list request and receive 10 objects, where the first object has id=some-example-id - then you can make another request with endingBeforeId=some-example-id to get the previous page of that list

DatetimeAfterstring ISO 8601

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

Returns only records strictly after the specified timestamp

DatetimeBeforestring ISO 8601

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

Returns only records strictly before the specified timestamp

PaymentLinkIdstring

Used for selecting payment link by id

Status'active' | 'paid' | 'expired' | 'failed'

Filter checkout sessions by their current status. When omitted, all sessions are returned.

Value	Description
active	Session is open — payment not yet completed, not expired, and within the allowed failure count
paid	Payment was completed successfully
expired	Session expired or was deleted without a successful payment
failed	Payment was attempted but reached the maximum number of failed attempts

An invalid value returns HTTP 400 with error code invalid_header_format.

Response

Request was processed

hasMoreboolean

If the value is true then more objects can be listed by requesting next page

Example response

{
  "result": [
    {
      "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"
              }
            }
          ]
        }
      }
    }
  ]
}