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

# Get Payout

> Retrieves details of a specific payout identified by a payout ID.

`square.getPayout` retrieves details of a specific payout identified by a payout ID.

## Example

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

export default automation("Get Square Payout", () => {
  onDashboardRun({ title: "Get Square Payout" })

  square.getPayout({
    payoutId: "payout_id",
  })
})
```

## Inputs

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

| Field      | Type     | Required | Default | Description                                           |
| ---------- | -------- | -------- | ------- | ----------------------------------------------------- |
| `payoutId` | `string` | Yes      | —       | The ID of the payout to retrieve the information for. |

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

## Output

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