> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Search Terminal Checkouts

> Returns a filtered list of Terminal checkout requests created by the application making the request.

`square.searchTerminalCheckouts` returns a filtered list of Terminal checkout requests created by the application making the request.

## Example

```ts automations/square-search-terminal-checkouts.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Search Square Terminal Checkouts", () => {
  onDashboardRun({ title: "Search Square Terminal Checkouts" })

  square.searchTerminalCheckouts({
    query: {
      filter: {
        status: "COMPLETED",
      },
    },
    limit: 2,
  })
})
```

## Inputs

Every input accepts a compatible signal. It requires `PAYMENTS_READ`.

| Field    | Type                           | Required | Default | Description                                                                                                                                                                                                                                                               |
| -------- | ------------------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query`  | `Square.TerminalCheckoutQuery` | No       | —       | Queries Terminal checkouts based on given conditions and the sort order. Leaving these unset returns all checkouts with the default sort order.                                                                                                                           |
| `cursor` | `string`                       | No       | —       | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. |
| `limit`  | `number`                       | No       | —       | Limits the number of results returned for a single request.                                                                                                                                                                                                               |

Use the official [SearchTerminalCheckouts reference](https://developer.squareup.com/reference/square/terminal-api/search-terminal-checkouts) for provider field semantics and limits.

## Output

Returns the official `Square.SearchTerminalCheckoutsResponse` response as a codec-safe object. Square integer money amounts remain `bigint` values.