Shopify offsite payments app
Last updated: August 3, 2022
From downloading the payments app to requesting your first test payment, learn how to get started with the Checkout.com offsite payments app for Shopify.
- 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
To connect the Checkout.com Payments App to your Shopify store, you will need your API keys:
- Sign in to your Dashboard account.
- Create a secret API key that is associated with a single processing channel. Copy the secret value securely, because you will not be able to view the full key after it's been generated.
- Create a public API key.
Note
Creating an API Key with the Allow any processing channel option enabled will cause payments to fail.
- Go to the Checkout.com Payments App listing on the Shopify app store and select Add app.
- You'll be redirected to your Shopify store, where you'll be prompted to install the Checkout.com Payments App. Select Install 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.
- Under Account Type, select NAS Account.
- Enter your API credentials. If you do not have a Production secret API key, you can reuse your sandbox secret API key and remove the
_sboxprefix. - Select the payment methods you want to support.
- Select whether you want to enable 3DS authentication.
- Enter the billing descriptor details.
- Select Save.
- After configuring the Account Settings section, navigate to Apps > Webhooks in the left-hand menu.
- Select Register Webhook for the environments you’ll be using.
- In the Account Settings section, ensure that the Account Not Ready tag has changed to Account Ready.
When the application has been configured and the tag has changed to Account Ready, you can activate the payments app:
- Go to Settings > Payments.
- In the Supported payment methods section, select Add payment methods.
- Select Search by provider and search for Checkout.com.
- Select Checkout.com – Offsite Payments, and activate it.
- You'll be redirected to the Account Settings page. Select Activate Checkout.com - Offsite Payments at the bottom – this will enable the Checkout.com Payments App on your store.
If you currently have the legacy off-site integration activated, follow these steps to migrate to the Checkout.com Payments App:
- From the Shopify Admin Portal, go to Settings > Payments.
- In the Supported payment methods section, select Add payment methods.
- Select Search by provider, choose Checkout.com - Offsite Payments, and select either Activate or Activate the test mode to simulate transactions before going live.
- When you're ready to go live, deactivate the legacy Checkout.com off-site integration:
- From the Shopify Admin Portal, go to Settings > Payments.
- In the Supported payment methods section, find the legacy Checkout.com off-site integration and select Manage.
- 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.
Note
If you uninstall the legacy off-site integration, it will not be available for use with any outstanding order returns.
- From the Shopify Admin Portal, go to Settings > Payments.
- In the Supported payment methods section, find Checkout.com - Offsite Payments and select Manage.
- In the Test mode section, select Enable test mode.
- 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 Continue to shipping, then Continue to payment.
- After clicking Complete order, you will be redirected to our Hosted Payments Page to complete the test payment.
- Enter the following card details:
- Number:
4242 4242 4242 4242 - Expiry date: any future date
- CVV:
100
- Number:
- 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.
- In the Shopify store admin, go to Orders to confirm that the order has gone through.
- Sign in to your Checkout.com Dashboard account.
- Go to Payments. The order payment will be displayed there with a status indication, such as AUTH.
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.