Get Terminal Checkout - Automate.ax

square.getTerminalCheckout retrieves a Terminal checkout request by checkout_id.

Example

automations/square-get-terminal-checkout.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

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

  square.getTerminalCheckout({
    checkoutId: "checkout_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires PAYMENTS_READ.

Field	Type	Required	Default	Description
`checkoutId`	`string`	Yes	—	The unique ID for the desired `TerminalCheckout`.

Use the official GetTerminalCheckout reference for provider field semantics and limits.

Output

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