Skip to main content

​
Welcome to Clearline POS Integration Setup

Follow this guide to connect your POS system, register terminals, and start deploying marketing content via Customer Facing Screens (CFS), SMS, and other channels. This guide is designed for POS integrators, ISO partners, and technical teams.
1

Account & Portal Access

Register as a Partner or MerchantIf you’re a reseller, ISO partner, or direct merchant:
  • Contact your Clearline representative for onboarding.
  • Once onboarded, access the Admin Portal.
Access Portals:

Admin Portal

For managing accounts, locations, and API keys.

Clearline Marketing Center (CMC)

For location-level marketing management.
2

Client Authentication

  1. Authorization Code Flow with PKCE
  2. Client Credentials Grant Authorization (POS Authorization)
Use this API Key in headers for all API requests.
3

Set Up Locations & Terminals

Each physical store or merchant site must be registered as a Location via:
  • Admin Portal UI
  • or Locations API Endpoint
Link POS terminals or display screens (CFS) to their corresponding locations by:
  • Generating Activation Codes for each terminal.
  • Using API or manual entry to register terminals via serial numbers.
Merchants can activate terminals using activation codes directly on POS devices or through the CFS onboarding process.
4

Configure Customer Facing Screens (CFS)

  1. Assign CFS Display Templates to each terminal.
  2. Use Kiosk Mode or Checkout Integration based on terminal type.
  3. Manage content via:
    • CMC (Clearline Marketing Center)
    • API Endpoints for dynamic updates.
5

Optional: Smart Pages & Custom Marketing Apps

  1. Set up Smart Pages as QR destinations via the CMC or API.
  2. For tailored experiences, create Custom Marketing Apps using your content and display rules.
6

POS Marketing Rules Configuration

Define POS Marketing Rules to automate when and how content appears:
  • Trigger rules based on transaction types, customer interactions, or manual campaigns.
7

Deploy Campaigns

Use the CMC or APIs to create and manage:
  • Outbound Campaigns (SMS, MMS)
  • CFS Campaigns
  • QR Code Distributions
8

Testing & Validation

Use your staging environment to:
  • Simulate transactions.
  • Validate terminal content display.
  • Test API responses and webhooks.
9

Monitor & Optimize

Track terminal status, campaign performance, and customer engagement via:
  • Admin Portal Dashboards
  • CMC Reports
  • API Metrics Endpoints

​
Resources

API Documentation

Complete API reference and endpoints

Terminal Onboarding API

Terminal registration and activation

CFS Template Guide

Customer Facing Screen templates

POS Marketing Rules Overview

Marketing automation rules
Pro Tip: Start with one pilot merchant location, validate integration, then scale up to full rollout.