Clover hosted checkout integration

North America—United States and Canada

Overview

The hosted checkout (HCO) integration from Clover lets merchants accept payments for simple orders directly on their website. Customers click a payment button on the merchant's website and are redirected to a Clover-hosted payment page. They enter their payment and shipping details, and Clover completes the transaction, notifies the customer, and redirects them back to the merchant's site

For example, a business selling admission to an event does not have a Clover terminal to take card payments at the event site. In such a scenario, customers can pay for their tickets online using the hosted checkout page.

Key features

Hosted checkout page key features include:

  • PCI-DSS compliance—With the hosted checkout, Clover handles customer card data securely. This reduces the PCI DSS compliance burden for merchants.
  • Customizable checkout—Allows customization of the hosted checkout page to match the merchant's brand and website design.
  • Real-time notifications—Offers webhook configuration to receive real-time notifications on specific payment events.
  • Fraud prevention—Includes reCAPTCHA to combat fraud in card-not-present (CNP) transactions.
  • Seamless integration—Provides a secure and reliable payment flow with minimal developer effort.

Features not supported

  • Clover inventory system—Hosted checkout does not use the Clover inventory system. If you want to use your inventory, visit the Clover App Market for ecommerce apps that can integrate with your existing inventory.
  • Default tax settings—Since hosted checkout requests are not linked to a Clover inventory, any default tax configuration is not applied to hosted checkout payments.

Hosted checkout integration flow

Hosted checkout integration for Clover merchants is available using the Create checkout endpoint. Quick steps for a hosted checkout integration are:

  1. Create a hosted checkout session using the Create checkout endpoint. This session generates a unique URL for the checkout page.
  2. Customize a hosted checkout page to match the website design and branding, providing a seamless user experience.
  3. Redirect customers from the merchant website to the hosted checkout page using the URL generated in step 1. The hosted checkout page securely collects and processes the customer's payment information.
  4. Configure hosted checkout webhooks. After the payment is processed, Clover redirects the customer back to the merchant's website with the payment status. Handle this response to update the order status on the merchant's server.
  5. Test the entire payment flow in the sandbox environment to ensure that the hosted checkout process is smooth and secure.

The hosted checkout session flow works as follows:

1725

Hosted checkout integration flow


📘

Offer flexible payment options to customers—Clover hosted checkout page versus Clover iframe payment form

Clover hosted checkout page is ideal for simple orders where a Clover terminal isn't available on-site, such as event ticket sales. Customers are redirected to a Clover-hosted payment page to enter their payment and shipping details. After the transaction, they are redirected to the merchant's website.

The Clover iframe integration is suitable for merchants who want to maintain a seamless user experience on their own website. The payment form is embedded directly on the merchant's website using an iframe. Customers enter their payment details without leaving the website.


Get started

Use the following to set up a Clover hosted checkout page:

Request hosted checkout session

Use the Clover REST API to create a hosted checkout session.

Customize the hosted checkout page

Set the look and feel of the Clover hosted checkout page, add redirect URLs, and more.

Redirect URLs for customers

Set redirect URLs for customers for page redirects in case of successful, failed, or incomplete transactions.

Configure webhook notifications

Set up webhooks URL on the hosted checkout page so that your app can receive notifications when merchants who have installed your app perform certain actions.

Test on Mac/Linux

Test the hosted checkout experience using basic tools, such as, cURL and a web browser.

Test on Windows

Test the hosted checkout experience using basic tools, such as PowerShell and a web browser.