Introduction

Environment

Set up your development environment by following the environment guide.

Connection

Create the connection. Select the option that fits your architecture:

• WebSocket - ideal for POS systems running on local hardware behind a NAT, such as a desktop application in the restaurant.
• Long-Polling - suitable for similar deployments when WebSockets are not available.
• Webhooks - recommended for cloud-based POS systems. Qerko sends webhooks to your service and expects a response.

First method

Once the connection to Qerko is in place, begin with getTableList(). You can verify the implementation by loading the QR codes pairing page, which calls getTableList() on every load.

See the QR codes pairing flow for detailed guidance.

Pair QR codes

When your tables appear in Qerko’s Restaurant Admin, assign QR codes to them.

Scan QR code

After pairing, scan a QR code with the Qerko mobile app. See the development setup section for additional details.

What’s on the table?

When the QR code is scanned, Qerko calls getTableContents(). Continue by returning the table contents.

Payment

When Bill entries appear in the Qerko app, implement getBill(…), paymentStart(…), paymentProcessed(…), and paymentClosed(…).

Refer to the payment flow for the complete sequence.

Congratulations!

You have completed the payment flow. To extend the integration, continue with Orders. We look forward to supporting your next steps.