Organizations

The Organizations API provides access to your organization's details and business metrics.

Most integrations should treat the organization as the primary scope for API keys, balances, and settings. The Merchants API remains useful for merchant profile reads and legacy paths that still expose a merchant id.

Pricing configuration

Each organization has a pricing mode that determines how transaction fees are resolved:

• volume_tiered: dynamic pricing based on processed volume tiers
• fixed: stable organization fee schedule
• custom: negotiated fee schedule (also resolved from organization-level fee configuration)

In practice:

• volume_tiered organizations use their current tier fee structure for supported categories.
• fixed and custom organizations use organization fee configuration directly.
• Additional fees (for example refunds, disputes, international card surcharges, subscription add-ons) can still apply depending on your setup.

For the operational fee values currently applied to your account, rely on dashboard pricing screens and your latest commercial agreement.

Get organization details

Retrieve details of your authenticated organization.

import { LomiSDK } from '@lomi./sdk';

const lomi = new LomiSDK({
  apiKey: process.env.LOMI_SECRET_KEY!,
  environment: 'live',
});

const org = await lomi.organizations.list();
console.log(`Organization: ${org[0].name}`);

from lomi import LomiClient
import os

client = LomiClient(
    api_key=os.environ["LOMI_SECRET_KEY"],
    environment="test"
)

orgs = client.organizations.list()
print(f"Organization: {orgs[0]['name']}")

curl -X GET "https://api.lomi.africa/organizations" \
  -H "X-API-KEY: $LOMI_SECRET_KEY"

Get organization by ID

Retrieve a specific organization (must match your authenticated organization).

const org = await lomi.organizations.get('org_abc123...');

org = client.organizations.get('org_abc123...')

curl -X GET "https://api.lomi.africa/organizations/org_abc123..." \
  -H "X-API-KEY: $LOMI_SECRET_KEY"

Get organization metrics

Retrieve pre-calculated business metrics including MRR, ARR, revenue, and customer counts.

const metrics = await lomi.organizations.getMetrics();

console.log(`MRR: ${metrics.mrr} ${metrics.currency_code}`);
console.log(`ARR: ${metrics.arr} ${metrics.currency_code}`);
console.log(`Total Revenue: ${metrics.total_revenue}`);
console.log(`Total Customers: ${metrics.total_customers}`);
console.log(`Total Transactions: ${metrics.total_transactions}`);

metrics = client.organizations.get_metrics()

print(f"MRR: {metrics['mrr']} {metrics['currency_code']}")
print(f"ARR: {metrics['arr']} {metrics['currency_code']}")
print(f"Total Revenue: {metrics['total_revenue']}")
print(f"Total Customers: {metrics['total_customers']}")

curl -X GET "https://api.lomi.africa/organizations/metrics" \
  -H "X-API-KEY: $LOMI_SECRET_KEY"

Response

{
  "mrr": 50000,
  "arr": 600000,
  "total_revenue": 250000,
  "total_transactions": 1234,
  "total_customers": 567,
  "currency_code": "XOF",
  "calculated_at": "2024-01-15T00:00:00Z"
}

Metrics Object

Organization object

These fields align with the organization resource returned by GET /organizations (see API reference). Pricing modes (volume_tiered, fixed, custom) are explained above and in Pricing; they are not required to appear as a dedicated column on every organization payload.

Error Responses