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

Object Index

You are viewing an old version of the API
DeviceMetadata BETA

Properties

Name Description
battery_percentage
string

The Terminal’s remaining battery percentage, between 1-100.

charging_state
string

The current charging state of the Terminal. Options: CHARGING, NOT_CHARGING

location_id
string

The ID of the Square seller business location associated with the Terminal.

merchant_id
string

The ID of the Square merchant account that is currently signed-in to the Terminal.

network_connection_type
string

The Terminal’s current network connection type. Options: WIFI, ETHERNET

payment_region
string

The country in which the Terminal is authorized to take payments.

serial_number
string

The unique identifier assigned to the Terminal, which can be found on the lower back of the device.

os_version
string

The current version of the Terminal’s operating system.

app_version
string

The current version of the application running on the Terminal.

wifi_network_name
string

The name of the Wi-Fi network to which the Terminal is connected.

wifi_network_strength
string

The signal strength of the Wi-FI network connection. Options: POOR, FAIR, GOOD, EXCELLENT

ip_address
string

The IP address of the Terminal.