Skip to content

Shopify

Last updated: 13th January 2022

The Checkout.com payment gateway is fully integrated with Shopify. If you're already using Shopify, you can start accepting payments through our gateway by configuring a few simple settings.

On this page, we will walk through:


Before you begin

If you haven't already, create a test Checkout.com account to test this integration.


Choose either the on-site or off-site integration option

We provide two Shopify integration methods:

  • On site, where your customer enters their payment details on your website.
  • Off site, where they will be redirected to a Checkout.com page to do so.

Review the following table for a breakdown of features.

FeaturesOn siteOff site

Payments

Completed on your checkout page.

Completed on a Checkout.com redirect page.

3DS

Additional set up and cost with Cardinal Commerce.

We handle 3DS with no extra cost.

Local payments

Not supported.

Partially supported.

Refunds

Handled directly in Shopify Admin Portal.

Handled in the Hub.

If you do not need 3DS authentication, we recommend using the on-site integration. Please contact your Solutions Engineer for any questions.


Set up your integration

Follow the steps for your chosen method to integrate.

On-site integration

You will need to access both the Shopify Admin Portal and our Hub during these steps.

  1. From the Hub, navigate to Settings > Channels. Here you will find your secret key, which we will need when we run through the Shopify Admin Portal.
  2. From the Shopify Admin Portal, navigate to Settings > Payments.
  3. Select See all other providers.
third party shopify
  1. Use the search bar to search for Checkout.com. Select our name when it appears.
  2. Navigate to the Account information section and paste the secret key from the Hub into the Secret Key field.
shopify secret key
  1. Select which payment methods you'd like to accept.
  2. If your 3D Secure is enabled with Cardinal Commerce, select Enable 3D Secure with Cardinal, then input your Cardinal Commerce credentials.
  3. Under the Test mode section, select Enable test mode for using the sandbox environment. Remember to clear this for production.

Off-site integration

You will need to access both the Shopify Admin Portal and our Hub during these steps.

  1. From the Hub, navigate to Settings > Channels. Here you will find your secret key, which we will need when we run through the Shopify Admin Portal.
  2. Follow this authorization link and log in with your Shopify credentials.
  3. You will see the message You are about to install Checkout.com (Offsite). Select Install payment provider.
  4. From the Shopify Admin Portal, navigate to Settings > Payments.
  5. Select See all other providers.
third party shopify
  1. Use the search bar to search for Checkout.com. Select Checkout.com (Offsite).
  2. Navigate to the Account information section and paste your public key into the Publishable Key field and your secret key into the Secret Key field.
  3. Select which payment methods you'd like to accept.
  4. Under the Test mode section, select Enable test mode for using the sandbox environment. Remember to clear this for production.
  5. Under Deactivate Shopify Payments, select Other > Other.
  6. Select Active Checkout.com (Offsite).
activate

Create redirects and webhooks

Redirection and webhook setup is only necessary for the off-site integration option.

When a customer submits a payment, they are taken to a payment success or a payment error screen. You need to set up redirects so we know where to send the customer when these events happen. In this section, we will walk through how to do this, as well as creating webhook notifications so you are kept informed about a payments timeline.

Create redirects

  1. From the Hub, navigate to Settings > Channels.
  2. Navigate to the URLs section and paste in the following URLs (depending on your environment).

    Payment success URL

    https://sandbox.checkout.com/integration.app/shopify/paymentcomplete

    Payment fail URL

    https://sandbox.checkout.com/integration.app/shopify/paymentcomplete

    redirect webhook
    1. Select Save changes.

    Create a webhook

    1. From the Hub, navigate to Settings > Channels.
    2. Navigate to the Webhooks sections and select New webhook.
    3. Paste in the following URLs (depending on your environment).

      Webhook endpoint URL

      https://sandbox.checkout.com/integration.app/shopify/webhook

      webhook
      1. Select API - v1.0.
      2. Select Select all, then select Create webhook.

      You've successfully set up the integration with your Shopify account! If you're having any problems or just have a question, please contact our Support team for help.