Skip to content

WooCommerce

Last updated: June 27, 2022

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

Get your API keys

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. The signature key is generated when you create a webhook for your business.

Create a webhook

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.

You can configure a webhook with the default settings directly in the WordPress admin dashboard. If you'd like to customize the webhook settings, follow these steps:

  1. Sign in to the Dashboard.
  2. Go to Settings > Notifications.
  3. Select New notification.
  4. Enter a name for the notification.
  5. Select the events you would like to receive notifications for.
  6. Enter the following endpoint URL, replacing example.com with the URL of your shop: example.com/?wc-api=wc_checkoutcom_webhook.
  7. Enter the signature key prefixed with Bearer (for example, Bearer sk_sbox_xxxxxx).
  8. Select the entities you would like to receive notifications for.
  9. Select Create notification.

Check you have no previous version of the plugin

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

Install the plugin

There are two ways to install the plugin:

Using the WordPress Plugin Directory

  1. Sign in to WordPress as an administrator.
  2. In the left menu, select Plugins > Add New.
  3. Search for Checkout.com Payment Gateway.
  4. Select Install Now.
  5. Select 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. Sign in to WordPress as an administrator.
  5. In the left menu, select Plugins > Add New.
  6. Select Upload Plugin.
  7. Select Choose file, select the .zip then select Install Now. A success message is displayed when the plugin installation has finished.
  8. Select Activate Plugin.

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


Configure the plugin

  1. Sign in to WordPress as an administrator.
  2. In the left menu, select Plugins.
  3. Select Settings under Checkout.com Payment Gateway.
  4. Select 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. Set Account type to NAS.
  8. Enter your secret key and public key.
  9. Select Save changes.
  10. 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.

Register a webhook with the default configuration

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

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

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 checkout.
  3. Enter the required billing details. 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: any future date
    • CVV: 100
  6. Select the terms and conditions box.
  7. 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.
  8. Sign in to your WordPress account as an administrator.
  9. 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.

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.