A terminal (POS) represents a point where payments are collected inside a store. Each terminal allows a user to log in using a client ID and PIN, enter an amount, and initiate a terminal charge. Terminals help merchants manage different counters or operators under the same store and track their payment activity separately.
A terminal carries information like payment status and history, store details, custom fields, and timestamps. Once created, it can be activated, deactivated, or used to generate terminal charges.
Response
{
"id": "trm_mixxxxxxxxxx3rtv",
"object": "terminal",
"client_id": "uxxr",
"pin": "1111",
"store_id": "str_mixxxxxxxxxx3rtv",
"status": "active",
"created": 1764319719688,
"modified": 1764319719688
}
Attributes
id string
Unique identifier for the object.
object string
The type of the object indicates to which entity this response belongs.
client_id string
A unique alphanumeric identifier generated based on the value entered during creation. This ID is used by the terminal user to log in.
pin string
The pin assigned to the terminal during creation. This is a 4-digit numeric value used for terminal login.
store_id string
The store to which this terminal belongs. All payment activity triggered by this terminal is grouped under this store.
status enum
- active
- The terminal is allowed to log in and create charges.
- deactivate
- The terminal cannot be used until reactivated.
created timestamp
Time at which the terminal object was created.
modified timestamp
Time at which the last modification was made.