> ## 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.

# WordPress / WooCommerce plugin

> Install and configure the LigdiCash plugin to accept mobile money payments on your WooCommerce store — no code required.

The LigdiCash plugin for WooCommerce is installed manually from a ZIP file. Once enabled, it adds a payment gateway to your WooCommerce admin — no code to write.

<a href="/downloads/plugin-wordpress.zip" download>**Download the plugin (ZIP)**</a>

**What the plugin does:**

* Adds a LigdiCash payment method to the WooCommerce checkout page
* Redirects the customer to the LigdiCash payment page during checkout
* Receives the confirmation callback and automatically updates the order status
* Adds CFA franc (XOF) currency support to WooCommerce

## Requirements

* WordPress ≥ 4.x
* WooCommerce installed and enabled
* A LigdiCash API project with an `api_key` and `auth_token` — see [Create an API project](/en/concepts/api-project)
* Store currency set to **XOF** or **FCFA**

***

## Installation

The plugin is installed by downloading the folder as a ZIP file and importing it into WordPress.

<Steps>
  <Step title="Download the plugin">
    Download the ZIP file via the link at the top of this page or directly: [plugin-wordpress.zip](/downloads/plugin-wordpress.zip).
  </Step>

  <Step title="Import into WordPress">
    From your WordPress dashboard, go to **Plugins → Add New → Upload Plugin**, select the `.zip` file, then click **Install Now**.
  </Step>

  <Step title="Activate the plugin">
    Once installation is complete, click **Activate Plugin**.
  </Step>

  <Step title="Open the settings">
    Go to **WooCommerce → Settings → Payments**, then click **LigdiCash** to open the configuration page.
  </Step>
</Steps>

***

## Configuration

From **WooCommerce → Settings → Payments → LigdiCash**:

| Field              | Description                                                                    |
| ------------------ | ------------------------------------------------------------------------------ |
| **Enable/Disable** | Tick to show LigdiCash as a payment method at checkout                         |
| **Title**          | Text shown to the customer on the checkout page (e.g. `Mobile payment, VISA…`) |
| **Description**    | Description shown below the title on the checkout page                         |
| **Main key**       | Your `api_key` generated in the LigdiCash dashboard                            |
| **Token**          | Your `auth_token` generated in the LigdiCash dashboard                         |

<Warning>
  Never share your **Main key** or **Token** — they grant access to your merchant account. Do not commit them to your Git repository.
</Warning>

***

## Payment flow

Once the plugin is configured, here's what happens on each order:

<Steps>
  <Step title="The customer places an order">
    On the WooCommerce checkout page, the customer picks **LigdiCash** as the payment method and confirms.
  </Step>

  <Step title="Redirect to LigdiCash">
    The plugin creates an invoice via `POST /pay/v01/redirect/checkout-invoice/create` and redirects the customer to the LigdiCash payment page.
  </Step>

  <Step title="Customer pays">
    The customer picks their mobile money operator and completes the payment on the LigdiCash page.
  </Step>

  <Step title="Return to the store">
    After payment, the customer is redirected to the WooCommerce confirmation page. The plugin checks the status via `GET /pay/v01/redirect/checkout-invoice/confirm/` and updates the order.
  </Step>

  <Step title="Callback confirmation">
    LigdiCash also sends a POST callback to `{your-site}/wc-api/wc_ligdicash/`. The plugin handles this callback and marks the order as **Completed** if the status is `completed`.
  </Step>
</Steps>

<Note>
  The callback URL is generated automatically by the plugin: `{your-site}/wc-api/wc_ligdicash/`. You don't need to configure it manually — it's registered in WooCommerce when the plugin is activated.
</Note>

***

## Currency

The plugin automatically adds the **FCFA (XOF)** currency to WooCommerce. Set your store currency to **XOF** or **FCFA** under **WooCommerce → Settings → General**.

***

## Useful links

* [Create an API project](/en/concepts/api-project)
* [Authentication — api\_key and auth\_token](/en/concepts/authentication)
* [Hosted payin — Introduction](/en/payment-api/hosted-payin/introduction)
* [Callback — Introduction](/en/payment-api/callback/introduction)