# WooCommerce 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 you have already [set up WooCommerce on your WordPress instance](https://docs.woocommerce.com/document/installing-uninstalling-woocommerce/). --- ## Supported payment methods > **Note** > > To start accepting an alternative payment method, Checkout.com must first enable it on your account. Contact your account manager or our [Sales team](https://checkout.com/contact-sales) to get started. We currently support the following payment methods on WooCommerce: - Card payments - [Apple Pay](https://www.checkout.com/docs/payments/payment-methods/apple-pay.md) - [Google Pay](https://www.checkout.com/docs/payments/payment-methods/google-pay.md) - [AlipayCN](https://www.checkout.com/docs/payments/add-payment-methods/alipaycn.md) - [AlipayHK](https://www.checkout.com/docs/payments/add-payment-methods/alipayhk.md) - [Alma](https://www.checkout.com/docs/payments/add-payment-methods/alma.md) - [Bancontact](https://www.checkout.com/docs/payments/payment-methods/bancontact.md) - [Benefit](https://www.checkout.com/docs/payments/add-payment-methods/benefit-payment-gateway.md) - [Cartes Bancaires](https://www.checkout.com/docs/payments/payment-methods/cartes-bancaires.md) - [Dana](https://www.checkout.com/docs/payments/add-payment-methods/dana.md) - [EPS](https://www.checkout.com/docs/payments/add-payment-methods/electronic-payment-standard-eps.md) - [GCash](https://www.checkout.com/docs/payments/add-payment-methods/gcash.md) - [iDEAL](https://www.checkout.com/docs/payments/payment-methods/ideal.md) - [KakaoPay](https://www.checkout.com/docs/payments/add-payment-methods/kakaopay.md) - [Klarna Debit Risk](https://www.checkout.com/docs/payments/add-payment-methods/klarna-debit-risk.md) - [Klarna Payments](https://www.checkout.com/docs/payments/add-payment-methods/klarna-payments.md) - [KNET](https://www.checkout.com/docs/payments/payment-methods/knet.md) - [MB WAY](https://www.checkout.com/docs/payments/add-payment-methods/mb-way.md) - [Multibanco](https://www.checkout.com/docs/payments/payment-methods/multibanco.md) - [PayPal](https://www.checkout.com/docs/payments/payment-methods/paypal.md) - [Przelewy24](https://www.checkout.com/docs/payments/add-payment-methods/przelewy24.md) - [QPay](https://www.checkout.com/docs/payments/add-payment-methods/qpay.md) - [SEPA Direct Debit](https://www.checkout.com/docs/payments/add-payment-methods/sepa-direct-debit.md) - [Sofort](https://www.checkout.com/docs/payments/payment-methods/sofort.md) - [stc pay](https://www.checkout.com/docs/payments/add-payment-methods/stc-pay.md) - [Tabby](https://www.checkout.com/docs/payments/add-payment-methods/tabby.md) - [Tamara](https://www.checkout.com/docs/payments/add-payment-methods/tamara.md) - [Touch 'n Go](https://www.checkout.com/docs/payments/add-payment-methods/touch-'n-go.md) - [TrueMoney](https://www.checkout.com/docs/payments/add-payment-methods/truemoney.md) --- ## Before you start You must create a public and private key to configure the integration. Additionally, you need a signature key to configure webhooks. ### Create a public API key 1. Sign in to the sandbox environment in the [Dashboard](https://identity-sandbox.checkout.com/). 2. Select _Developers_ in the left navigation bar, and then select the _Keys_ tab. 3. Select _Create a new key_. 4. When you're prompted for which type of key to create, select _Public API key_. 5. Give the API key a description to make it easier to identify in the future. 6. Disable the _Allow any processing channel_ setting. 7. Select the processing channel you want to use for WooCommerce from the list. 8. 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. ### Create a private API key 1. Sign in to the sandbox environment in the [Dashboard](https://identity-sandbox.checkout.com/). 2. Select _Developers_ in the left navigation bar, and then select the _Keys_ tab. 3. Select _Create a new key_. 4. When you're prompted for which type of key to create, select _Secret API key_. 5. Give the API key a description to make it easier to identify in the future. 6. Under _Scopes_, select _Default_. 7. Disable the _Allow any processing channel_ setting. 8. Select the processing channel you want to use for WooCommerce from the list. 9. Select _Create key_. 10. Copy your private API key securely. You'll need it to configure the plugin. > **Note** > > For security, you cannot view the secret API key again after you've left the _Create a new key page. Ensure you copy its value securely before you exit or close the window. ### Create a webhook Webhooks are notifications that we send when an event occurs on your account. For example, when a payment is captured. The WooCommerce plugin uses them to update order statuses. You can configure a webhook in your [WooCommerce settings](https://woo.com/document/webhooks/#creating-webhooks). ### 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 Checkout.com plugins. If you find one, select _Delete_, or select _Deactivate_ and then _Delete_. --- ## Install the plugin You can install the plugin in the following ways: ### Use the WordPress plugin directory 1. Sign in to WordPress as an administrator. 2. In your WordPress dashboard, go to _Plugins_ > _Add New_. 3. Search for _Checkout.com Payment Gateway_. 4. Select _Install Now_. 5. After the installation completes, you can see _Checkout.com Payment Gateway_ in your list of installed plugins. ### Download the plugin and install it manually 1. Go to the [WooCommerce plugin repository](https://github.com/checkout/checkout-woocommerce-plugin/releases). 2. Download the latest release of the plugin. 3. Sign in to WordPress as an administrator. 4. In your WordPress dashboard, go to _Plugins_ > _Add New_. 5. Select _Upload Plugin_ > _Choose file_. 6. Upload your downloaded ZIP file. 7. Select _Install Now_. 8. After the installation completes, you can see _Checkout.com Payment Gateway_ in your list of installed plugins. --- ## Configure the plugin 1. In your WordPress dashboard, go to _Plugins_ > _Checkout.com Payment Gateway_ > _Settings_. 2. Select _Enable Checkout.com card payments_ > _Quick Setup_. 3. In the _Quick Setup_ screen, provide the following fields: - _Checkout Mode_ – Set to _Flow_. - _Environment_ – Set to _Sandbox_. - _Secret Key_ and _Public Key_ – Set to your respective API keys. - _Payment Method Title_ – Set to the name you want customers to see at checkout. For example, _Credit/Debit Card_. 3. Under _Webhook Status_, select _Refresh Status_ to verify the webhook configuration. - If the verification fails, select _Register Webhook_ in _Register New Webhook_. 4. Optionally, you can configure your preferred payment methods using the _Enabled Payment Methods_ box.
If you want to configure payment methods later, see [Add more payment methods](#Add_more_payment_methods). 5. Select _Save changes_. --- ## 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](#Go_live) as is or [extend your configuration](#Extend_your_configuration). For test cards and a range of possible scenarios, see [Testing](https://www.checkout.com/docs/developer-resources/testing.md). --- ## Enable alternative payments 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 _Quick Setup_. 5. In the _Enabled Payment Methods_ box, select the payment methods you want to enable. 6. Select _Save changes_. ### Apple Pay You can integrate with Apple Pay in the following ways: 1. To enable regular checkouts with Apple Pay, complete the [Apple Pay for web](https://www.checkout.com/docs/payments/add-payment-methods/apple-pay/web.md) requirements and enable it in the _Quick Setup_ box. 2. To configure express checkout with Apple Pay, follow the [Apple Pay for Unified Payments API](https://www.checkout.com/docs/payments/add-payment-methods/apple-pay/unified-payments-api.md) setup guide, and configure Apple Pay in the _Express Checkout_ settings. To test your integration, follow the [Test Apple Pay](https://www.checkout.com/docs/payments/add-payment-methods/apple-pay/web.md#Test_the_integration) instructions. ### Google Pay Enable Google Pay in _Quick Setup_ to make it available on the checkout page using Flow. If you also need _Fast Checkout_, configure Google Pay in the _Express Checkout_ settings. ### PayPal Enable PayPal in _Quick Setup_ to make it available on the checkout page using Flow. If you also need _Fast Checkout_, configure PayPal in the _Express Checkout_ settings. ## Enable 3D Secure payments 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 _Card Settings_. 5. Set _Use 3D Secure_ to _Yes_. 6. Select _Save changes_. 3D Secure payments are now enabled on your account. ## Capture payments manually 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 _Card Settings_. 5. Set _Payment Action_ to _Authorize Only_. 6. Select _Save changes_. Any payments received are authorized only. You must manually capture them within seven days, or they are automatically voided. ## Capture a payment 1. In the Dashboard sandbox, select _Payments_ > _Processing_ > _All Payments_. 2. Select the test payment. The _Payment details_ page opens. 3. Select _Capture payment_ in the top right. 4. Select _Capture payment_. The _Status_ column on the _Payments_ page is updated to say `CAPTURED`. The totals on your Dashboard are also updated. 5. Sign in to WordPress as an administrator. 6. Select _WooCommerce_ in the left menu. 7. Select your test order to display the order details. For example: ![Edit order screen with test order details](https://www.checkout.com/docs/large-media-assets/woocommerce_order_details.png) The order note confirms that your payment has been successfully captured. ## Accept recurring payments via the WooCommerce Subscriptions extension 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](https://docs.woocommerce.com/document/subscriptions/store-manager-guide). The Checkout.com WooCommerce plugin registers with payment events triggered by [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/?quid=5e8af87e904d140455ce35c27943f7ce) 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 ## Configure order statuses 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: 1. Sign in to WordPress as an administrator. 2. Go to _WooCommerce > Settings > Payments_. 3. Find the Checkout.com plugin. 4. Select _Manage_ and then _Order Settings_. ![Order management settings screen](https://www.checkout.com/docs/Integrate/WooCommerce/woocommerce_order_settings.png) --- ## Go live When your testing is complete and you're ready to start accepting payments, contact our [Sales team](https://checkout.com/contact-sales) to move to a live account.