Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
account-terminals

aid_account_management_terminals_get

List terminals for the account. Filter by store, payout destination, status, device model, or serial number.

scopes:

  • admin:accounts
  • read:accounts
get/accounts/{aid}/terminals

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Query parameters

payout_destination_idstring[]

Filter by Payout Destination ID

store_idstring[]

Filter by Store ID

statusstring[]

Filter terminals by status

device_modelstring[]

Filter terminals by device model

device_serial_numberstring[]

Filter terminals by device serial number

includesstring[]

Include related data. Use store to include basic store details along with the main payout destination for the store.

terminal_idstring[]

Filter by Terminal ID

searchstring

Search terminals by device serial number, terminal id, or device model.

starting_afterstring

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, end the result contains paging_token=pt1, your subsequent call can include starting_after=pt1 in order to fetch the next page of the list.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

Response

List of terminals

starting_afterstring

Example response

{
  "terminals": [
    {
      "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
      "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
      "terminal_id": "T12233302-T0001",
      "device_serial_number": "123456789012"
    }
  ]
}