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.

This glossary lists the terms you’ll come across in the LigdiCash documentation. Each definition links to the pages where the concept is detailed.

​
A–C

Identification key for your API project. It is sent in the Apikey header of every request. It identifies the project, not the user. Do not confuse with the Auth Token.See Authentication.
Authentication token for the merchant account. Sent in the Authorization: Bearer {AUTH_TOKEN} header. Paired with the Apikey, it forms the identification pair required on every endpoint.See Authentication.
HTTP POST request sent automatically by LigdiCash to your server when a transaction changes status. LigdiCash sends two requests per event: one as application/x-www-form-urlencoded and one as application/json. Remember to deduplicate.See Callback introduction.
Payment invoice created on LigdiCash’s side when a payin is initiated. Identified by a unique token and carries the transaction details (amount, operator, store, custom_data). The term appears in the endpoints (/checkout-invoice/create, /checkout-invoice/confirm).
Free-form metadata array you attach to a transaction at creation. It comes back unchanged in the callback, letting you look up your own order identifier. LigdiCash adds its own fields (logfile, id_invoice). Can appear in three shapes in the callback: populated array, [] (empty), or "" (empty string).See Parse custom_data.

​
D–L

Field present in direct payin requests. In most cases it must stay empty (""). Not to be confused with transaction_id which you set inside custom_data.
See Checkout invoice.
Shape of an entry in the custom_data array. Each entry is an object { keyof_customdata: "key", valueof_customdata: "value" }. To recover your order identifier, filter on keyof_customdata === "transaction_id".See Parse custom_data.

​
M–O

Business or developer integrating the LigdiCash API to accept or send payments. Your merchant account is managed from the LigdiCash Dashboard.
Mobile payment service offered by telecom operators (Orange Money, Moov Africa, MTN, Wave, etc.). LigdiCash is an aggregator: it abstracts every operator behind a single API.
Numeric identifier returned by the API in responses and callbacks to designate the operator used (e.g. 11 for Orange Burkina). Useful for logging and reconciliation. Not sent in requests.See Supported operators.
Human-readable operator name returned by the API (e.g. "ORANGE BURKINA"). Always in uppercase in LigdiCash responses.See Supported operators.
Single-use code authorizing a direct payin transaction. Depending on the operator, it is generated by the customer via USSD menu, sent by SMS, or replaced by direct approval in the mobile money app.See Validation modes.

​
P–R

Collection operation: the customer pays the merchant. LigdiCash offers two modes — hosted (the customer is sent to a hosted payment page) and direct (the payment is initiated programmatically via OTP or approval).See Payment API overview.
Payin mode where the customer is redirected to a payment page hosted by LigdiCash. The integration is simple but comes with constraints: no iframe, empty customer, popup handling.See Hosted payin — Introduction.
Payin mode where the merchant owns the interface and submits the OTP via API. More UX control, but a more complex, operator-specific integration.See Direct payin — Introduction.
Disbursement operation: the merchant sends money to a customer or partner. Two flavors: to the recipient’s LigdiCash wallet (/withdrawal/create) or directly to their mobile money (/straight/payout).See Payout — Introduction.
Entity created in the LigdiCash Dashboard that groups an Apikey and an Auth Token. A merchant account can hold multiple API projects (one per application, per country, etc.).See Create an API project.
Return code present in every LigdiCash API response. "00" = success, "01" = failure. On failure, the wiki field carries a URL with the detailed description.See Response codes and statuses.

​
S–T

Current state of a transaction. Possible values: Completed, Pending, Cancelled. Retrieved via the confirm endpoint or the callback.See Transaction lifecycle.
Object representing your store in a LigdiCash request. Carries name, website_url, logo_url, and return_url. Appears in the body of invoice-creation requests.
Transaction identifier returned by LigdiCash when an invoice is created. Used to call the confirm endpoint to check the status. This token is different from the token in the callback — don’t confuse them.See Tokens and identifiers.
Value of the token field received in the callback payload. It is different from the creation token and must not be used to identify the transaction. Always use your transaction_id stored in your database, or re-verify with the creation token.See Callback security.
Parameter of the /withdrawal/create endpoint. Decides whether the funds stay in the customer’s LigdiCash wallet (1) or are automatically transferred to their linked mobile money (0).See Payout to LigdiCash wallet.
Order identifier that you generate on the merchant side and inject into custom_data at creation. This is the recommended way to correlate a LigdiCash transaction with your order system — reliable in every flow, including callback retries.See The transaction_id pattern.

​
U–Z

Short messaging protocol used by mobile money operators to trigger actions from the phone (e.g. #144*82# for Orange Burkina). In USSD-OTP direct payin mode, the customer dials the USSD code on their phone to obtain the OTP before you submit the transaction.
Electronic wallet internal to LigdiCash, separate from the mobile money operators’ wallets. The LigdiCash wallet can receive payouts via /withdrawal/create and is linked to a LigdiCash customer account.See Payout to LigdiCash wallet.
Field present in LigdiCash API error responses. Holds a URL to a page listing the sub-codes specific to the endpoint called. Fetch it programmatically to obtain a human-readable error description.See The wiki field.
Currency LigdiCash uses for transactions in West Africa (Burkina Faso, Mali, Niger, Benin, Togo, Côte d’Ivoire, Senegal, Guinea-Bissau). XOF has no sub-unit — amounts are always integers.See Currencies and amounts.