Skip to main content

Terminals & Point of Sale

In the Sticitt ecosystem, a Terminal represents a physical device or a virtual point-of-sale (POS) interface.

Integrators can "push" pending payments directly to these terminals. This causes the terminal to wake up and display the payment request to the cashier or customer immediately, removing the need for manual entry.

1. Finding a Terminal​

To interact with a terminal, you first need its unique terminalId. You can retrieve a list of all terminals linked to a specific merchant.

Endpoint: GET /v3/terminals

Parameters​

  • merchantId (Required): The UUID of the merchant.
  • pageSize & pageIndex: Pagination controls.

See API Reference for more details on this call

2. Pushing a Payment​

Once you have the terminalId and a valid paymentId (created via the Creating Payments API), you can push the payment to the device.

Endpoint: PATCH /v3/terminals

Parameters​

  • paymentId (Required): The UUID of the Payment Object.
  • terminalId (Required): The UUID of the Terminal.

See API Reference for more details on this call

Offline Errors

This operation requires the target terminal to be Online and Active (screen on, app running).

If the terminal is offline, sleep, or disconnected, the API will return an error.