v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Devices

GetDevice

Retrieves Device with the associated device_id.

get/v2/devices/{device_id}

Path parameters

device_idstring required

The unique ID for the desired Device.

Response

Success

Example response

{
  "device": {
    "attributes": {
      "manufacturer": "Square",
      "manufacturers_id": "995CS397A6475287",
      "merchant_token": "MLCHXZCBWFGDW",
      "model": "T2",
      "name": "Square Terminal 995",
      "type": "TERMINAL",
      "updated_at": "2023-09-29T13:12:22.365049321Z",
      "version": "5.41.0085"
    },
    "components": [
      {
        "application_details": {
          "application_type": "TERMINAL_API",
          "session_location": "LMN2K7S3RTOU3",
          "version": "6.25"
        },
        "type": "APPLICATION"
      },
      {
        "card_reader_details": {
          "version": "3.53.70"
        },
        "type": "CARD_READER"
      },
      {
        "battery_details": {
          "external_power": "AVAILABLE_CHARGING",
          "visible_percent": 5
        },
        "type": "BATTERY"
      },
      {
        "type": "WIFI",
        "wifi_details": {
          "active": true,
          "ip_address_v4": "10.0.0.7",
          "secure_connection": "WPA/WPA2 PSK",
          "signal_strength": {
            "value": 2
          },
          "ssid": "Staff Network"
        }
      },
      {
        "ethernet_details": {
          "active": false
        },
        "type": "ETHERNET"
      }
    ],
    "id": "device:995CS397A6475287",
    "status": {
      "category": "AVAILABLE"
    }
  }
}