Skip to main content

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.

Merchant payout sends funds directly to a mobile money number, without the beneficiary needing a LigdiCash account. This is the method to use when the recipient is not registered on LigdiCash or when you want to pay to any mobile money number.
This method is not instant. Processing time can range from a few seconds to several days depending on the operator. Plan for a tracking mechanism via callback and/or polling.

​
Prerequisites

  • Payout must be enabled on your API project.
  • Your server IP addresses must be whitelisted by LigdiCash — requests from non-whitelisted IPs are rejected. Contact developper@ligdicash.com to enable it.
  • The sub-account of the operator matching the beneficiary’s number must be sufficiently funded.

​
Endpoint

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

​
Required headers

HeaderValue
ApikeyYour API key
AuthorizationBearer {AUTH_TOKEN}
Acceptapplication/json
Content-Typeapplication/json

​
Request body

All fields are nested inside a commande object.
​
commande
object
required

​
Request example

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": "Refund for order ORD-2024-001",
    "customer": "22670000000",
    "callback_url": "https://backend.mygreatshop.com/callback-payout",
    "custom_data": {
      "transaction_id": "PAYOUT-ORD-2024-001"
    }
  }
}'

​
Response

​
response_code
string
Request result code. "00" means the payout was initiated successfully. Any other value indicates an error.
​
token
string
JWT token identifying the payout. Store it immediately — it is required to verify the status if your callback does not fire.
​
response_text
string
Textual message associated with the response code. Can be empty.
​
description
string
Additional description. Can be empty.
​
custom_data
string
Always "" for Merchant payout.
​
wiki
string
URL to the list of error codes specific to this endpoint. Consult when response_code !== "00".
Success
{
  "response_code": "00",
  "token": "{PAYOUT_TOKEN}",
  "response_text": "",
  "description": "",
  "custom_data": "",
  "wiki": "https://client.ligdicash.com/wiki/createStraightWithdrawal"
}
A response_code: "00" means the payout was initiated, not finalized. The final result reaches you via the callback — which can arrive with a significant delay depending on the operator. Store the token so you can verify the status if it is not received.

​
Differences with Customer payout

Merchant payoutCustomer payout
Endpoint/pay/v01/straight/payout/pay/v01/withdrawal/create
LigdiCash account requiredNoYes
InstantNoYes (wallet credit)
top_up_wallet parameterAbsentRequired