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.

Le Payout Marchand envoie des fonds directement vers un numéro mobile money, sans que le bénéficiaire ait besoin d’un compte LigdiCash. C’est la méthode à privilégier quand le destinataire n’est pas inscrit sur LigdiCash ou quand vous souhaitez payer vers n’importe quel numéro mobile money.
Cette méthode n’est pas instantanée. Le délai de traitement peut aller de quelques secondes à plusieurs jours selon l’opérateur. Prévoyez un mécanisme de suivi via callback et/ou polling.

Prérequis

  • Le payout doit être activé sur votre projet API.
  • Vos adresses IP serveur doivent être whitelistées par LigdiCash — les requêtes provenant d’IP non whitelistées sont rejetées. Contactez developper@ligdicash.com pour l’activation.
  • Le sous-compte de l’opérateur correspondant au numéro bénéficiaire doit être suffisamment approvisionné.

Endpoint

POST https://app.ligdicash.com/pay/v01/straight/payout

En-têtes requis

En-têteValeur
ApikeyVotre clé API
AuthorizationBearer {AUTH_TOKEN}
Acceptapplication/json
Content-Typeapplication/json

Corps de la requête

Tous les champs sont imbriqués dans un objet commande.
commande
object
requis

Exemple de requête

curl --location 'https://app.ligdicash.com/pay/v01/straight/payout' \
--header 'Apikey: {API_KEY}' \
--header 'Authorization: Bearer {AUTH_TOKEN}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "commande": {
    "amount": 5000,
    "description": "Remboursement commande ORD-2024-001",
    "customer": "22670000000",
    "callback_url": "https://backend.masuperboutique.com/callback-payout",
    "custom_data": {
      "transaction_id": "PAYOUT-ORD-2024-001"
    }
  }
}'

Réponse

response_code
string
Code de résultat de la requête. "00" indique que le payout a été initié avec succès. Toute autre valeur indique une erreur.
token
string
Token JWT identifiant le payout. À stocker immédiatement — il est requis pour vérifier le statut si votre callback ne se déclenche pas.
response_text
string
Message textuel associé au code de réponse. Peut être vide.
description
string
Description complémentaire. Peut être vide.
custom_data
string
Toujours "" pour le Payout Marchand.
wiki
string
URL vers la liste des codes d’erreur spécifiques à cet endpoint. À consulter lorsque response_code !== "00".
Succès
{
  "response_code": "00",
  "token": "{PAYOUT_TOKEN}",
  "response_text": "",
  "description": "",
  "custom_data": "",
  "wiki": "https://client.ligdicash.com/wiki/createStraightWithdrawal"
}
Un response_code: "00" signifie que le payout a été initié, pas finalisé. Le résultat définitif vous parvient via le callback — qui peut arriver avec un délai significatif selon l’opérateur. Stockez le token pour pouvoir vérifier le statut en cas de non-réception.

Différences avec le Payout Client

Payout MarchandPayout Client
Endpoint/pay/v01/straight/payout/pay/v01/withdrawal/create
Compte LigdiCash requisNonOui
InstantanéNonOui (crédit wallet)
Paramètre top_up_walletAbsentRequis

Pages associées