Magento 2 installation

With our Magento 2 installation, you can quickly start accepting payments on the Checkout.com payment gateway.

Before you start

  • Make sure you have your API keys ready. You can find these in the Hub.
  • Find out your PCI compliance status. If you're unsure, you are probably not fully PCI compliant.

Step 1: Install the extension

  1. Go to your Magento 2 root directory and run the following command:
    composer require checkoutcom/magento2
  2. Recompile your Magento 2 installation and clear the cache:
bin/magento setup:upgrade
rm -rf var/cache var/generation/ var/di
bin/magento setup:di:compile && php bin/magento cache:clean

For additional information on the installation process, please refer to Magento 2’s full developer guide.

Step 2: Configure the extension

  1. Once the extension has been successfully installed, go to your Magento 2 dashboard.
  2. Click Stores in the navigation menu (on the left) and select Configuration from the drop-down.
  3. In the Configuration menu, find Sales and from the subcategories click Payment Methods. You should now see the Payment Methods configuration page.
  4. Open the configuration form.
  5. Click OTHER PAYMENT METHODS and select Checkout.com.
  6. Under Basic Settings > Enable this Solution, select Yes from the drop-down list.
  7. In the Account keys section, enter your Public Key and Secret Key.
  8. Click Save Config to save.

That's it! You're all set to start taking payments.

The Private Shared Key is a header that the Hub sends to your page with every transaction. It is not required, but where possible should be specified. The Private Shared Key is used to check the authenticity of notification webhooks coming from Checkout.com.

Can we help?

Thanks for using Checkout.com. If you need any help or support, then message our support team at support@checkout.com.

Magento 2 installation


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.