Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://developers.ligdicash.com/llms.txt

Use this file to discover all available pages before exploring further.

Ce glossaire regroupe les termes que vous rencontrerez dans la documentation LigdiCash. Chaque définition est reliée aux pages où le concept est développé en détail.

A–C

Clé d’identification de votre projet API. Elle est transmise dans le header Apikey de chaque requête. Elle identifie le projet, pas l’utilisateur. À ne pas confondre avec le Auth Token.Voir Authentification.
Jeton d’authentification du compte marchand. Il est transmis dans le header Authorization: Bearer {AUTH_TOKEN}. Associé à l’Apikey, il forme la paire d’identification requise sur tous les endpoints.Voir Authentification.
Requête HTTP POST envoyée automatiquement par LigdiCash vers votre serveur lorsqu’une transaction change de statut. LigdiCash envoie deux requêtes à chaque événement : une en application/x-www-form-urlencoded et une en application/json. Pensez à dédupliquer.Voir Introduction au callback.
Facture de paiement créée côté LigdiCash lors de l’initiation d’un payin. Elle est identifiée par un token unique et contient les détails de la transaction (montant, opérateur, store, custom_data). Le terme apparaît dans les endpoints (/checkout-invoice/create, /checkout-invoice/confirm).
Tableau de métadonnées libres que vous attachez à une transaction lors de sa création. Il est retourné tel quel dans le callback, ce qui vous permet de retrouver votre propre identifiant de commande. LigdiCash y ajoute ses propres champs (logfile, id_invoice). Peut prendre trois formes dans le callback : tableau peuplé, [] (vide), ou "" (chaîne vide).Voir Parser custom_data.

D–L

Champ présent dans les requêtes payin sans redirection. Dans la plupart des cas, il doit rester vide (""). Ne pas confondre avec transaction_id que vous définissez dans custom_data.
Voir Checkout invoice.
Structure d’un élément du tableau custom_data. Chaque entrée est un objet { keyof_customdata: "clé", valueof_customdata: "valeur" }. Pour retrouver votre identifiant de commande, filtrez sur keyof_customdata === "transaction_id".Voir Parser custom_data.

M–O

Entreprise ou développeur intégrant l’API LigdiCash pour accepter ou émettre des paiements. Votre compte marchand est géré depuis le Dashboard LigdiCash.
Service de paiement mobile proposé par les opérateurs téléphoniques (Orange Money, Moov Africa, MTN, Wave, etc.). LigdiCash est un agrégateur : il abstrait tous ces opérateurs derrière une API unique.
Identifiant numérique retourné par l’API dans les réponses et callbacks pour désigner l’opérateur utilisé (ex : 11 pour Orange Burkina). Utile pour le logging et la réconciliation. Ne s’envoie pas dans les requêtes.Voir Opérateurs supportés.
Nom lisible de l’opérateur retourné par l’API (ex : "ORANGE BURKINA"). Toujours en majuscules dans les réponses LigdiCash.Voir Opérateurs supportés.
Code à usage unique servant à autoriser une transaction de payin sans redirection. Selon l’opérateur, il est généré par le client via menu USSD, envoyé par SMS, ou remplacé par une approbation directe sur l’app mobile money.Voir Modes de validation.

P–R

Opération de collecte : le client paie le marchand. LigdiCash propose deux modes — avec redirection (le client est renvoyé vers une page de paiement hébergée) et sans redirection (le paiement est initié programmatiquement via OTP ou approbation).Voir Vue d’ensemble de l’API de paiement.
Mode de payin où le client est redirigé vers une page de paiement hébergée par LigdiCash. L’intégration est simple mais impose des contraintes : pas d’iframe, customer vide, gestion des popups.Voir Payin avec redirection — Introduction.
Mode de payin où le marchand gère l’interface et soumet l’OTP via API. Plus de contrôle sur l’UX, mais une intégration plus complexe et spécifique à chaque opérateur.Voir Payin sans redirection — Introduction.
Opération de décaissement : le marchand envoie de l’argent à un client ou partenaire. Deux variantes : vers le wallet LigdiCash du destinataire (/withdrawal/create) ou directement vers son mobile money (/straight/payout).Voir Payout — Introduction.
Entité créée dans le Dashboard LigdiCash qui regroupe une Apikey et un Auth Token. Un compte marchand peut avoir plusieurs projets API (un par application, par pays, etc.).Voir Créer un projet API.
Code de retour présent dans toutes les réponses API LigdiCash. "00" = succès, "01" = échec. En cas d’échec, le champ wiki contient une URL vers la description détaillée.Voir Codes de réponse et statuts.

S–T

État courant d’une transaction. Valeurs possibles : Completed (confirmée), Pending (en attente), Cancelled (annulée). À récupérer via l’endpoint confirm ou via le callback.Voir Cycle de vie d’une transaction.
Objet représentant votre boutique dans une requête LigdiCash. Contient name, website_url, logo_url, et return_url. Apparaît dans le body des requêtes de création de facture.
Identifiant de transaction retourné par LigdiCash à la création d’une facture. Sert à appeler l’endpoint confirm pour vérifier le statut. Ce token est différent du token présent dans le callback — ne pas les confondre.Voir Tokens et identifiants.
Valeur du champ token reçue dans le payload callback. Elle est différente du token de création et ne doit pas être utilisée pour identifier la transaction. Utilisez toujours votre transaction_id stocké en base, ou re-vérifiez avec le token de création.Voir Sécurisation du callback.
Paramètre de l’endpoint /withdrawal/create. Détermine si l’argent reste dans le wallet LigdiCash du client (1) ou est automatiquement viré vers son mobile money lié (0).Voir Payout vers wallet LigdiCash.
Identifiant de commande que vous générez côté marchand et que vous injectez dans custom_data à la création. C’est la méthode recommandée pour corréler une transaction LigdiCash avec votre système de commandes — fiable dans tous les flux, y compris en cas de retry callback.Voir Le pattern transaction_id.

U–Z

Protocole de messagerie courte utilisé par les opérateurs mobile money pour déclencher des actions depuis le téléphone (ex : #144*82# pour Orange Burkina). En mode payin sans redirection OTP-USSD, le client compose le code USSD sur son téléphone pour obtenir son OTP avant que vous ne soumettiez la transaction.
Portefeuille électronique interne à LigdiCash, distinct des wallets des opérateurs mobile money. Le wallet LigdiCash peut recevoir des payouts via /withdrawal/create et est lié à un compte client LigdiCash.Voir Payout vers wallet LigdiCash.
Champ présent dans les réponses d’erreur de l’API LigdiCash. Contient une URL vers une page listant les sous-codes d’erreur spécifiques à l’endpoint appelé. À fetcher programmatiquement pour obtenir une description lisible de l’erreur.Voir Le champ wiki.
Devise utilisée par LigdiCash pour les transactions en Afrique de l’Ouest (Burkina Faso, Mali, Niger, Bénin, Togo, Côte d’Ivoire, Sénégal, Guinée-Bissau). Le XOF n’a pas de décimales — les montants sont toujours des entiers.Voir Devises et montants.