Create Device Code - Automate.ax

square.createDeviceCode creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.

Example

automations/square-create-device-code.automation.ts

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

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

  square.createDeviceCode({
    idempotencyKey: "01bb00a6-0c86-4770-94ed-f5fca973cd56",
    deviceCode: {
      name: "Counter 1",
      productType: "TERMINAL_API",
      locationId: "B5E4484SHHNYH",
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires DEVICE_CREDENTIAL_MANAGEMENT.

Field	Type	Required	Default	Description
`idempotencyKey`	`string`	Yes	—	A unique string that identifies this CreateDeviceCode request. Keys can be any valid string but must be unique for every CreateDeviceCode request. See Idempotency keys for more information.
`deviceCode`	`Square.DeviceCode`	Yes	—	The device code to create.

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

Output

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