> For the complete documentation index, see [llms.txt](https://developer.convergegate.com/v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.convergegate.com/v1/woocommerce-gateway/setup-and-configuration.md).

# Setup and Configuration

The **Convergegate WooCommerce Gateway** plugin enables merchants to accept payments and manage recurring billing directly through WooCommerce. This plugin integrates seamlessly with the Convergegate API, supporting credit/debit card payments and rebill functionality.

### 🔧 Installation

1. Download and install the **Convergegate WooCommerce Gateway** plugin.
2. In your WordPress dashboard, go to **Plugins → Add New**.
3. Upload the plugin `.zip` file and click **Install Now**.
4. Activate the plugin.

{% file src="/files/JAF05wTrpdhMkOoa7R9f" %}

### ⚙️ Configuration

Once installed, configure the gateway by navigating to:

`WooCommerce → Settings → Payments → Convergegate Payment`

You will see the following configuration screen:

<figure><img src="https://215511601-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EdOyedBFKxAkeYE1SF1%2Fuploads%2FL0O54seaqWx5ixCxidss%2FConvergegate%20manage.png?alt=media&amp;token=53894cf3-1cb2-4e3d-8c74-ad43c73ce37f" alt=""><figcaption></figcaption></figure>

#### General Settings

* **Enable/Disable**\
  Check this box to enable Convergegate as a payment method in your store.
* **Title**\
  The payment method name displayed to customers during checkout.\
  *Example:* `Woocommerce Payment Gateway for Convergegate`
* **Description**\
  A short description shown to customers at checkout.\
  *Example:* `Pay easily through Convergegate using your preferred method.`

***

#### API Settings

* **Base URL**\
  Enter the Convergegate API base URL. \
  Use the sandbox environment for testing:\
  `https://engine-sandbox.convergegate.com`\
  For production, use:\
  `https://engine.convergegate.com`
* **API Key**\
  Your unique API key provided by Convergegate.\
  *(Keep this secure and do not share it.)*
* **Notification URL**\
  This is the webhook endpoint used by Convergegate to send payment updates.\
  Example:\
  `https://yourdomain.com/wc-api/convergegate_webhook`

#### Payment Options

* **Allowed Payment Methods**\
  Select which payment methods to allow (e.g., Credit/Debit Card).
* **Start Recurring**\
  Enable this option to allow recurring/rebill payments.
* **Pre-Authorization** *(optional)*\
  Allows 2-phase charges (authorize first, capture later).
* **Send Card Data Directly** *(PCI DSS only)*\
  If your system is PCI DSS compliant, you may enable direct card data sending. Otherwise, leave unchecked.
* **Additional Parameters (JSON)**\
  Optional advanced configuration in JSON format. Example:

### 🔄 Recurring Payments (Rebill)

When **Recurring Payment Chain** is enabled:

* Customers can subscribe to products or services.
* The gateway automatically handles rebills according to WooCommerce Subscriptions logic.
* Webhooks update payment status (success, failed, canceled).

***

### ✅ Testing the Gateway

1. Enable **Sandbox Mode** using the sandbox base URL.
2. Place a test order in WooCommerce checkout.
3. Confirm webhook notifications update the order status.
4. Once verified, switch to the production base URL and live API key.

***

### 📌 Troubleshooting

* **Payments not updating?**\
  Ensure your **Notification URL** is reachable and properly configured.
* **Invalid API Key?**\
  Verify the key matches the one provided in your Convergegate dashboard.
* **Recurring payments failing?**\
  Confirm that rebill is enabled both in the plugin and in your Convergegate account.

***

### 📷 Screenshots

**Plugin Configuration**

<figure><img src="https://215511601-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EdOyedBFKxAkeYE1SF1%2Fuploads%2FZBRyLADEXWxMrFXQXAQN%2FConvergegate%20configuration.png?alt=media&amp;token=551b677e-0d70-4fac-87f0-9c62bba28f66" alt=""><figcaption></figcaption></figure>

**Checkout page with Convergegate option**

<div align="left"><figure><img src="https://215511601-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EdOyedBFKxAkeYE1SF1%2Fuploads%2FKi73Usw7WEkg4MS5J60p%2FConvergegate%20checkout.png?alt=media&amp;token=a3096b36-56c1-4eef-be34-c0ae12b8374c" alt=""><figcaption></figcaption></figure></div>

**WooCommerce Convergegate payment**

<figure><img src="https://215511601-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EdOyedBFKxAkeYE1SF1%2Fuploads%2FpOredpL3apMPDKQUV3zp%2FConvergegate%20order.png?alt=media&amp;token=0d787e24-7458-48a9-b857-8b9d8798a9d1" alt=""><figcaption></figcaption></figure>