Vue d’ensemble
Utilisez l’API marchande publique lomi. pour accepter des paiements, gérer les objets commerce, déplacer l’argent et traiter les événements opérationnels.
La référence API documente l’API marchande publique : les endpoints qu’un développeur doit utiliser depuis une intégration serveur. Elle n’expose volontairement pas les services internes de providers, organisations, administration marchande ou agents.
Si vous choisissez encore votre chemin d’intégration, commencez par Parcours d’intégration ou Quelle intégration choisir ?.
URLs de base
| Environnement | URL de base | Clé secrète |
|---|---|---|
| Test | https://sandbox.api.lomi.africa | lomi_sk_test_... |
| Live | https://api.lomi.africa | lomi_sk_live_... |
Envoyez la clé secrète dans l’en-tête X-API-Key depuis votre serveur.
Encaisser des paiements
| Objectif | API |
|---|---|
| Checkout hébergé | Sessions de checkout |
| URLs de paiement partageables | Liens de paiement |
| Demandes de paiement créées par le backend | Demandes de paiement |
| Flux Wave, MTN et carte plus bas niveau | Encaissements directs avancés |
Gérer votre commerce
| Objectif | API |
|---|---|
| Clients et sessions de portail client | Clients |
| Produits, prix et catalogues | Produits |
| Facturation récurrente et abonnements clients | Abonnements |
| Codes promo et performance des coupons | Coupons |
Déplacer et réconcilier l’argent
| Objectif | API |
|---|---|
| Lire les soldes disponibles et en attente | Soldes |
| Inspecter les enregistrements de paiement | Transactions |
| Créer et inspecter des remboursements | Remboursements |
| Créer et inspecter des reversements | Reversements |
Opérer de façon fiable
| Objectif | API |
|---|---|
| Configurer les endpoints, tester les livraisons, inspecter les journaux et relancer les échecs | Webhooks |
Conventions de référence
- Les guides expliquent les décisions produit et les flux complets.
- Les pages API décrivent les opérations HTTP exactes.
- Les encaissements directs sont avancés ; le checkout hébergé reste la recommandation par défaut.
- Utilisez la sandbox pour développer et le live seulement après Que vérifier avant le live ?.
Règles de contrat
- Montants : les champs
amountpublics sont des entiers en unités mineures.10000vaut 10 000 XOF, ou 100,00 USD/EUR. Envoyez toujourscurrency_code. - Idempotence :
Idempotency-Keyest obligatoire surPOST /checkout-sessions,POST /payment-requests,POST /refunds,POST /payouts,POST /settlements/instantetPOST /charge/*. Voir Clés d’idempotence. - Listes : interrogez avec
cursoretlimit(défaut 20, max 100). Réponse{ object: "list", data, has_more, next_cursor, limit }. - Erreurs :
{ error: { code, message, details }, request_id }. Voir Gestion des erreurs. - Limites : les réponses réussies incluent
X-RateLimit-Remaininget les en-têtes IETFRateLimit/RateLimit-Policy. Un429inclutRetry-After. - Les routes restent sans version. La
info.versionOpenAPI est la version du schéma. EnvoyezLomi-Versionpour figer un schéma connu.
Authentification
Les requêtes lomi. s’authentifient avec des clés API. Une requête sans clé valide renvoie une erreur d’authentification.
Gestion des erreurs
Comprendre et traiter les erreurs renvoyées par l’API.
Modèles de données
Les objets courants renvoyés par l’API publique lomi., avec les champs les plus utiles pour intégrer.
Statuts des paiements
Comment un paiement change de statut, expire, et met à jour votre solde.