For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Introduction to Clearpay
    • Getting Started with Clearpay Online
    • Business Hub
    • Marketing Resources
  • Platforms
    • Platforms Quickstart
    • Adobe Commerce (Magento 2)
    • Adyen
    • Ecwid
    • Shopify
    • Stripe
    • Wix
    • WooCommerce
      • Advanced configuration
      • Frequently asked questions
      • Currency Conversion
      • Configure plugin
      • Hooks
  • API Development
    • API Quickstart
    • Test Environments
    • Certification
  • Clearpay Messaging
    • Getting Started
    • Implementation
    • Migration
    • Launch Clearpay Info Modal Anywhere
LogoLogo
On this page
  • Configuration
  • Enable Express Checkout
  • Enabling the Clearpay Messaging for WooCommerce
  • Payment Info on Category Pages
  • Hook
  • Payment Info on Individual Product Pages
  • Hook
  • Payment Info Display for Product Variant
PlatformsWooCommerce

Configure plugin

How can I add Clearpay as a payment method and display Clearpay Site Messaging?
Was this page helpful?
Previous

Hooks

This section describes the WordPress hooks used by the Clearpay WooCommerce integration.
Next
Built with

Configuration

Complete the steps below to enable and display Clearpay as a Payment Method and add Clearpay messaging to product pages.

Note

If the ‘Clearpay Gateway Installation’ steps have just been completed, go to Step 3.

  1. Go to the WordPress Admin Dashboard.
  2. Go to Plugins > Installed Plugins.
  3. Find the Clearpay Gateway for WooCommerce in the plugin list and click Settings.
  4. Go to the Core Configuration section.
  1. Enter the Merchant ID provided by Clearpay into the Merchant ID field.
  1. Enter the Secret Key provided by Clearpay into the Secret Key field.
  1. Click the Save changes button at the bottom of the page.
Note

When the Clearpay credentials are saved, the Minimum Payment Amount and Maximum Payment Amount values are automatically updated.

Enable Express Checkout

  1. Go to the WordPress Admin Dashboard
  2. Go to Plugins > Installed Plugins
  3. Locate the Clearpay Gateway for WooCommerce in the plugin list and click the Settings button.
  4. Find Express Checkout Configuration and enable the Enable on Cart Page checkbox.

Enabling the Clearpay Messaging for WooCommerce

The Clearpay messaging can be enabled on:

  • Category Pages

  • Product Pages

  • Cart Page

To start do the following:

  1. Login to the Wordpress Dashboard.
  2. Go to Plugins > Installed plugins > Clearpay Gateway for Woocommerce and click Settings.

Under Settings, you can see settings for:

  • Express Checkout Configuration

  • Payment Info on Category Pages

  • Payment Info on Individual Product Pages

  • Payment Info Display for Product Variant

These settings are described below.

Payment Info on Category Pages

To enable the messaging on the Category page, do the following:

  1. Ensure the Enable checkbox is enabled.
  2. Enter the correct hook to position the messaging and set the priority to increase or decrease the height of the Messaging position. See the Hook section below.

Hook

The positioning of the Messaging for Woocommerce relies on a hook. This link is a guide to understanding hook positioning on Category pages.

Warning

The hooks for Category pages and Product pages are completely different.

For example, use the hook woocommerce_after_shop_loop_itemto position the messaging under the price:

Below is an example of a category page with Clearpay messaging:

Note

For more information on hooks, see the Hooks page.

Payment Info on Individual Product Pages

To enable the messaging on the individual Product page, do the following:

  1. Ensure the Enable checkbox is enabled.
  2. Enter the correct hook to position the messaging and set the priority to increase or decrease the height of the Messaging position. See the Hook section below.

Hook

The positioning of the Messaging for Woocommerce relies on a hook. This link is a guide to understanding hook positioning for Product pages.

Warning

The hooks for Product Pages and Category Pages are completely different.

For example, use the hook woocommerce_before_add_to_cart_form to position the messaging directly under the Product Page price:

Below is an example of a Product Page with Clearpay messaging:

Note

For more information on hooks, see the Hooks page.

Payment Info Display for Product Variant

This option enables the Clearpay Messaging for any variant products.

For example a product that has a price range from £50 - £200. The Clearpay Messaging will also display the instalment breakdown according to a price range.

When a customer selects a variant, a specific price appears. This option enables the Clearpay Messaging to display a specific price breakdown.