WooCommerce
Last updated: April 29, 2022
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.
If you haven't already, create a test Checkout.com account.
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.
Information
You do not need your private shared key if using v4.2.0+ of our WooCommerce plugin.
- Log in to your test account on the Hub sandbox.
- In the left menu, go to Settings > Channels, and make a note of your secret and public API keys.
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:
- Sign in to your Hub sandbox account.
- Select Settings > Channels.
- Scroll down to the Webhooks section of the page and select New webhook.
- Enter the following endpoint URL, replacing
example.comwith the URL of your shop:example.com/?wc-api=wc_checkoutcom_webhook. Note: Correctly configuring your webhooks is important; if they're incorrectly formatted, the plugin will not work. - Select API - v2.0.
- Select all events, then select Create webhook.
- Select the webhook you just created, and make a note of the private shared API key.
- Log 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:
- Log in to WordPress as an administrator.
- In the left menu, select Plugins > Add New.
- In the search bar in the top right, type
Checkout.comthen press the Enter key. - 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.
- Unzip the file.
- Zip the
woocommerce-gateway-checkout-comfolder. - Log in to WordPress as an administrator.
- In the left menu, select Plugins > Add New.
- Select Upload Plugin.
- Select Choose File, select the
.zipthen 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.
- Log in to WordPress as an administrator.
- In the left menu, select Plugins.
- Find the Checkout.com plugin and select Settings below it.
- 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 ABC.
- Enter your secret key, public key, and private shared 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:
- Log in to WordPress as an administrator.
- In the left menu, select Plugins.
- Find the Checkout.com plugin and select Settings below it.
- 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 Hub account.
- Go to your shop's public URL and add a product to your cart.
- Go to your cart then proceed to the checkout.
- 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.
- Select the Checkout.com payment method.
- Enter the following card details:
- Number:
4242 4242 4242 4242 - Expiry date:
12/25 - CVV:
100
- Number:
- Select the terms and conditions box.
- Select 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.
- Log 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.
Tip
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.
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.
You can extend your configuration to add more payment methods or use 3DS.