Physical POS

The Physical POS management API lets you manage the records of the POS setup in your stores from your own server: stores and registers, logical terminals, the terminals' bank details (merchant and terminal numbers), devices and the device linked to each terminal. You see and edit the same records in the panel; the API and the panel work on the same data.

This section covers the management endpoints only. Payment processing is not part of these endpoints. Vendor accounts (the details of your account with a POS vendor) are managed only in the panel; there is no API for them.

What it offers

Core concepts

Store and register

A store is a point of sale of your business (branch, shop, service point). A register is a checkout point inside a store and always belongs to exactly one store; a register is never moved to another store.

Stores and registers are environment-less: the test and live environments see the same store and register records. → Environments

Stores and registers are not deleted, they are archived. An archived record keeps its code and can be restored. When a store is archived, its active registers are archived in the same operation; when the store is restored, the registers stay archived.

Device and logical terminal

Physical POS has two separate records:

When the device changes (fault, loss, renewal), the logical terminal and its bank details stay the same; only the device linked to the terminal changes. This relation is called the device link:

• A terminal has at most one linked device at a time.
• A device is linked to at most one terminal at a time.

A logical terminal is environment-bound: every terminal is in either the test or the live environment, and this never changes.

The chain

The records connect like this:

Store
 └─ Register
     └─ Device                     (assigned to a store, optionally to a register)
         └─ Logical terminal       (device link)
             └─ Bank rows          (MID / TID at the banks)

A logical terminal is not attached to a store directly but through its linked device: the device is assigned to a store (and optionally to one of that store's registers), and the terminal is linked to that device. This is why the terminal's identity and bank details are kept even when the device changes.

Catalog

The catalog is shared reference data across the platform: vendors, device models and banks. You only read it. The vendorCode you use when creating a terminal comes from the vendor list; the vendorAcquirerRef on a bank row is mapped to a catalog bank through the vendor's bank code mapping.

Endpoints

Base URL: https://api-gateway.lunixi.com/api/v1/physical-pos

Pages in this section