• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Device code paired BETA

EVENT device.code.paired

Published when a Square Terminal has been paired with a Terminal API client and the device_id of the paired Square Terminal is available.

Required permissions: DEVICE_CREDENTIAL_MANAGEMENT

Event payload

Name Description
merchant_id
string

The ID of the target merchant associated with the event.

location_id
string

The ID of the target location associated with the event.

type
string

The type of event this represents, "device.code.paired".

event_id
string

A unique ID for the webhook event.

created_at
string

RFC 3339 timestamp of when the webhook event was created.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
DeviceCodePairedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "7NZR58EPNGNPC",
  "location_id": "AR63EC48VXVBN",
  "type": "device.code.paired",
  "event_id": "84ccdb8a-da90-4b14-b6b0-c5a5abbccfe6",
  "created_at": "2020-04-10T14:41:58.036Z",
  "data": {
    "type": "device.code",
    "id": "05NK80TRSC2ZF",
    "object": {
      "device_code": {
        "code": "ABCDEF",
        "created_at": "2020-04-10T14:41:20.000Z",
        "device_id": "907CS13101300122",
        "id": "05NK80TRSC2ZF",
        "location_id": "AR63EC48VXVBN",
        "name": "Terminal API Device created on Apr 10, 2020",
        "paired_at": "2020-04-10T14:41:50.000Z",
        "product_type": "TERMINAL_API",
        "status": "PAIRED",
        "status_changed_at": "2020-04-10T14:41:50.000Z"
      }
    }
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?