POS Terminal Management v1 - Get the account or store of a terminal

Request parameters

Required Optional

terminal string Required

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

For example, V400m-324689776.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
companyAccount string

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.

merchantAccount string

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.

merchantInventory boolean

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.

store string

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

terminal string

The unique terminal ID.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
401 - Unauthorized

Authentication required.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
422 - Unprocessable Entity

A request validation error.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
500 - Internal Server Error

The server could not process the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.

Get the account or store of a terminal

Endpoint destination URL

Request parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error