Magento 2 installation

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

Step 1: Install the extension

  1. Navigate to your Magento 2 root directory and run the following command:
composer require checkoutcom/magento2:*
  1. 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: Configuring the extension

  1. Find the configuration form.
    Once the extension has been successfully installed, navigate to your Magento 2 dashboard; from here, we can locate the payment configuration form.
    a. Click Stores in the navigation menu (on the left-hand side of the screen) and select Configuration from the drop-down menu.
    b. In the Configuration menu, find Sales and from the subcategories click Payment Methods.

You should now see the Payment Methods configuration page.

  1. Open the configuration form.
    a. Click OTHER PAYMENT METHODS and select Checkout.com.
Magento 2 'OTHER PAYMENT METHODS' page

Magento 2 'OTHER PAYMENT METHODS' page

  1. Enable the solution.
    Open up the Basic Settings section and for Enable this Solution select Yes from the drop-down list.
  1. Enter your Account keys.
    In the Account keys section:
    • Enter your Public Key and Secret Key.

Can't find your keys?

Your Checkout.com account manager can provide these to you.

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.

  1. Save your settings
    Once the account keys have been added, ensure that you save your changes using the Save Config button.

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

Can we help?

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