> ## 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.

# List Payouts

> Retrieves a list of all payouts for the default location.

`square.listPayouts` retrieves a list of all payouts for the default location.

## Example

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

export default automation("List Square Payouts", () => {
  onDashboardRun({ title: "List Square Payouts" })

  square.listPayouts({
    locationId: "location_id",
    status: "SENT",
    beginTime: "begin_time",
    endTime: "end_time",
    sortOrder: "DESC",
    cursor: "cursor",
    limit: 1,
  })
})
```

## Inputs

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

| Field        | Type                          | Required | Default                         | Description                                                                                                                                                                                                                                                                                                                                                                             |
| ------------ | ----------------------------- | -------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `locationId` | `string \| null`              | No       | —                               | The ID of the location for which to list the payouts. By default, payouts are returned for the default (main) location associated with the seller.                                                                                                                                                                                                                                      |
| `status`     | `Square.PayoutStatus \| null` | No       | —                               | If provided, only payouts with the given status are returned.                                                                                                                                                                                                                                                                                                                           |
| `beginTime`  | `string \| null`              | No       | The current time minus one year | The timestamp for the beginning of the payout creation time, in RFC 3339 format. Inclusive. Default: The current time minus one year.                                                                                                                                                                                                                                                   |
| `endTime`    | `string \| null`              | No       | The current time                | The timestamp for the end of the payout creation time, in RFC 3339 format. Default: The current time.                                                                                                                                                                                                                                                                                   |
| `sortOrder`  | `Square.SortOrder \| null`    | No       | —                               | The order in which payouts are listed.                                                                                                                                                                                                                                                                                                                                                  |
| `cursor`     | `string \| null`              | 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. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). If request parameters change between requests, subsequent results may contain duplicates or missing records. |
| `limit`      | `number \| null`              | No       | used instead                    | The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`                                                             |

Use the official [ListPayouts reference](https://developer.squareup.com/reference/square/payouts-api/list-payouts) for provider field semantics and limits.

## Output

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