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

> Creates a Terminal action request and sends it to the specified device.

`square.createTerminalAction` creates a Terminal action request and sends it to the specified device.

## Example

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

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

  square.createTerminalAction({
    idempotencyKey: "thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e",
    action: {
      deviceId: "{{DEVICE_ID}}",
      deadlineDuration: "PT5M",
      type: "SAVE_CARD",
      saveCardOptions: {
        customerId: "{{CUSTOMER_ID}}",
        referenceId: "user-id-1",
      },
    },
  })
})
```

## 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 `CreateAction` request. Keys can be any valid string but must be unique for every `CreateAction` request. See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. |
| `action`         | `Square.TerminalAction` | Yes      | —       | The Action to create.                                                                                                                                                                                                                                                         |

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

## Output

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