API
Overview & Status
Off-chain indexing architecture, scope boundaries, and implementation status.
The splitpay-api service provides an optional off-chain indexing, metadata caching, and webhook notification layer.
Implementation Status: Planned Service
splitpay-api is currently in the planning phase. It has not yet been deployed to production. The SplitPay decentralized application currently communicates directly with Stellar Soroban RPC nodes without requiring an intermediary backend.Scope & Authority Boundary
The API is explicitly designed as a convenience and indexing service:
- No Financial Authority: The API never calculates shares, maintains balances, or issues authorizations. All financial truth resides on Stellar.
- Derived State: Any cached balance or payment status returned by the API is strictly derived from verified on-chain ledger events.
Planned Backend Responsibilities
- Off-Chain Metadata: Associating pool IDs with project descriptions, client logos, and invoice attachments.
- Event Ingestion: Continuous ingestion of
pool_created,payment_settled, anddistribution_createdevents. - Webhooks: Real-time HTTP dispatches to external accounting platforms (e.g. QuickBooks, Xero) when a pool payment settles.