Passer au contenu principal
Le Payout Client envoie des fonds vers le wallet LigdiCash d’un bénéficiaire identifié par son numéro de téléphone. Les fonds arrivent instantanément dans son wallet. Via le paramètre top_up_wallet, vous choisissez si les fonds y restent ou si LigdiCash déclenche automatiquement un virement vers son compte mobile money.
Cette méthode requiert que le bénéficiaire possède un compte LigdiCash. Si ce n’est pas le cas, utilisez le Payout Marchand qui envoie directement vers un numéro mobile money.

​
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/withdrawal/create

​
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

​
Le paramètre top_up_wallet

Les fonds arrivent dans le wallet LigdiCash du bénéficiaire et y restent. Le bénéficiaire peut les utiliser pour payer sur les plateformes LigdiCash ou initier lui-même un retrait vers son mobile money.À utiliser pour : créditer un compte fidélité, distribuer des récompenses que le bénéficiaire utilisera sur votre plateforme.

​
Exemple de requête

curl --location 'https://app.ligdicash.com/pay/v01/withdrawal/create' \
--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",
    "top_up_wallet": 1,
    "custom_data": {
      "transaction_id": "PAYOUT-ORD-2024-001"
    }
  }
}'

const response = await fetch('https://app.ligdicash.com/pay/v01/withdrawal/create', {
  method: 'POST',
  headers: {
    'Apikey': process.env.LIGDICASH_API_KEY,
    'Authorization': `Bearer ${process.env.LIGDICASH_AUTH_TOKEN}`,
    'Accept': 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    commande: {
      amount: 5000,
      description: 'Remboursement commande ORD-2024-001',
      customer: '22670000000',
      callback_url: 'https://backend.masuperboutique.com/callback-payout',
      top_up_wallet: 1,
      custom_data: {
        transaction_id: 'PAYOUT-ORD-2024-001',
      },
    },
  }),
});

const data = await response.json();

$response = $client->post('https://app.ligdicash.com/pay/v01/withdrawal/create', [
    'headers' => [
        'Apikey'        => $_ENV['LIGDICASH_API_KEY'],
        'Authorization' => 'Bearer ' . $_ENV['LIGDICASH_AUTH_TOKEN'],
        'Accept'        => 'application/json',
        'Content-Type'  => 'application/json',
    ],
    'json' => [
        'commande' => [
            'amount'       => 5000,
            'description'  => 'Remboursement commande ORD-2024-001',
            'customer'     => '22670000000',
            'callback_url' => 'https://backend.masuperboutique.com/callback-payout',
            'top_up_wallet'=> 1,
            '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
array
Toujours [] pour le Payout Client.
​
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/createWithdrawal"
}
Un response_code: "00" signifie que le payout a été initié, pas nécessairement finalisé. Le résultat définitif vous parvient via le callback. Stockez le token pour pouvoir vérifier le statut en cas de non-réception du callback.

​
Pages associées