• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
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

Request Body

Example code
Name Description
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 1 Max Length 128
device_code
DeviceCode
Required

The device code to create.

Response Fields
Name Description
errors
Error [ ]

Any errors that occurred during the request.
device_code
DeviceCode

The created DeviceCode object containing the device code string.

Examples

You are viewing an old version of the API
POST /v2/devices/codes
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/devices/codes \
  -X POST \
  -H 'Square-Version: 2022-09-21' \
  -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"
  }
}