Verify the status of a payout

After initiating a payout, LigdiCash notifies you of the result via your callback_url. If the callback does not fire — network unavailable, server restarted, delay too long — you can query this endpoint directly with the token returned at creation.

The callback remains the primary method. This endpoint is a safety net, not a substitute for the callback. Do not use it in a tight loop: prefer spaced polling (every 30 to 60 seconds) with a maximum number of attempts.

Endpoint

GET https://app.ligdicash.com/pay/v01/withdrawal/confirm/

Parameters

Parameter	Type	Description
`withdrawalToken`	query string	The `token` returned by the payout creation endpoint.

Required headers

Header	Value
`Apikey`	Your API key
`Authorization`	`Bearer {AUTH_TOKEN}`

Request example

curl --location 'https://app.ligdicash.com/pay/v01/withdrawal/confirm/?withdrawalToken={PAYOUT_TOKEN}' \
--header 'Apikey: {API_KEY}' \
--header 'Authorization: Bearer {AUTH_TOKEN}'

const params = new URLSearchParams({ withdrawalToken: payoutToken });

const response = await fetch(
  `https://app.ligdicash.com/pay/v01/withdrawal/confirm/?${params}`,
  {
    headers: {
      'Apikey': process.env.LIGDICASH_API_KEY,
      'Authorization': `Bearer ${process.env.LIGDICASH_AUTH_TOKEN}`,
    },
  }
);

const data = await response.json();

$params = http_build_query(['withdrawalToken' => $payoutToken]);

$response = $client->get(
    "https://app.ligdicash.com/pay/v01/withdrawal/confirm/?{$params}",
    [
        'headers' => [
            'Apikey'        => $_ENV['LIGDICASH_API_KEY'],
            'Authorization' => 'Bearer ' . $_ENV['LIGDICASH_AUTH_TOKEN'],
        ],
    ]
);

Response

response_code

string

Request result code. "00" means the call succeeded. Any other value indicates an error.

token

string

JWT token of the payout — identical to the one used as a parameter.

response_text

string

Label of the result code from the LigdiCash wiki. Can be empty.

description

string

Additional description. Can be empty.

custom_data

array

Always [] on this endpoint.

wiki

string

URL to the list of error codes specific to this endpoint.

status

string

Payout transaction status: "completed", "pending", or "notcompleted". See Response codes and statuses.

operator_id

string

Identifier of the operator that processed the payout (e.g. "11" for Orange Burkina).

operator_name

string

Operator name (e.g. "ORANGE BURKINA").

Success

{
  "response_code": "00",
  "token": "{PAYOUT_TOKEN}",
  "response_text": "",
  "description": "",
  "custom_data": [],
  "wiki": "https://client.ligdicash.com/wiki/createStraightWithdrawal",
  "status": "completed",
  "operator_id": "11",
  "operator_name": "ORANGE BURKINA"
}

Interpreting the status

Base your business logic on the status field.

`status`	Meaning	Recommended action
`completed`	Payout finalized successfully	Update your database, notify the beneficiary
`pending`	Processing in progress	Wait for the callback; if absent, repoll in 30 to 60 seconds
`notcompleted`	Payout failed	Consult `wiki` for details, notify the requester

Customer payout — create a payout to LigdiCash wallet
Merchant payout — create a payout to mobile money
Response codes and statuses

​Endpoint

​Parameters

​Required headers

​Request example

​Response

​Interpreting the status

​Related pages

Endpoint

Parameters

Required headers

Request example

Response

Interpreting the status

Related pages