Create Terminal Action - Automate.ax

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

Example

automations/square-create-terminal-action.automation.ts

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 for more information.
`action`	`Square.TerminalAction`	Yes	—	The Action to create.

Use the official CreateTerminalAction reference 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.