Documentation

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Features
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    SubscriptionConductor
    PaymentConductor
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    Affiliate & Referral Enablement
    Referral Codes (Refcodes)
    NFT Exhibition Marketplace
    Solana NFT Gates
    Token Staking System
    Owner Project Lab
    Entities
    Opportunities
    Real-Time Messaging
    Ring Tasks
    WebRTC Calls & STUNner TURN
    Peer Games
    News Module
    Member Blogs
    Public Profile Pages
    Ring File Cabinet
    Username Reservation System
    Scientific Editor
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Email AI-CRM
    Ring Mailer & RingdomX Mail
    Tunnel Protocol
    VideoConductor
    MediaConductor
    Generative Gallery
    Authentication
    Security & Compliance
    Admin console
    Admin Wiki
    Manage via Telegram
    Locale System
    Mobile Experience
    Performance Optimization Patterns
    Examples
    Quick Start
    Basic Setup
    White Label
    Custom Branding
    Web3 Integration
    Real World
    Advanced Features
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Web3
    Token launch jurisdictions
    Wallet
    Wallet Security Tips
    Integrations
    Ethereum wallets (Wagmi v3)
    RingFileBase (object storage API)
    Ring CDN (RingFileBase edge)
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Development
    Ring MCP Server

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)

    Documentation

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Features
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    SubscriptionConductor
    PaymentConductor
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    Affiliate & Referral Enablement
    Referral Codes (Refcodes)
    NFT Exhibition Marketplace
    Solana NFT Gates
    Token Staking System
    Owner Project Lab
    Entities
    Opportunities
    Real-Time Messaging
    Ring Tasks
    WebRTC Calls & STUNner TURN
    Peer Games
    News Module
    Member Blogs
    Public Profile Pages
    Ring File Cabinet
    Username Reservation System
    Scientific Editor
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Email AI-CRM
    Ring Mailer & RingdomX Mail
    Tunnel Protocol
    VideoConductor
    MediaConductor
    Generative Gallery
    Authentication
    Security & Compliance
    Admin console
    Admin Wiki
    Manage via Telegram
    Locale System
    Mobile Experience
    Performance Optimization Patterns
    Examples
    Quick Start
    Basic Setup
    White Label
    Custom Branding
    Web3 Integration
    Real World
    Advanced Features
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Web3
    Token launch jurisdictions
    Wallet
    Wallet Security Tips
    Integrations
    Ethereum wallets (Wagmi v3)
    RingFileBase (object storage API)
    Ring CDN (RingFileBase edge)
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Development
    Ring MCP Server

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)

    Documentation

    Concepts, value, and typical clone scenarios — less code.

    Welcome to Ring
    Quick Reference
    Getting Started
    Prerequisites
    Installation
    First Success Validation
    Next Steps
    Features
    Multi-Vendor Store
    Inventory & Stock
    Vendor Management
    Commissions & Settlements
    SubscriptionConductor
    PaymentConductor
    Payments Overview
    Public Pools & DAO Jars
    WayForPay Payment Integration
    Wallet & Credit System
    WalletConductor
    Affiliate & Referral Enablement
    Referral Codes (Refcodes)
    NFT Exhibition Marketplace
    Solana NFT Gates
    Token Staking System
    Owner Project Lab
    Entities
    Opportunities
    Real-Time Messaging
    Ring Tasks
    WebRTC Calls & STUNner TURN
    Peer Games
    News Module
    Member Blogs
    Public Profile Pages
    Ring File Cabinet
    Username Reservation System
    Scientific Editor
    Notifications
    Push Notifications with FCM (Ring-Powered)
    Email AI-CRM
    Ring Mailer & RingdomX Mail
    Tunnel Protocol
    VideoConductor
    MediaConductor
    Generative Gallery
    Authentication
    Security & Compliance
    Admin console
    Admin Wiki
    Manage via Telegram
    Locale System
    Mobile Experience
    Performance Optimization Patterns
    Examples
    Quick Start
    Basic Setup
    White Label
    Custom Branding
    Web3 Integration
    Real World
    Advanced Features
    Customization
    Quick Start — Your First Ring Clone
    Customization Guide
    Branding
    Themes
    Features
    Localization
    Token Economics Setup
    Payment Gateway Integration
    Reference Ring deployments
    Web3
    Token launch jurisdictions
    Wallet
    Wallet Security Tips
    Integrations
    Ethereum wallets (Wagmi v3)
    RingFileBase (object storage API)
    Ring CDN (RingFileBase edge)
    Deployment
    Self-hosted deployment
    Vercel
    Docker
    Environment Configuration
    Monitoring & Analytics
    Performance Optimization
    Backup & Recovery
    Architecture
    Data Model
    Security
    Real Time
    Discovery Mutation Sync
    PaymentConductor architecture
    WalletConductor architecture
    Development
    Ring MCP Server

    Quick entry (CTOs · auditors · agents)

    Welcome — mission & audiences
    Quick Reference
    Getting started
    Architecture & Auth.js
    Backend modes & databases (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Deploy (Docker · k8s)
    Security & compliance reads
    ringdom.org — LegioX homebase
    Source — MIT license (GitHub)
    1. Docs
    2. /Features
    3. /Ring ERP
    4. /Commissions & Settlements
    Updated Jul 23, 20262 min listen
    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    1. Docs
    2. /Features
    3. /Ring ERP
    4. /Commissions & Settlements
    Updated Jul 23, 20262 min listen
    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    1. Docs
    2. /Features
    3. /Ring ERP
    4. /Commissions & Settlements
    Updated Jul 23, 20262 min listen
    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Commissions & Settlements

    settlement.ts calculates platform commission, optional referral commission, and merchant splits. This is the vendor-funded rail. Platform-funded token rewards live on refcodes.

    Dual-rail

    Same orderReference should appear on settlements, erp_sales_assists, and referral_rewards for cross-audit. See Affiliate enablement.

    Operator cockpit — /admin/store/commissions

    ActionWhat it does
    Status filtersPending / held / completed
    Dry-run due payoutsCounts due rows + net total — no money moved
    Process due payoutsRuns processDueSettlements for scheduledFor <= now and status = pending
    HoldBlocks a pending settlement from payout (status = held)
    ReleaseReturns a held settlement to pending
    Referral rates tableEffective % per product with resolver source

    Vendor view: /vendor/earnings — pending + history from the same settlements collection. Simulated payouts show a Simulated badge until on-chain mode is production-verified.

    Unified ledger flow

    Paid store orders call VendorSettlementService.processSettlements → recordSettlementsForPaidOrder → createSettlement per vendor slice into canonical settlements.

    Stock commit runs alongside (not inside) settlement: handlers call commitSaleForOrder then settlements.

    CollectionRole
    settlementsCommission/payout ledger — admin Commissions, vendor Earnings
    payout_batchesBatch runs from Process due payouts
    erp_sales_assistsReferral-attributed sale rows when referralCode is on the order
    vendor_settlementsLegacy log (not written on new paid orders)
    Paid order stock commit then settlements

    Admin actions (verified)

    Related documentation

    Inventory & Stock

    Depends-on: stock commit before settlement side-effects on paid order.

    Affiliate & Referral Enablement

    Same-workflow: dual-rail overview and verification checklist.

    Referral Codes (Refcodes)

    See-also: platform-funded token rewards sharing commission resolver.

    Vendor Management

    Next-step: vendor earnings and merchant config context.

    Commissions & Settlements

    settlement.ts calculates platform commission, optional referral commission, and merchant splits. This is the vendor-funded rail. Platform-funded token rewards live on refcodes.

    Dual-rail

    Same orderReference should appear on settlements, erp_sales_assists, and referral_rewards for cross-audit. See Affiliate enablement.

    Operator cockpit — /admin/store/commissions

    ActionWhat it does
    Status filtersPending / held / completed
    Dry-run due payoutsCounts due rows + net total — no money moved
    Process due payoutsRuns processDueSettlements for scheduledFor <= now and status = pending
    HoldBlocks a pending settlement from payout (status = held)
    ReleaseReturns a held settlement to pending
    Referral rates tableEffective % per product with resolver source

    Vendor view: /vendor/earnings — pending + history from the same settlements collection. Simulated payouts show a Simulated badge until on-chain mode is production-verified.

    Unified ledger flow

    Paid store orders call VendorSettlementService.processSettlements → recordSettlementsForPaidOrder → createSettlement per vendor slice into canonical settlements.

    Stock commit runs alongside (not inside) settlement: handlers call commitSaleForOrder then settlements.

    CollectionRole
    settlementsCommission/payout ledger — admin Commissions, vendor Earnings
    payout_batchesBatch runs from Process due payouts
    erp_sales_assistsReferral-attributed sale rows when referralCode is on the order
    vendor_settlementsLegacy log (not written on new paid orders)
    Paid order stock commit then settlements

    Admin actions (verified)

    Related documentation

    Inventory & Stock

    Depends-on: stock commit before settlement side-effects on paid order.

    Affiliate & Referral Enablement

    Same-workflow: dual-rail overview and verification checklist.

    Referral Codes (Refcodes)

    See-also: platform-funded token rewards sharing commission resolver.

    Vendor Management

    Next-step: vendor earnings and merchant config context.

    Commissions & Settlements

    settlement.ts calculates platform commission, optional referral commission, and merchant splits. This is the vendor-funded rail. Platform-funded token rewards live on refcodes.

    Dual-rail

    Same orderReference should appear on settlements, erp_sales_assists, and referral_rewards for cross-audit. See Affiliate enablement.

    Operator cockpit — /admin/store/commissions

    ActionWhat it does
    Status filtersPending / held / completed
    Dry-run due payoutsCounts due rows + net total — no money moved
    Process due payoutsRuns processDueSettlements for scheduledFor <= now and status = pending
    HoldBlocks a pending settlement from payout (status = held)
    ReleaseReturns a held settlement to pending
    Referral rates tableEffective % per product with resolver source

    Vendor view: /vendor/earnings — pending + history from the same settlements collection. Simulated payouts show a Simulated badge until on-chain mode is production-verified.

    Unified ledger flow

    Paid store orders call VendorSettlementService.processSettlements → recordSettlementsForPaidOrder → createSettlement per vendor slice into canonical settlements.

    Stock commit runs alongside (not inside) settlement: handlers call commitSaleForOrder then settlements.

    CollectionRole
    settlementsCommission/payout ledger — admin Commissions, vendor Earnings
    payout_batchesBatch runs from Process due payouts
    erp_sales_assistsReferral-attributed sale rows when referralCode is on the order
    vendor_settlementsLegacy log (not written on new paid orders)
    Paid order stock commit then settlements

    Admin actions (verified)

    Related documentation

    Inventory & Stock

    Depends-on: stock commit before settlement side-effects on paid order.

    Affiliate & Referral Enablement

    Same-workflow: dual-rail overview and verification checklist.

    Referral Codes (Refcodes)

    See-also: platform-funded token rewards sharing commission resolver.

    Vendor Management

    Next-step: vendor earnings and merchant config context.

    ActionPath
    processDueSettlementsActionapp/_actions/admin-store-erp.ts
    previewDueSettlementsActiondry-run preview
    holdSettlementAction / releaseHeldSettlementActionwraps holdSettlement / releaseHeldSettlement
    CronProcessConductor settlement-payout → /api/cron/settlement-payout

    Referral commission hierarchy

    Shared resolver features/store/lib/referral-commission.ts:

    PrioritySource
    1Product referralCommission
    2Merchant commissionStructure.referralCommission
    3Platform default (5%)
    4Env REFERRAL_REWARD_PERCENT

    Optional clamp: REFERRAL_COMMISSION_MAX_PERCENT (default 50).

    Payout modes

    SETTLEMENT_PAYOUT_MODEBehavior
    simulated (default)Completes with metadata.simulated / sim_ id
    onchainERC20 via treasury (SETTLEMENT_PAYOUT_PRIVATE_KEY, token address, RPC)

    Database

    Migration 007_settlements_schema.sql (plus inventory tables in schema / 008_*). Dev helper: ./scripts/apply-erp-migrations-dev.sh when present on the clone.

    PaymentConductor

    Prerequisite: paid handlers trigger processSettlements.

    ActionPath
    processDueSettlementsActionapp/_actions/admin-store-erp.ts
    previewDueSettlementsActiondry-run preview
    holdSettlementAction / releaseHeldSettlementActionwraps holdSettlement / releaseHeldSettlement
    CronProcessConductor settlement-payout → /api/cron/settlement-payout

    Referral commission hierarchy

    Shared resolver features/store/lib/referral-commission.ts:

    PrioritySource
    1Product referralCommission
    2Merchant commissionStructure.referralCommission
    3Platform default (5%)
    4Env REFERRAL_REWARD_PERCENT

    Optional clamp: REFERRAL_COMMISSION_MAX_PERCENT (default 50).

    Payout modes

    SETTLEMENT_PAYOUT_MODEBehavior
    simulated (default)Completes with metadata.simulated / sim_ id
    onchainERC20 via treasury (SETTLEMENT_PAYOUT_PRIVATE_KEY, token address, RPC)

    Database

    Migration 007_settlements_schema.sql (plus inventory tables in schema / 008_*). Dev helper: ./scripts/apply-erp-migrations-dev.sh when present on the clone.

    PaymentConductor

    Prerequisite: paid handlers trigger processSettlements.

    ActionPath
    processDueSettlementsActionapp/_actions/admin-store-erp.ts
    previewDueSettlementsActiondry-run preview
    holdSettlementAction / releaseHeldSettlementActionwraps holdSettlement / releaseHeldSettlement
    CronProcessConductor settlement-payout → /api/cron/settlement-payout

    Referral commission hierarchy

    Shared resolver features/store/lib/referral-commission.ts:

    PrioritySource
    1Product referralCommission
    2Merchant commissionStructure.referralCommission
    3Platform default (5%)
    4Env REFERRAL_REWARD_PERCENT

    Optional clamp: REFERRAL_COMMISSION_MAX_PERCENT (default 50).

    Payout modes

    SETTLEMENT_PAYOUT_MODEBehavior
    simulated (default)Completes with metadata.simulated / sim_ id
    onchainERC20 via treasury (SETTLEMENT_PAYOUT_PRIVATE_KEY, token address, RPC)

    Database

    Migration 007_settlements_schema.sql (plus inventory tables in schema / 008_*). Dev helper: ./scripts/apply-erp-migrations-dev.sh when present on the clone.

    PaymentConductor

    Prerequisite: paid handlers trigger processSettlements.