POS Integration API

Developer
Documentation

Integrate LoyalCircle directly into your POS system. Start simple with one API call, or go advanced with full reward management.

API Key Auth
Real-time
RESTful

Choose Your Integration

Basic Integration

Quick Start

Just one API call per transaction. Perfect for getting started quickly. Customers earn points automatically.

  • Single endpoint
  • Auto-enrollment
  • 5 minute setup
Get Started

Advanced Integration

Full Features

Full control with all 4 endpoints. Customer lookup, reward selection, returns, and more.

  • Reward redemption
  • Returns & exchanges
  • Customer lookup
View Full API

Quick Start

1

Get API Key

Create an API key in your merchant dashboard under Settings → API Keys

2

Configure POS

Store your API key securely and configure your POS to call our endpoints

3

Start Integrating

Call the API on each transaction to earn and redeem loyalty points

Base URL

https://api.loyalcircle.club/api/v1

Authentication

X-API-Key: loy_your_api_key_here

Permissions

PermissionDescription
*Full access to all endpoints (recommended for POS)
earnProcess transactions: sales, returns, exchanges, and redemptions
balanceCheck customer points balance
customer.lookupLook up customers and view their available rewards

Error Responses

400Bad Request - Invalid parameters or missing required fields
{
  "success": false,
  "error": "customer_phone is required"
}
401Unauthorized - Invalid or missing API key
{
  "detail": "Invalid API key."
}
404Not Found - Customer not found
{
  "success": false,
  "error": "Customer not found"
}
409Conflict - Duplicate transaction (same receipt_number)
{
  "success": false,
  "error": "Duplicate transaction - receipt_number already processed"
}