Create Terminal Checkout - Automate.ax

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

Example

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

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 for more information.
`checkout`	`Square.TerminalCheckout`	Yes	—	The checkout to create.

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