From downloading the plugin to requesting your first test payment, learn how to get started with the Checkout.com for Magento 2 plugin.
This guide assumes that you have Magento (the plugin is compatible with version 2.2.8 and above) installed. You will also need to be on a dedicated server, or have the enterprise version of Magento, to use this plugin.
- Manual capture, void, and refund from the Dashboard and the Magento Admin panel
- Saved cards (stored credit cards)
- Invoice generation
- 3D Secure 2.0
- MOTO payments
- Custom order statuses
- Webhook notifications for up-to-date payment statuses
- Dynamic descriptors
- Multi-store support
- Apple Pay fast checkout from the mini cart
Before you start
Get your API keys
To set up our Magento 2 plugin, you'll need 3 API keys: a secret key, a public key, and an authorization header key. You can create your secret and public keys in the Dashboard. The authorization header 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 Magento plugin to update the status of an order. Read more about webhooks.
You can configure a webhook with the default settings directly in the Magento Admin Panel account settings. If you'd like to customize the webhook settings, follow these steps:
- Sign in to the Dashboard.
- Go to Settings > Notifications.
- Select New notification.
- Enter a name for the notification.
- Select the events you would like to receive notifications for.
- Enter the following endpoint URL, replacing
example.comwith the URL of your shop:
- Select the entities you would like to receive notifications for.
- Generate the authorization header key.
- Select Create notification.
Install the plugin
There are 2 ways to install the plugin:
We recommend this method, as it should install the latest version of the plugin.
- Go to the root directory of your Magento 2 server.
- Use one of the following commands:
composer require checkoutcom/magento2
composer require checkoutcom/magento2:<VERSION_NUMBER>
- You should get a success message confirming the installation of Checkout.com PHP SDK and our plugin.
- The plugin is now installed, but you need to recompile your Magento 2 installation and clear the cache before configuring it. Type the following commands in order:
php bin/magento setup:upgrade
rm -rf var/cache var/generation/ var/di
php bin/magento setup:di:compile
php bin magento cache:clean
Using Magento Marketplace
- Install our plugin for free from Magento Marketplace.
- Follow the installation instructions on the checkout page.
- Once you've installed the extension, sign in to your Magento Admin Panel and go to Stores > Configuration > Sales > Payment Methods. If successful, you should now see Checkout.com on the list.
You're now ready to configure the Magento 2 plugin.
Configure the plugin
- Sign in to your Magento Admin Panel and go to Stores > Configuration > Sales > Payment Methods.
- Find the Checkout.com plugin and select Configure.
- In the configuration panel, go to Configuration > Global Settings.
- Make sure Environment is set to Test so you can start testing card payments.
- Select the Payment Action:
- The Authorize and Capture option means that the charge is authorized and captured (that is, the money due from the customer's account is moved into your account) at the same time.
- The Authorize option will only authorize the charge. You'll have to capture the payment manually.
If you're unsure, Authorize and Capture is likely the right choice.
- In the configuration panel, go to Configuration > Account Settings.
- Set Service to NAS.
- Enter your Secret Key and Public Key. If you're testing, make sure you use the sandbox API keys.
- In the Authorization Header Key field, copy and paste the authorization header key from the Notifications section of your Dashboard account.
- Select Set Webhooks to automatically register your webhooks in the Checkout.com Dashboard.
- Select Save Config.
That's it! You're ready to start testing card payments.
Test your integration
Go to your storefront and add a product to your cart.
Go to your cart and proceed to checkout.
Enter the required billing details. We recommend using a real email address so you can receive the order confirmation.
Select Pay by Card with Checkout.com.
Enter the following card details:
4242 4242 4242 4242
- Expiry date: any future date
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 Magento Admin Panel.
Go to Sales > Orders. Your test order will be displayed there with a
Pending Paymentif you choose the Authorize payment action). This indicates that the payment has been successfully captured. The transaction will also appear in the Payments section of your sandbox Dashboard account.
If this test does not work, first check you have configured your webhooks correctly. If you have configured them properly, check your server. If it's password-protected or it restricts unfamiliar IP addresses, it may be blocking webhook notifications. Contact our Support team at email@example.com if you need help.
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.
Before you go live, remember to:
- Switch the Environment to Production in the plugin's settings.
- Replace the sandbox API keys in the plugin's settings with the production API keys.
- Configure the webhook URLs in your live Dashboard account.