Documentation

Getting Started

Provision your account, activate hardware, and process your first transaction.

• Account setup
• Handheld activation
• First test transaction

Talk to an engineer

API Reference

Endpoints for checkout, settlement routing, rewards, and reporting.

• Authentication
• Payments & settlement routing
• Rewards & ledger endpoints

Request API access

Hardware Setup

Unbox, activate, and configure the ClearPayments handheld for your team.

• Device provisioning
• Dock and charging setup
• Offline mode configuration

View hardware specs

Webhooks & Events

Subscribe to settlement, rewards, and payout events in real time.

• Settlement finality events
• Payout notifications
• Reward redemption events

Check system status