Sign in

v1

latestOpenAPI 3.1.02026-07-1451432.5 KB
General

Get the account or store of a terminal

Returns the company account, merchant account, or store that a payment terminal is assigned to.

post/findTerminal

Request body

terminalstring required

The unique terminal ID in the format [Device model]-[Serial number].

For example, V400m-324689776.

Response

OK - the request has succeeded.

companyAccountstring required

The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account.

merchantAccountstring

The merchant account that the terminal is associated with. If the response doesn't contain a store the terminal is assigned to this merchant account.

merchantInventoryboolean

Boolean that indicates if the terminal is assigned to the merchant inventory. This is returned when the terminal is assigned to a merchant account.

  • If true, this indicates that the terminal is in the merchant inventory. This also means that the terminal cannot be boarded.

  • If false, this indicates that the terminal is assigned to the merchant account as an in-store terminal. This means that the terminal is ready to be boarded, or is already boarded.

storestring

The store code of the store that the terminal is assigned to.

terminalstring required

The unique terminal ID.