Create device code

POST

/v2/devices/codes

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

Permissions:DEVICE_CREDENTIAL_MANAGEMENT

Try in API Explorer

Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

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.

Min Length

Max Length

128

Link to section

device_code

DeviceCode

Required

The device code to create.

Show attributes

Link to section

Response fields

Link to section

errors

Error[ ]

Any errors that occurred during the request.

Show attributes

Link to section

device_code

DeviceCode

The created DeviceCode object containing the device code string.

Show attributes

Link to section

Examples

API version2026-08-19

All versions ->

POST/v2/devices/codes

cURL

curl https://connect.squareup.com/v2/devices/codes \
  -X POST \
  -H 'Square-Version: 2026-08-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "01bb00a6-0c86-4770-94ed-f5fca973cd56",
    "device_code": {
      "name": "Counter 1",
      "location_id": "B5E4484SHHNYH",
      "product_type": "TERMINAL_API"
    }
  }'

Response JSON

{
  "device_code": {
    "id": "B3Z6NAMYQSMTM",
    "name": "Counter 1",
    "code": "EBCARJ",
    "product_type": "TERMINAL_API",
    "location_id": "B5E4484SHHNYH",
    "created_at": "2020-02-06T18:44:33.000Z",
    "pair_by": "2020-02-06T18:49:33.000Z",
    "status": "UNPAIRED",
    "status_changed_at": "2020-02-06T18:44:33.000Z"
  }
}