Get Payout - Automate.ax

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

Example

automations/square-get-payout.automation.ts

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