Skip to content
Integrate / E-commerce platforms / Shopify payments app

Shopify payments app

Last updated: 14th July 2022

From downloading the payments app to requesting your first test payment, learn how to get started with the Checkout.com payments app for Shopify.

Supported featuress

  • Automatic and manual capture, void, and refund from the Shopify Admin Portal
  • Partial capture and partial refunds
  • Cards and alternative payment methods
  • Webhook notifications for up-to-date payment statuses
  • Hosted Payments Page
  • 3D Secure 2.0
  • Dynamic descriptors

Before you start

To connect the Checkout.com payments app to your Shopify store, you will need your API keys:

  1. Sign in to your Dashboard account.
  2. Create a secret API key. Keep this key somewhere safe, because you will not be able to view the full key after it's been generated.

Install the payments app

You can install the Checkout.com payments app in 2 ways:

  • Through the direct installation link: https://api.shopify-cko.co/api/v1/admin/auth?shop=(INSERT SHOPIFY STORE URL). Once the installation link has opened, you will be redirected to the installation page.
  • Through Shopify’s public list of payment gateways in the Shopify Admin Portal:
    1. Go to Settings > Payments.
    2. In the Supported payment methods section, select Add payment methods.
    3. Select Search by provider, search for Checkout.com - Offsite Payments, and select Activate.
    4. Select Install app.

Configure the payments app

After installing the app, you will need to configure it before it can be activated. Select Manage to enter the app configuration and settings.

Selecting Manage will open a page in a new tab. Keep the other page open as it will be required for activation.

  1. Under Account Type, select NAS Account.
  2. Enter your API credentials.
  3. Select the payment methods you want to support.
  4. Select whether you want to enable 3DS authentication.
  5. Enter the billing descriptor details.
  6. Select Save.
  7. Select the Webhooks tab and register the production and sandbox webhooks.
  8. In the Account Settings tab, ensure that the Account Not Ready tag has changed to Account Ready.

Activate the payments app

When the application has been configured and the tag has changed to Account Ready, return to the previous page from which you were redirected. Refresh the page and select Activate Checkout.com - Offsite Payments.

Migrate from the legacy off-site integration to the Checkout.com payments app

If you currently have the legacy off-site integration activated, follow these steps to migrate to the Checkout.com payments app:

  1. From the Shopify Admin Portal, go to Settings > Payments.
  2. In the Supported payment methods section, select Add payment methods.
  3. Select Search by provider, choose Checkout.com - Offsite Payments, and select either Activate or Activate the test mode to simulate transactions before going live.
  4. When you're ready to go live, deactivate the legacy Checkout.com off-site integration:
    1. From the Shopify Admin Portal, go to Settings > Payments.
    2. In the Supported payment methods section, find the legacy Checkout.com off-site integration and select Manage.
    3. Select Deactivate to disable the integration.

When you deactivate the legacy off-site integration, its payment methods are no longer displayed on the checkout page. However, you can still manage refunds and captures for orders created with the deactivated integration, via Shopify Admin Portal or the Dashboard.

If you uninstall the legacy off-site integration, it will not be available for use with any outstanding order returns.

Test your integration

  1. From the Shopify Admin Portal, go to Settings > Payments.
  2. In the Supported payment methods section, find Checkout.com - Offsite Payments and select Manage.
  3. In the Test mode section, select Enable test mode.
  4. Go to your storefront and add a product to your cart.
  5. Go to your cart and proceed to checkout.
  6. Enter the required billing details. We recommend using a real email address so you can receive the order confirmation.
  7. Select Continue to shipping, then Continue to payment.
  8. After clicking Complete order, you will be redirected to our Hosted Payments Page to complete the test payment.
  9. Enter the following card details:
    • Number: 4242 4242 4242 4242
    • Expiry date: any future date
    • CVV: 100
  10. Select Pay. After completing the 3DS authentication simulator, 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.
  11. In the Shopify store admin, go to Orders to confirm that the order has gone through.
  12. Sign in to your Checkout.com Dashboard account.
  13. Go to Payments. The order payment will be displayed there with a status indication, such as AUTH.

Go live

If you're happy with the outcome of your testing and want to start taking payments right away, find Checkout.com - Offsite Payments in the Supported payment methods section, select Manage and deselect Enable Test Mode.

You are now live with the Checkout.com payments app.

On this page

Supported featuress
Before you start
Install the payments app
Configure the payments app
Migrate from the legacy off-site integration to the Checkout.com payments app
Test your integration
Go live