Parcours d’intégration
De la sandbox au live : compte, clés, premier paiement, webhooks et mise en production.
Le checkout hébergé, les liens de paiement, les abonnements et les autres produits ci-dessous passent tous par la même API marchande. Le choix de ce que vous construisez est indépendant de comment vous utilisez lomi. : API, SDK, CLI ou MCP.
Dans la sandbox
- Payer avec des cartes de test
- Laisser Wave et MTN se compléter automatiquement avec une clé test
- Envoyer
X-Scenario-Key: pendingoufailedsur les charges Wave/MTN directes - Transférer les webhooks avec
lomi listen
En live, vous ne pouvez pas
- Auto-compléter le Mobile Money (le client doit approuver sur l’appareil)
- Utiliser les PAN de test (ils ne fonctionnent qu’avec une clé test)
Comment utiliser lomi.
Choisissez la surface qui correspond à votre façon de travailler.
Appeler le contrat HTTP directement
POST /checkout-sessions
Utilisez l’API quand vous voulez la requête et la réponse exactes, un langage sans SDK officiel, ou comparer avec l’OpenAPI. Envoyez votre clé secrète en X-API-Key (LOMI_SECRET_KEY). Idempotency-Key est obligatoire sur les écritures qui déplacent de l’argent.
Créer un checkout sandbox :
curl -sS -X POST "https://sandbox.api.lomi.africa/checkout-sessions" \
-H "X-API-Key: $LOMI_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"amount": 10000,
"currency_code": "XOF",
"title": "Commande de test",
"success_url": "https://example.com/success",
"cancel_url": "https://example.com/cancel"
}'Ouvrez checkout_url dans la réponse et payez avec un moyen de test sandbox. Parcours complet : Comment tester un paiement ?. Détail de l’endpoint : Créer une session checkout.
Appeler lomi. depuis votre code
@lomi./sdk
Le SDK lomi. est le moyen le plus rapide d'appeler l'API lomi. depuis le code de votre application, créer des sessions de checkout, gérer les clients et abonnements, émettre des remboursements et vérifier les webhooks, avec des méthodes typées et une gestion d'erreurs intégrée.
Ce guide utilise le SDK TypeScript (@lomi./sdk). Le même parcours s'applique à Python, Go et PHP. Installez avec npm install @lomi./sdk, définissez LOMI_SECRET_KEY dans .env, puis :
const session = await lomi.checkoutSessions.create({
amount: 10000,
currency_code: 'XOF',
title: 'Abonnement premium',
success_url: 'https://example.com/success',
cancel_url: 'https://example.com/cancel',
});
console.log('Rediriger vers :', session.checkout_url);lomi init peut écrire automatiquement le client SDK, des fichiers d'exemple et votre .env. Parcours complet : Démarrer avec le SDK. Références : SDKs.
Travailler depuis le terminal
lomi checkout create
Le CLI lomi. est le moyen le plus rapide de s’authentifier, créer des checkouts de test, écouter les webhooks sans ngrok et installer des règles pour agents IA, depuis le terminal.
Nécessite Node.js 18+ (uniquement pour télécharger le binaire natif) :
npm install -g lomi.cli
lomi login
lomi quickstart
lomi checkout create \
--amount 10000 \
--currency XOF \
--success-url https://example.com/success \
--cancel-url https://example.com/cancel \
--jsonOuvrez le checkout_url de la réponse JSON. Relayer les webhooks avec lomi listen http://localhost:3000/webhooks. lomi login enregistre un jeton CLI. lomi init écrit votre clé API secrète (LOMI_SECRET_KEY) pour le SDK. Ce sont des identifiants distincts. Parcours complet : Démarrer avec le CLI. Référence : CLI.
Laisser un client IA appeler l’API marchande
lomi_checkout
Le Model Context Protocol (MCP) laisse des assistants IA (Cursor, Claude Desktop, agents custom) appeler l’API marchande lomi. pour vous : créer des checkouts, lister les paiements, déboguer les webhooks, sans écrire chaque requête HTTP à la main.
Recommandé pour Cursor / Claude / VS Code : ajoutez l’URL MCP hébergée sans clé API. Les clients OAuth ouvrent Connect with lomi. dans le navigateur :
{
"mcpServers": {
"lomi.": {
"url": "https://mcp.lomi.africa/mcp"
}
}
}Demandez ensuite au client de créer une session checkout (lomi_checkout, action=create). Les outils marchands suivent lomi_<resource> avec un action obligatoire. Dans le tableau de bord : Paramètres → Intégrations → MCP, puis Développeurs → Clés API → Connect MCP. Guide complet : MCP pour clients IA.
Étape 1: Créer un compte développeur
Inscrivez-vous pour accéder à l’environnement test et exécuter des flux complets sans argent réel.
En mode test vous pouvez :
- Accepter des paiements avec cartes test et mobile money simulé.
- Créer sessions checkout, liens et charges directes sur l’API sandbox.
- Recevoir des webhooks avec
"environment": "test".
Voir Créer votre compte et Clés API.
Étape 2: Choisir votre intégration
lomi. propose plusieurs options d’intégration selon votre stack :
| Besoin | Commencez par |
|---|---|
| Page checkout complète | Checkout hébergé |
| Checkout intégré sur votre site | Widget checkout |
| URL partageable | Liens de paiement |
| Demande de paiement créée côté backend | Demandes de paiement |
| Mobile money ou cartes côté serveur | Charges directes |
| Facturation récurrente | Abonnements |
| Plugin boutique (WooCommerce, Shopify, etc.) | Extensions e‑commerce |
Définissez ce que vous vendez dans Produits avant de créer des sessions checkout ou des plans d’abonnement.
La plupart des équipes commencent par le checkout hébergé. Consultez Quelle intégration choisir ? et Canaux de paiement pour confirmer la couverture Wave, MTN et cartes sur vos marchés.
Étape 3: Tester de bout en bout
Testez votre intégration à fond avec les identifiants sandbox :
- Comment tester un paiement ? : checkout CLI ou API.
- Paiements sandbox: cartes, Wave, MTN
- Tester les échecs avec Simuler des erreurs
- Gestion des erreurs et idempotence
- Cas limites checkout (abonnements, essais, mobile money en attente) : Comportement checkout et guides par canal sous Canaux de paiement.
Le même premier checkout peut être créé depuis REST, le SDK, le CLI ou MCP. Les parcours CLI et cURL sont détaillés dans Comment tester un paiement ?. SDK et MCP : Démarrer avec le SDK et MCP.
Étape 4: Configurer les webhooks
Les webhooks sont essentiels pour les moyens de paiement et les événements hors de votre application, comme l’approbation mobile money et les renouvellements d’abonnement.
- Enregistrez une URL HTTPS dans le portail.
- Suivez Configurer les webhooks et Traiter les webhooks.
- Vérifiez la signature sur le corps brut avant de parser le JSON.
Renouvellements d’abonnement : les abonnements carte se renouvellent hors session ; écoutez SUBSCRIPTION_RENEWED et les PAYMENT_FAILED de renouvellement. Wave et MTN utilisent un lien checkout de renouvellement manuel envoyé avant chaque échéance, le client doit payer ce lien ; pas de débit wallet silencieux. Voir Abonnements : renouvellements.
Étape 5: Passer en live
- Vérification du compte et configuration des reversements.
- Passez à
lomi_sk_live_...ethttps://api.lomi.africa. - Suivez Que vérifier avant le live ? et traitez un petit paiement live avec webhook.