Créer un payout wallet

Transfère des fonds vers le wallet LigdiCash d’un bénéficiaire, avec option de virement automatique vers son mobile money.

POST /pay/v01/withdrawal/create

Créer un payout wallet

cURL

curl --request POST \
  --url https://app.ligdicash.com/pay/v01/withdrawal/create \
  --header 'Accept: <accept>' \
  --header 'Apikey: <apikey>' \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "commande": {
    "amount": 123,
    "description": "<string>",
    "customer": "<string>",
    "callback_url": "<string>",
    "top_up_wallet": 123,
    "custom_data": {}
  }
}
'

200

{
  "response_code": "<string>",
  "token": "<string>",
  "response_text": "<string>",
  "description": "<string>",
  "custom_data": [
    {}
  ],
  "wiki": "<string>"
}

Le bénéficiaire doit posséder un compte LigdiCash. Pour envoyer directement vers un numéro mobile money sans compte LigdiCash, utilisez POST /pay/v01/straight/payout.

​

En-têtes

Apikey · string · requis

Clé API du projet LigdiCash.

Authorization · string · requis

Bearer {API_TOKEN}

Accept · string · requis

application/json

Content-Type · string · requis

application/json

​

Corps

commande · object · requis

Masquer commande

amount · integer · requis

Montant en XOF (entier positif).

description · string · requis

Description de l’opération.

customer · string · requis

Numéro de téléphone du bénéficiaire. Format : indicatif + numéro, sans + ni espaces. Exemple : 22670000000.

callback_url · string · requis

URL HTTPS de notification. Doit être accessible publiquement.

top_up_wallet · integer · requis

• 1 — les fonds restent dans le wallet LigdiCash du bénéficiaire.
• 0 — LigdiCash déclenche automatiquement un virement vers le compte mobile money lié.

custom_data · object

Métadonnées libres. Recommandé : inclure un transaction_id unique.

​

Réponse

response_code · string

"00" = payout initié, autre valeur = erreur.

token · string

Token du payout. À stocker — requis pour vérifier le statut.

response_text · string

Message associé. Peut être vide.

description · string

Description complémentaire. Peut être vide.

custom_data · array

Toujours [].

wiki · string

URL de la documentation des sous-codes.

Succès

{
  "response_code": "00",
  "token": "{PAYOUT_TOKEN}",
  "response_text": "",
  "description": "",
  "custom_data": [],
  "wiki": "https://client.ligdicash.com/wiki/createWithdrawal"
}

​

Codes d’erreur

Wiki : https://client.ligdicash.com/wiki/createWithdrawal — voir Sous-codes par endpoint.

​

Guide associé

Payout Client — vers wallet LigdiCash — cas d’usage et détail de top_up_wallet.