Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.quickei.io/llms.txt

Use this file to discover all available pages before exploring further.

Accept in-store payments with dynamic QR codes and hosted payment pages.

​
What is the POS API?

The POS API lets you create payment orders from any point-of-sale system — physical terminals, kiosks, mobile apps, or ERP integrations like Odoo. Each order generates a dynamic QR code and/or a hosted payment page.

QR Payments

Generate dynamic QR codes that customers scan with the Quickei app to pay instantly.

Payment Pages

Redirect customers to a hosted payment page — no frontend development needed.

Real-time Webhooks

Get instant notifications when payments are completed, expired, or refunded.

​
Base URL

https://quickei.io/merchant-api/pos/v1

​
Authentication

The POS API uses HTTP Basic Authentication. 
# Encode client_id:client_secret as base64
Authorization: Basic base64(client_id:client_secret)

# Example
curl -X POST https://quickei.io/merchant-api/pos/v1/orders \
  -H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=" \
  -H "Content-Type: application/json"
Find your client_id and client_secret in the Merchant Dashboard under Developer API > API Keys.

​
Rate Limiting

The POS API allows 60 requests per minute. If exceeded, you’ll receive a 429 Too Many Requests response.

​
Order Lifecycle

1

PENDING

Order created, awaiting customer payment. A QR code and/or payment page is generated.
2

PAID

Customer completed payment. You receive a pos.order.paid webhook.
3

EXPIRED / CANCELLED

Order expired (timeout) or was cancelled by the merchant via API.
4

REFUNDED

Payment refunded to the customer (may require admin approval).

​
Available Endpoints

MethodEndpointDescription
POST/ordersCreate a new POS order
GET/ordersList recent orders
GET/orders/{order_id}Get order details
POST/orders/{order_id}/cancelCancel a pending order
GET/terminalsList your terminals