Developer Documentation

Integrate the Orchestrator

Everything you need to connect the Ocuula payment orchestrator to your application — authentication, split engine, provisioning API, webhook system, and transaction tracking.

Documentation

Getting Started

Understand the core concepts — split engine, routing rules, and provisioning models.

Authentication

Authenticate API requests using API keys. Authorization headers, sandbox vs live environments.

Split Engine Presets

Five presets for distributing funds — percentage, fixed, waterfall, tiered, and direct debit.

Splits API

Trigger split executions and batch operations via the Orchestrator API.

Transactions API

Query transaction details and track the status of split executions.

Provisioning API

Dynamically provision merchants under your platform using the Orchestrator provisioning endpoint.

Outbound Webhooks

Signed webhook events dispatched to your destination URL whenever a split is processed.

Wallet API

Check your sandbox wallet balance and top up test funds programmatically.

Rules API

Create, list, update, and delete routing rules programmatically via the Orchestrator API.

Fees & Pricing

Volume-tiered pricing model, fee caps, and the fee preview endpoint for estimating costs.

Validators Package

Shared Zod schemas and TypeScript types for split rules, fee calculations, Moolre APIs, and merchant provisioning.

Escrow & Approvals

Time-locked escrow holds and multi-signature approval gates for high-value disbursements.

USSD API

Offline field-agent payment triggers and interactive USSD session management.

Provisioning Models

The Orchestrator supports two merchant provisioning models:

Model A — Sub-Account

The parent merchant provisions a sub-account under its own tenant and Moolre credentials. Ideal for platforms that manage payments on behalf of sub-merchants.

Shared CredentialsSame Tenant

Model B — Direct Keys

The parent creates a new tenant organization with its own Moolre credentials. Each merchant manages their own API keys and settlement wallets.

Isolated TenantOwn Credentials