---
title: "List Checkout Sessions"
method: GET
path: "/checkoutsessions/list"
tags: ["Checkout Sessions"]
---

# List Checkout Sessions

`GET /checkoutsessions/list`

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

 **Integration Methods:**
- Host Direct

See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

## Headers

- `InterfaceVersion` string, required
- `InterfaceName` string, required
- `CompanyName` string, required
- `AccessToken` string, uuid, required
- `Limit` number
- `StartingAfterId` string
- `EndingBeforeId` string
- `DatetimeAfter` string, ISO 8601
- `DatetimeBefore` string, ISO 8601
- `PaymentLinkId` string
- `Status` 'active' | 'paid' | 'expired' | 'failed'

## Response `200`

Request was processed

- object
  - `hasMore` boolean — If the value is true then more objects can be listed by requesting next page
  - `result` object[]
    - `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.

## Other responses

- `400` — Error
- `504` — Timeout

---

[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/b923fc55b203/schema)