Clarity Platform Architecture
A comprehensive reference for the platform architecture, integrations, security, and extensibility model.
Architecture Overview
Component Architecture
Tech Stack
Backend
Frontend
Database
Infrastructure
Documentation
Platform & Infra
Project structure, deployment architecture, hosting configuration, and routing setup.
Pipelines & Hooks
Serial and parallel pipelines, hook system, pre hooks, pipeline context, and caching strategy.
Database & Models
EF Core patterns, BaseEntity, model mapping, soft deletion, shadow properties, and dual-DB support.
API & Mutations
Query patterns, mutation engine architecture, and endpoint conventions.
Frontend
Remix routing, extension points, component overrides, and the theme editor.
Plugins
IPlugin interface, Git submodules, and the full plugin catalog.
Connectors & EkDB
ConnectCore integration layer, EkDB middleware, and the NetSuite connector reference.
Payment Hub
Provider interfaces, entity model, payment lifecycle, tokenization, and adding new providers.
Security & Compliance
Authentication, roles, permissions, encryption and TDE, and the no-PII-storage policy.
Operations
Deployment pipelines, scheduler, notifications, settings system, and business workflows.
Quality & Releases
Test infrastructure, release process, and failure mode analysis.
Platform Design Principles
Extensibility
Hooks, pipelines, and extension points ensure customization without modifying core code.
Plugin-First
All features are modular plugins that can be added, removed, or replaced.
Security by Default
All endpoints require authentication, payment data is tokenized, no PII stored.
Upgrade Safety
Client customizations live in isolated layers, never interfering with core updates.
ERP-Native Payment Experience
Payment forms embed directly within ERP interfaces like D365 and NetSuite. Users process payments without leaving their familiar workflow.
Multi-Tenant Architecture
Each client deployment uses dedicated, isolated database instances with per-tenant configuration and credential management.
Frequently Asked Questions
Unlike bolt-on payment solutions that redirect users to external interfaces, Clarity embeds payment functionality directly within ERP workflows. Users in D365 or NetSuite process payments, manage wallets, and handle refunds without ever leaving their familiar environment. The platform's plugin architecture means payment capabilities are deeply integrated with invoicing, order management, and customer data — not just connected via API. See Embedded vs. Integrated Payments.
Every feature in Clarity is a modular plugin registered through the IPlugin interface. Client-specific customizations are isolated in the Client layer, which hooks into core pipelines without modifying them. This means core and plugin updates can be applied independently of client customizations, and new capabilities can be added or removed without affecting the rest of the system. See Plugin System and Pipeline Hooks.
Yes. Each client deployment uses a dedicated database instance, providing complete data isolation. Configuration, credentials, and connector settings are managed per-tenant. The platform supports deploying multiple isolated instances from the same codebase, with client-specific customizations applied through the plugin and pipeline hook system. See Deployment Model.
Clarity supports multiple embedded payment models: direct iframe embedding within ERP interfaces (D365, NetSuite), self-service Quick Pay links delivered via email/SMS for invoice payments, full eCommerce checkout flows, and back-office CSR payment processing. All models use client-side direct-to-provider tokenization, ensuring PCI compliance (SAQ-A eligible) regardless of the embedding context. See Embedded Payments and Quick Pay.