Guides
API Reference

Our reference library for integrating with our API

FAQ

Find answers to our most frequently asked questions

Classic Docs

Documentation for our Classic API

WooCommerce

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

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

Before you start

Create a test account

If you haven't already, create a test Checkout.com account.

Get your API keys

In order to set up WooCommerce, you'll need three API keys: a secret one, a public one, and a private shared one. The first two are generated automatically upon account creation. The last one is generated when you configure a webhook for your business.

You do not need your private shared key if using v4.2.0+ of our WooCommerce plugin.

  1. Log in to your test account on the Hub sandbox.
  2. In the left menu, go to Settings > Channels, and make a note of your secret and public API keys.
  3. Scroll down to the Webhooks section of the page and click New webhook.
  4. Enter the following endpoint URL, replacing example.com with the URL of your shop: example.com/?wc-api=wc_checkoutcom_webhookNote: correctly configuring your webhooks is important; if they're incorrectly formatted, the plugin will not work.
  5. Select  API - v2.0.
  6. Tick  Select all, then click  Create webhook.
  7. Click on the webhook you just created, and make a note of the private shared API key.


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. Read more about webhooks.

Check you have no previous version of the plugin

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


Install the plugin

There are two ways to install the plugin:

Using the WordPress Plugin Directory 

  1. Log in to WordPress as an administrator.
  2. In the left menu, click Plugins > Add New.
  3. In the search bar in the top right, type Checkout.com then press the Enter key.
  4. Click Install Now.
  5. Click Activate.

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

Using a .zip file 

  1. Download the plugin from Github.
  2. Unzip the file.
  3. Zip the woocommerce-gateway-checkout-com folder.
  4. Log in to WordPress as an administrator.
  5. In the left menu, click Plugins > Add New.
  6. Click Upload Plugin.
  7. Click Choose File, select the .zip then click Install Now. A success message is displayed when the plugin installation has finished.
  8. Click Activate Plugin.

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

Configure the plugin

  1. Log in to WordPress as an administrator.
  2. In the left menu, click Plugins.
  3. Find the Checkout.com plugin and click on Settings below it.

  4. Tick Enable Checkout.com card payments.
  5. Set the environment to Sandbox.
  6. Choose a payment option title. This will be displayed to customers on your checkout page.
  7. Enter your secret key, public key, and private shared key.
  8. Click Save changes.
  9. Click the Card Settings tab, then click Save changes. Do the same for the Order Settings. This will activate our default configuration.

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

Test your integration

  1. Go to your shop's public URL and add a product to your cart.
  2. Go to your cart then proceed to the checkout.
  3. Enter the required billing details. You can put anything here, though we recommend using a real email address so that you can receive the order confirmation.
  4. Select the Checkout.com payment method.
  5. Enter the following card details:
    • Number: 4242 4242 4242 4242
    • Expiry date: 12/25
    • CVV: 100
  6. Tick the terms and conditions box.
  7. Click Place order. You will 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.
  8. Log in to your Wordpress account as an administrator.
  9. Click 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.

Further testing

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

Go live 

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.

Extend your configuration 

You can extend your configuration to add more payment methods or use 3DS.