Skip to navigation
Terminal APITerminals

List terminals

Returns the terminals registered to the account. Each terminal includes a capabilities object describing what the hardware supports. Check these flags before offering signature capture or receipt printing in your UI.

Authentication

AuthorizationBearer

Use a Payments API key as the bearer token: Authorization: Bearer <api_key>. Get a fresh key from Refresh API Keys.

Query parameters

midstringOptional

Merchant ID. Required when your bearer token is an ISV token acting on behalf of a merchant. If the mid can't be resolved to an authorized account, the request returns 400.

Response

Terminals retrieved successfully
device_idstring

Hardware Serial Number (HSN).

namestring
Display name of the terminal.
capabilitiesobject
What the terminal hardware supports.

Errors

401
Unauthorized Error
429
Too Many Requests Error