Skip to main content
ShumoulShumoul Developer Portalplatform.shumoul.com
Version: Latest

Shumoul Payments Framework — Developer Guide

The Shumoul Payments Framework (Shumoul.Saas.Payments, package family Shumoul.Payments.*) is a standalone, provider-agnostic payment module for the Shumoul Cloud ERP platform. It gives POS/Order/Invoice flows a single, consistent way to create a payment with an external provider, track its lifecycle, and link it back to the ERP's own payment records — without any ERP service needing to know which provider (Geidea, or a future provider) is actually processing the money.

Who it's for: Backend Developers · POS/Flutter Client Developers · QA Engineers · Technical Partners integrating a new payment provider or a new POS client against this framework.

FieldValue
StatusPartially documented — Geidea integration chapter published; broader framework reference (full package/API docs) not yet written
VersionLatest
Last Updated2026-07-11
Maintained ByShumoul Engineering
DocumentationOfficial Developer Guide
Source of TruthShumoul Platform Source Code (Shumoul.Saas.Payments + Shumoul.Saas.Api)

Chapters​

  1. Geidea Payments Integration — Payment Intent, POS, and Split-Payment Flow

Additional chapters (framework architecture reference, provider-onboarding guide, refund/reversal design) will be added here as they are written — see the status note at the top of Chapter 1 for exactly what is and is not yet validated against a real Geidea sandbox.

  • Business Onboarding & Smart Configuration
  • Multi-Tenancy Framework — every PaymentProviderAccount is tenant-scoped through the platform's standard tenant isolation; a dedicated chapter for this framework is not yet published on this portal.