Skip to content

Final POS API (1.2.4)

Welcome to the Final POS Public API—your playground for crafting the checkout and kiosk flows you want. Create your API keys in Manage (Settings > API Keys) and send them as x-api-key on every request. Customer endpoints use dynamic DTO generation so they adapt to your custom tables in real time, while the rest of the controllers follow a stable, static contract for predictable integrations.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
UNLICENSED
Languages
Servers
Mock server
https://docs.finalpos.com/_mock/openapi
Official API
https://api.finalpos.com

Data Transfer Objects (DTOs)

Schemas

Customer

Operations

Customers

Operations

Custom Tables: structure

Operations

Custom Table: content

Operations

Custom Tables: content

Operations

Product

Operations

Products

Operations

Outlet

Operations

Outlets

Operations

Category

Operations

Categories

Operations

Station

Operations

Create a new station

Request

Creates a new station record.

Security
X-Api-Key
Bodyapplication/jsonrequired
namestringrequired

Name of the station.

Example: "Super Station"
outletIdstringrequired

ID of the outlet this station belongs to.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstringrequired

Status of the station.

Example: "AVAILABLE"
deviceIdstring

Device ID of the station.

Example: "1234567890"
deviceNamestring

Name of the device.

Example: "Super Device"
stripeTerminalIdstring

Stripe terminal ID of the station.

Example: "tml_XXXXXXXXXX"
serialReaderIdstring

Serial reader ID of the station.

Example: "1234567890"
sequenceNumbernumber

Sequence number of the station.

Example: 1
isVirtualboolean

Whether the station is virtual.

Example: true
curl -i -X POST \
  https://docs.finalpos.com/_mock/openapi/v1/api/station \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Super Station",
    "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "status": "AVAILABLE",
    "deviceId": "1234567890",
    "deviceName": "Super Device",
    "stripeTerminalId": "tml_XXXXXXXXXX",
    "serialReaderId": "1234567890",
    "sequenceNumber": 1,
    "isVirtual": true
  }'

Responses

The station has been successfully created.

Bodyapplication/json
idstring

Unique identifier for the Station.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Station was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Station was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Station.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the station.

Example: "Super Station"
outletIdstring

ID of the outlet this station belongs to.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstring

Status of the station.

Example: "AVAILABLE"
deviceIdstring

Device ID of the station.

Example: "1234567890"
deviceNamestring

Name of the device.

Example: "Super Device"
stripeTerminalIdstring

Stripe terminal ID of the station.

Example: "tml_XXXXXXXXXX"
serialReaderIdstring

Serial reader ID of the station.

Example: "1234567890"
sequenceNumbernumber

Sequence number of the station.

Example: 1
isVirtualboolean

Whether the station is virtual.

Example: true
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "name": "Super Station",
  "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "status": "AVAILABLE",
  "deviceId": "1234567890",
  "deviceName": "Super Device",
  "stripeTerminalId": "tml_XXXXXXXXXX",
  "serialReaderId": "1234567890",
  "sequenceNumber": 1,
  "isVirtual": true
}

Get a station by ID

Request

Retrieves a single station by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Station ID

curl -i -X GET \
  'https://docs.finalpos.com/_mock/openapi/v1/api/station/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The station has been successfully retrieved.

Bodyapplication/json
idstring

Unique identifier for the Station.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Station was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Station was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Station.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the station.

Example: "Super Station"
outletIdstring

ID of the outlet this station belongs to.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstring

Status of the station.

Example: "AVAILABLE"
deviceIdstring

Device ID of the station.

Example: "1234567890"
deviceNamestring

Name of the device.

Example: "Super Device"
stripeTerminalIdstring

Stripe terminal ID of the station.

Example: "tml_XXXXXXXXXX"
serialReaderIdstring

Serial reader ID of the station.

Example: "1234567890"
sequenceNumbernumber

Sequence number of the station.

Example: 1
isVirtualboolean

Whether the station is virtual.

Example: true
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "name": "Super Station",
  "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "status": "AVAILABLE",
  "deviceId": "1234567890",
  "deviceName": "Super Device",
  "stripeTerminalId": "tml_XXXXXXXXXX",
  "serialReaderId": "1234567890",
  "sequenceNumber": 1,
  "isVirtual": true
}

Update a station by ID

Request

Updates an existing station record.

Security
X-Api-Key
Path
idstringrequired

Station ID

Bodyapplication/jsonrequired
namestring

Name of the station.

Example: "Super Station"
outletIdstring

ID of the outlet this station belongs to.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstring

Status of the station.

Example: "AVAILABLE"
deviceIdstring

Device ID of the station.

Example: "1234567890"
deviceNamestring

Name of the device.

Example: "Super Device"
stripeTerminalIdstring

Stripe terminal ID of the station.

Example: "tml_XXXXXXXXXX"
serialReaderIdstring

Serial reader ID of the station.

Example: "1234567890"
sequenceNumbernumber

Sequence number of the station.

Example: 1
isVirtualboolean

Whether the station is virtual.

Example: true
curl -i -X PUT \
  'https://docs.finalpos.com/_mock/openapi/v1/api/station/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Super Station",
    "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
    "status": "AVAILABLE",
    "deviceId": "1234567890",
    "deviceName": "Super Device",
    "stripeTerminalId": "tml_XXXXXXXXXX",
    "serialReaderId": "1234567890",
    "sequenceNumber": 1,
    "isVirtual": true
  }'

Responses

The station has been successfully updated.

Bodyapplication/json
idstring

Unique identifier for the Station.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
createdAtstring(date-time)

Timestamp when the Station was created.

Example: "2025-12-07T19:31:48.436+00:00"
updatedAtstring(date-time)

Timestamp when the Station was last updated.

Example: "2025-12-07T19:35:48.436+00:00"
companyIdstring

Company ID associated with the Station.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
namestring

Name of the station.

Example: "Super Station"
outletIdstring

ID of the outlet this station belongs to.

Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
statusstring

Status of the station.

Example: "AVAILABLE"
deviceIdstring

Device ID of the station.

Example: "1234567890"
deviceNamestring

Name of the device.

Example: "Super Device"
stripeTerminalIdstring

Stripe terminal ID of the station.

Example: "tml_XXXXXXXXXX"
serialReaderIdstring

Serial reader ID of the station.

Example: "1234567890"
sequenceNumbernumber

Sequence number of the station.

Example: 1
isVirtualboolean

Whether the station is virtual.

Example: true
Response
application/json
{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "name": "Super Station",
  "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "status": "AVAILABLE",
  "deviceId": "1234567890",
  "deviceName": "Super Device",
  "stripeTerminalId": "tml_XXXXXXXXXX",
  "serialReaderId": "1234567890",
  "sequenceNumber": 1,
  "isVirtual": true
}

Delete a station by ID

Request

Deletes a station by its unique identifier.

Security
X-Api-Key
Path
idstringrequired

Station ID

curl -i -X DELETE \
  'https://docs.finalpos.com/_mock/openapi/v1/api/station/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The station has been successfully deleted.

Bodyapplication/json
statusCodenumberrequired

HTTP status code

Example: 200
messagestringrequired

Message describing the result of the operation

Example: "Resource with Id 123 deleted successfully"
Response
application/json
{
  "statusCode": 200,
  "message": "Resource with Id 123 deleted successfully"
}

Stations

Operations

Variant

Operations

Variants

Operations

Order

Operations

Orders

Operations

Transactions

Operations

Roles

Operations

Attachment

Operations

Account

Operations

Refunds

Operations

Session

Operations

ZapierTriggers

Operations