# WooCommerce

## Overview

Our WooCommerce plugin is an easy integration that allows users to accept payments online through their WooCommerce online site.

## Installing the Plugin

Our official WooCommerce plugin can be found here: <https://wordpress.org/plugins/woo-cardknox-gateway/>

After installing and activating the plugin, navigate to the plugin settings and enter your API Key and iFields Key. There are several additional optional settings available. You can hover over each setting to view a brief description of its functionality.<br>

If you plan to enable **Apple Pay** or **Google Pay**, please ensure that your checkout page uses the shortcode `[woocommerce_checkout]` rather than the block-based checkout.<br>

Before activating the Sola plugin, please deactivate any other payment methods or processors to avoid conflicts.

{% hint style="info" %}
Please note that after installation, the plugin may still appear in your plugin list under our former name, Cardknox.
{% endhint %}

## Customer Usage <a href="#customer-usage" id="customer-usage"></a>

### New transaction: <a href="#new-transaction" id="new-transaction"></a>

1. Go to the checkout page.
2. Select Credit Card (or the title that was specified for Sola in the settings page).

### New card: <a href="#new-card" id="new-card"></a>

1. Select "use a new payment method."
2. Enter the card data.
3. Select "save to account" if you would like to save the card for future use.

### Card on file: <a href="#card-on-file" id="card-on-file"></a>

1. Select the card you would like to use.
2. Select "place order."

### Add payment method (card on file): <a href="#add-payment-method-card-on-file" id="add-payment-method-card-on-file"></a>

1. Select my account > payment methods.
2. Click "add payment method."
3. Enter card data.
4. Click "add payment method."

Add payment method image:

![](/files/-Me-pXZS0s-9xvkkaaFd)

### Delete payment method: <a href="#delete-payment-method" id="delete-payment-method"></a>

1. Select my account > payment methods.
2. Click "delete" on the right of the payment method.

Delete payment method:

![](/files/-Me01n3YlX5-m15n9ReF)

### New subscription: <a href="#new-subscription" id="new-subscription"></a>

1. Select subscription item.
2. Pay the same as with a regular transaction.

### Change subscription: <a href="#change-subscription" id="change-subscription"></a>

1. Go to my account > select subscriptions.
2. Click "view" on the subscription.
3. Apply modifications.

Edit subscription image:

![](/files/-Me01sJ4JSE6mCJZi5h6)

## Merchant <a href="#merchant" id="merchant"></a>

### Refund a transaction: <a href="#refund-a-transaction" id="refund-a-transaction"></a>

This will refund the transaction. You can specify the amount to refund.\
Refund images:

![](/files/-Me01x8_HYnFdJSZDdil)

### Change order status from on hold to processing: <a href="#change-order-status-from-on-hold-to-processing" id="change-order-status-from-on-hold-to-processing"></a>

If the plugin is set to not capture the transaction, this will capture the transaction.

### Change order status from on hold to completed: <a href="#change-order-status-from-on-hold-to-completed" id="change-order-status-from-on-hold-to-completed"></a>

If the plugin is set to not capture the transaction, this will capture the transaction.

### Change order status from on hold to canceled: <a href="#change-order-status-from-on-hold-to-canceled" id="change-order-status-from-on-hold-to-canceled"></a>

If the order is not yet captured, this will void the auth only transaction.

### Change order status from on hold to refunded: <a href="#change-order-status-from-on-hold-to-refunded" id="change-order-status-from-on-hold-to-refunded"></a>

If the order is not yet captured, this will void the auth only transaction.&#x20;

Change order status image:

![](/files/-Me02_zfHZxjq85HiL8o)

### Recurring / Subscriptions: <a href="#recurring-subscriptions" id="recurring-subscriptions"></a>

**Process Renewal:**\
Charge the subscription instead of waiting.

**Add / Update Token Manually:**\
Click on the pencil near "payment details."

Update the token masked card number and card type.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.solapayments.com/plugins/woocommerce.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
