get-device-response.md

Get Device Response

Structure

GetDeviceResponse

Fields

Name	Type	Tags	Description
errors	Error[] | undefined	Optional	Information about errors encountered during the request.
device	Device | undefined	Optional	-

Example (as JSON)

{
  "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",
          "device_code_id": "device_code_id2"
        },
        "type": "APPLICATION",
        "card_reader_details": {
          "version": "version0"
        },
        "battery_details": {
          "visible_percent": 108,
          "external_power": "AVAILABLE_CHARGING"
        },
        "wifi_details": {
          "active": false,
          "ssid": "ssid8",
          "ip_address_v4": "ip_address_v42",
          "secure_connection": "secure_connection8",
          "signal_strength": {
            "value": 222
          }
        },
        "ethernet_details": {
          "active": false,
          "ip_address_v4": "ip_address_v42"
        }
      },
      {
        "card_reader_details": {
          "version": "3.53.70"
        },
        "type": "CARD_READER",
        "application_details": {
          "application_type": "TERMINAL_API",
          "version": "version4",
          "session_location": "session_location0",
          "device_code_id": "device_code_id2"
        },
        "battery_details": {
          "visible_percent": 108,
          "external_power": "AVAILABLE_CHARGING"
        },
        "wifi_details": {
          "active": false,
          "ssid": "ssid8",
          "ip_address_v4": "ip_address_v42",
          "secure_connection": "secure_connection8",
          "signal_strength": {
            "value": 222
          }
        },
        "ethernet_details": {
          "active": false,
          "ip_address_v4": "ip_address_v42"
        }
      },
      {
        "battery_details": {
          "external_power": "AVAILABLE_CHARGING",
          "visible_percent": 5
        },
        "type": "BATTERY",
        "application_details": {
          "application_type": "TERMINAL_API",
          "version": "version4",
          "session_location": "session_location0",
          "device_code_id": "device_code_id2"
        },
        "card_reader_details": {
          "version": "version0"
        },
        "wifi_details": {
          "active": false,
          "ssid": "ssid8",
          "ip_address_v4": "ip_address_v42",
          "secure_connection": "secure_connection8",
          "signal_strength": {
            "value": 222
          }
        },
        "ethernet_details": {
          "active": false,
          "ip_address_v4": "ip_address_v42"
        }
      },
      {
        "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"
        },
        "application_details": {
          "application_type": "TERMINAL_API",
          "version": "version4",
          "session_location": "session_location0",
          "device_code_id": "device_code_id2"
        },
        "card_reader_details": {
          "version": "version0"
        },
        "battery_details": {
          "visible_percent": 108,
          "external_power": "AVAILABLE_CHARGING"
        },
        "ethernet_details": {
          "active": false,
          "ip_address_v4": "ip_address_v42"
        }
      },
      {
        "ethernet_details": {
          "active": false
        },
        "type": "ETHERNET",
        "application_details": {
          "application_type": "TERMINAL_API",
          "version": "version4",
          "session_location": "session_location0",
          "device_code_id": "device_code_id2"
        },
        "card_reader_details": {
          "version": "version0"
        },
        "battery_details": {
          "visible_percent": 108,
          "external_power": "AVAILABLE_CHARGING"
        },
        "wifi_details": {
          "active": false,
          "ssid": "ssid8",
          "ip_address_v4": "ip_address_v42",
          "secure_connection": "secure_connection8",
          "signal_strength": {
            "value": 222
          }
        }
      }
    ],
    "id": "device:995CS397A6475287",
    "status": {
      "category": "AVAILABLE"
    }
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}