Organisations

L’API Organizations expose les informations et indicateurs métier de votre organisation.

Pour la plupart des intégrations, l’organisation est la portée principale des clés API, soldes et paramètres. L’API Marchands reste utile pour les profils marchands et les chemins qui exposent encore un identifiant marchand.

Configuration tarifaire

Chaque organisation dispose d’un mode tarifaire qui détermine comment les frais sont calculés :

• volume_tiered : tarification dynamique selon paliers de volume traité
• fixed : grille de frais stable
• custom : grille négociée (résolue au niveau organisation)

En pratique :

• les organisations volume_tiered utilisent la structure de palier courante pour les catégories prises en charge ;
• les organisations fixed et custom s’appuient directement sur la configuration de frais ;
• des frais additionnels (remboursements, litiges, cartes internationales, options d’abonnement, etc.) peuvent encore s’appliquer selon votre configuration.

Pour les montants en vigueur sur votre compte, consultez le tableau de bord et votre convention commerciale.

Détail de l’organisation

Récupère le détail de votre organisation authentifiée.

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

const lomi = new LomiSDK({
  apiKey: process.env.LOMI_API_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_API_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_API_KEY"

Obtenir une organisation par ID

Récupère une organisation précise (doit correspondre à l’organisation authentifiée).

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_API_KEY"

Indicateurs de l’organisation

Indicateurs précalculés : MRR, ARR, chiffre d’affaires, nombre de clients, etc.

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_API_KEY"

Réponse

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

Objet Metrics

Objet Organization

Ces champs correspondent à la ressource organization renvoyée par GET /organizations (voir référence API). Les modes tarifaires (volume_tiered, fixed, custom) sont décrits ci-dessus et sous Tarification ; ils n’apparaissent pas forcément comme colonne dédiée dans chaque réponse.

Réponses d’erreur