WooCommerce

Last updated: July 24, 2024

From downloading the plugin to requesting your first test payment, learn how to get started with the Checkout.com for WooCommerce plugin.

Information

This guide assumes that you have already set up WooCommerce on your WordPress instance.

To set up our WooCommerce plugin, you'll need 3 API keys: a secret key, a public key, and a signature key. You can create your secret and public keys in the Dashboard.

Select Create a new key.
When you're prompted for which type of key to create, select Public API key.
Give the API key a description. This will help you identify what it's used for.
Disable the Allow any processing channel setting.
Select one processing channel from the list.
Select Submit to create the key.

Make a note of your public API key as you'll need it for a later step. You can view your public API key at any time after creation.

Select the Developers icon in the top navigation bar and open the Keys tab.
Select Create a new key.
When prompted for a type of key, select Secret API key.
Give the API key a description that will help you identify what it's used for.
Make sure the scope of the key is set to Default.
Disable the Allow any processing channel setting.
Select the same processing channel from the list that you selected for the public API key.
Select Submit to create the key.

Copy your secret API key securely as you'll need it for a later step. Your private API key's value will only be visible here once.

Information

The signature key is generated when you create a webhook for your business.

Webhooks are notifications that we send when an event occurs on your account – for example, when a payment is captured. These are used by the WooCommerce plugin to update the status of an order.

You can configure a webhook in your WooCommerce settings.

Sign in to WordPress as an administrator.
In the left menu, select Plugins.
Look for any plugins that have Checkout.com in the name. If you find one, select Delete, or select Deactivate and then Delete.

There are two ways to install the plugin:

Using the WordPress Plugin Directory
Using a .zip file

Sign in to WordPress as an administrator.
In the left menu, select Plugins > Add New.
Search for Checkout.com Payment Gateway.
Select Install Now.
Select Activate.

After the plugin is activated, you are taken to the Installed Plugins screen. You can now configure WooCommerce.

Download the plugin from GitHub.
Sign in to WordPress as an administrator.
From the menu, select Plugins > Add New.
Select Upload Plugin.
Select Choose file, select the .zip file, then select Install Now. A success message is displayed when the plugin installation has finished.
Select Activate Plugin.

After the plugin is activated, you are taken to the Installed Plugins screen. You can now configure WooCommerce.

Sign in to WordPress as an administrator.
In the left menu, select Plugins.
Select Settings under Checkout.com Payment Gateway.
Select Enable Checkout.com card payments.
Set the environment to Sandbox.
Choose a payment option title. This will be displayed to customers on your checkout page.
Set Account type to NAS.
Enter your secret key and public key.
Select Save changes.
Select Card Settings, then select Save changes. Do the same for the Order Settings. This will activate our default configuration.

That's it! You're ready to start testing.

To check the current webhook status and register a webhook with the default configuration:

Sign in to WordPress as an administrator.
In the left menu, select Plugins.
Find the Checkout.com plugin and select Settings.
Select Webhook, then select Run Webhook check to check if a webhook is configured for the current site.
If a webhook is not configured, select Register Webhook. This will create a new webhook for all events listed in your Dashboard account.

Go to your shop's public URL and add a product to your cart.
Go to your cart then proceed to checkout.
Enter the required billing details. We recommend using a real email address so that you can receive the order confirmation.
Select the Checkout.com payment method.
Enter the following card details:
- Number – 4242 4242 4242 4242
- Expiry date – Any future date
- CVV – 100
Select the terms and conditions box.
Select Place order. You'll be redirected to the order confirmation page. If you entered a real email address in the billing details, you'll also receive an order confirmation email.
Sign in to your WordPress account as an administrator.
Select WooCommerce in the left menu. Your test order is displayed and has a status of Processing. This indicates that the payment has been successfully captured and that your webhooks are set up correctly.

You can now either go live as is or extend your configuration.

You'll find more test cards and a range of scenarios to trigger in our testing guide.

If you're happy with the outcome of your testing and want to start taking payments right away, please contact our Sales team in order to move to a live account.

There are a number of ways you can extend your WooCommerce integration so that it suits all your business needs.

In this section, you'll find how to:

Note

In order to start accepting an alternative payment method, we first need to enable it on your account. Please contact your account manager or our Sales team to get started.

We currently support the following payment methods on WooCommerce:

Sign in to WordPress as an administrator.
In the left menu, select Plugins.
Select Settings under Checkout.com Payment Gateway.
Select Alternative Payments.
Tick Enable Checkout.com.
Enter a Title. This is what the customer will see on the checkout page. For example, Pay with Klarna or Use one of these methods.
Select the empty box next to Alternative Payment Methods. A drop-down menu of all available methods appears.
Select the method you want to add. If you want to add more, repeat this step.
Select Save changes.

That's it! Your checkout page now includes the option to pay using your additional payment method(s).

Information

Apple Pay is only supported on self-hosted instances of WordPress.

If you're located in the UAE or Saudi Arabia, please contact your account manager or our Sales team to activate Apple Pay on your account.

To get started with Apple Pay payments, you must first generate your certificate signing request and upload it to the Apple Development Center.

Once this is done, you'll need to complete the certification process. Read our Apple Pay guide to configure your environment.

Sign in to WordPress as an administrator.
In the left menu, select Plugins.
Select Settings under Checkout.com Payment Gateway.
Select Apple Pay.
Select Enable Checkout.com.
Choose a title and description. These will be displayed to customers on your checkout page.
Enter your merchant identifier. You can find it in the Apple Development Center.
Enter the absolute path to your merchant certificate and merchant certificate key.
Select a button type and button theme. You can see what these will look like in the official Apple Pay demo.
Set the button language using a two-digit ISO 639-1 code (for example, use en for English).
Select Save changes.

That's it! Your checkout page now includes the option to pay using Apple Pay. In order to test it, you'll need to use one of our Apple Pay test cards.

If you're located in the UAE or Saudi Arabia, please contact your account manager or our Sales team to activate Google Pay on your account.

To get started with Google Pay payments, you must register with Google Pay and choose Checkout.com as your payment processor.

Sign in to WordPress as an administrator.
In the left menu, select Plugins.
Select Settings under Checkout.com Payment Gateway.
Select Google Pay.
Select Enable Checkout.com.
Choose a title and description. These will be displayed to customers on your checkout page.
Leave the merchant identifier set to 01234567890123456789. This is for testing purposes.
If you want to enable 3DS for Google Pay, set Use 3D Secure to Yes.
Select a button style.
Select Save changes.

That's it! Your checkout page now includes the option to pay using Google Pay.

Sign in to WordPress as an administrator.
In the left menu, select Plugins.
Select Settings under Checkout.com Payment Gateway.
Select Card Settings.
Set Use 3D Secure to Yes.
Select Save changes.

3D Secure payments are now enabled on your account.

Sign in to WordPress as an administrator.
In the left menu, select Plugins.
Select Settings under Checkout.com Payment Gateway.
Select Card Settings.
Set Payment Action to Authorize Only.
Select Save changes.

Any payments that come through will only be authorized. You then have 7 days to manually capture them, or they will automatically be voided.

In the Dashboard sandbox, select Payments > Processing > All Payments.
Select the test payment. The Payment details page opens.
Select Capture payment in the top right.
Select Capture payment. The Status column on the Payments page is updated to say CAPTURED. The totals on your Dashboard are also updated.
Sign in to WordPress as an administrator.
Select WooCommerce in the left menu.
Select your test order to display the order details. You should see something like this:

The order note confirms that your payment has been successfully captured.

With recurring payments, you can process shopper interactions for scheduled payments, such as subscription payments.

Note

To use this feature, you must be using WooCommerce Subscriptions to manage subscriptions within WooCommerce. See WooCommerce Subscriptions Store Manager Guide.

The Checkout.com WooCommerce plugin registers with payment events triggered by WooCommerce Subscriptions to support the following actions:

Cancellation of a subscription
Suspension of a subscription
Re-activation of a subscription
Change of amount for a subscription
Change of date for a subscription
Management of multiple subscriptions

These settings allow you to edit the order statuses in line with the status of the payment. They are automatically set to WooCommerce's default values, so be aware that editing them may cause problems with the order flow.

To find these settings:

Sign in to WordPress as an administrator.
Go to WooCommerce > Settings > Payments.
Find the Checkout.com plugin.
Select Manage and then Order Settings.

WooCommerce

Information

Before you start

Get your API keys

Create a public API key

Create a private API key

Information

Create a webhook

Check you have no previous version of the plugin

Install the plugin

Using the WordPress Plugin Directory

Using a .zip file

Configure the plugin

Register a webhook with the default configuration

Test your integration

Go live

Extend your configuration

Add more payment methods

Note

Enable alternative payments

Apple Pay

Information

Before you start

Enable Apple Pay

Google Pay

Before you start

Enable Google Pay

Enable 3D Secure payments

Capture payments manually

Enable manual captures

Capture a payment

Accept recurring payments via the WooCommerce Subscriptions extension

Note

Configure order statuses