Vue d’ensemble

Nouveau sur l’API ? Commencez par le guide Intégration API (première requête, index OpenAPI, Try it, SDK et webhooks), puis revenez ici pour la carte complète des ressources.

Vous pouvez gérer les ressources (fournisseurs de paiement, etc.) et configurer des webhooks pour des notifications en temps réel.

Les chemins HTTP, méthodes et schémas de sécurité sont publiés dans la référence API, générée à partir des mêmes contrôleurs Nest qu’en production.

Environnements et authentification

lomi. propose des environnements Test et Live distincts, chacun avec sa base URL et ses clés API. Toutes les requêtes doivent inclure votre clé API secrète dans l’en-tête `X-API-Key`.

Détails sur les environnements, URL de base, obtention des clés et bonnes pratiques : Authentification.

Requêtes et réponses

Toutes les requêtes passent par HTTPS vers la base URL appropriée. Les corps (POST, PATCH) sont en JSON.

Les réponses sont en JSON. Succès : codes `2xx`. Échec : `4xx` ou `5xx` avec un objet d’erreur normalisé.

Structure succès et erreurs : Erreurs.

Comportement des paiements (au-delà des endpoints)

• Machine d’état des paiements — transitions statut transaction/fournisseur et idempotence.
• Solde et règlement — mise à jour des soldes et délais de disponibilité.
• Comportement du checkout — sessions, liens, coupons et règles globales.
• Cycle de vie des virements — sémantique des retraits et paiements sortants.
• Fiabilité des webhooks — tentatives et traitement idempotent.

Ressources API

Vue des ressources principales :

• Authentification : authentifier vos requêtes.
• Erreurs : erreurs renvoyées par l’API.
• Modèles de données : structure des objets clés.
• Marchands : compte marchand et métriques.
• Clients : profils clients.
• Produits : définitions produit.
• Transactions : détails des paiements.
• Abonnements : abonnements et helpers SDK.
• Abonnements clients : abonnements par client.
• Sessions de paiement : paiement en ligne.
• Liens de paiement : pages de paiement partageables.
• Fournisseurs : informations prestataires.
• Webhooks : endpoints d’événements.
• Remboursements : détails remboursement (bêta).
• Journal des modifications : évolutions API notables.

Versioning

L’API et les clients reflètent une version dans la doc ou info.version OpenAPI, mais il n’y a pas de préfixe /v1 sur les chemins HTTP. Les ruptures compatibles sont annoncées via le journal des modifications ; nous évitons les changements incompatibles sans préavis.