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

# Create Terminal Checkout

> Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.

`square.createTerminalCheckout` creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.

## Example

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

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

  square.createTerminalCheckout({
    idempotencyKey: "28a0c3bc-7839-11ea-bc55-0242ac130003",
    checkout: {
      amountMoney: {
        amount: BigInt("2610"),
        currency: "USD",
      },
      referenceId: "id11572",
      note: "A brief note",
      deviceOptions: {
        deviceId: "dbb5d83a-7838-11ea-bc55-0242ac130003",
      },
    },
  })
})
```

## Inputs

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

| Field            | Type                      | Required | Default | Description                                                                                                                                                                                                                                                                       |
| ---------------- | ------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `idempotencyKey` | `string`                  | Yes      | —       | A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but must be unique for every `CreateCheckout` request. See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. |
| `checkout`       | `Square.TerminalCheckout` | Yes      | —       | The checkout to create.                                                                                                                                                                                                                                                           |

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

## Output

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