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
Required headers
| Header | Value |
|---|---|
Apikey | Your API key |
Authorization | Bearer {AUTH_TOKEN} |
Accept | application/json |
Content-Type | application/json |
Request body
All fields are nested inside acommande object.
Request example
Response
Request result code.
"00" means the payout was initiated successfully. Any other value indicates an error.JWT token identifying the payout. Store it immediately — it is required to verify the status if your callback does not fire.
Textual message associated with the response code. Can be empty.
Additional description. Can be empty.
Always
"" for Merchant payout.URL to the list of error codes specific to this endpoint. Consult when
response_code !== "00".Success
Differences with Customer payout
| Merchant payout | Customer payout | |
|---|---|---|
| Endpoint | /pay/v01/straight/payout | /pay/v01/withdrawal/create |
| LigdiCash account required | No | Yes |
| Instant | No | Yes (wallet credit) |
top_up_wallet parameter | Absent | Required |
Related pages
- Customer payout — send to LigdiCash wallet with auto-transfer option
- Verify the status of a payout
- The LigdiCash merchant account — understanding sub-accounts and per-operator balances
