Terminal

What it is

A terminal is a payment device resource used to process in-person payments. In the API, terminals belong to a store and have an identifier, name, status, type, and configuration. The API supports two terminal types: Smart and Internal.

Why it exists

It exists to model the physical payment endpoint where card-present transactions happen. A terminal can be queried, configured, monitored, and in some cases remotely controlled, which makes it the operational resource for POS payment flows.

How it relates to other concepts

• A Terminal belongs to a Store through storeId.
• Transactions can reference a terminal through terminalId
• Initiating a POS payment on a specific Terminal can be done by creating a Sale with terminal-specific payment method options.
• Payout grouping can also relate to terminal context when payouts are grouped by source.