1. Documentation /
  2. Clearpay

Clearpay

Clearpay has transformed the way people pay by allowing shoppers to receive products immediately and pay in 3 or 4 instalments over a short period of time. The service is completely free for customers who pay on time – helping consumers spend money responsibly, without incurring interest, fees or revolving in extended debt.

Clearpay is offered by over 85,000 of the world’s best retailers and has more than 14 million active customers globally. The service is currently available in the United Kingdom, as well as Australia, Canada, New Zealand, the United States where its called Afterpay.

Getting Started

↑ Back to top

WordPress Version

↑ Back to top
Please note that the WordPress version must be 5.1.1 or greater to integrate with Clearpay. The WordPress version can be found in the WordPress Admin Dashboard in the bottom right hand corner.

WooCommerce Version

↑ Back to top
Please note that the WooCommerce version must be 2.6 or greater to integrate with Clearpay. The WooCommerce version can be found under: WordPress Admin > Plugins > Installed Plugins

Store Currency

↑ Back to top
Please note that Store Currency must correspond to the Clearpay account region.
  • Navigate to: WordPress Admin > WooCommerce > Settings > General
  • Under ‘Currency options’, the ‘Currency’ must be:
    • Pound sterling (£)
    • Euro(€)

Installation

↑ Back to top
  1. Navigate to: WordPress Admin Dashboard
  2. Navigate to: Plugins > Add New
  1. Type ‘Clearpay’ into the Keyword search box.
  1. Locate the ‘Clearpay Gateway for WooCommerce’ plugin and click ‘Install Now’.
  1. Once the installation is complete, click the ‘Activate’ button.

Configure Plugin

↑ Back to top
Completing the below steps will enable and display Clearpay as a Payment Method. Note: If the ‘Clearpay Gateway Installation’ steps have just been completed, please skip to Step 3.
  1. Navigate to: WordPress Admin Dashboard
  2. Navigate to: Plugins > Installed Plugins
  3. Locate the ‘Clearpay Gateway for WooCommerce’ in the plugin list and click the ‘Settings’ button.
  1. Navigate 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: Upon a successful save of the Clearpay credentials, the ‘Minimum Payment Amount’ and ‘Maximum Payment Amount’ values will be updated.
Notes
The ‘Sandbox’ API Environment is only applicable for dedicated test websites. Advise your Clearpay Account Manager should test credentials be required.

Update Plugin

↑ Back to top
As updates for the ‘Clearpay Gateway for WooCommerce’ plugin are released, a notification will be shown in WordPress Admin. A number will be shown in WordPress Admin next to the Plugins link, indicating that plugin updates are available. Note: Please consider taking a backup of the website files and data prior to performing the update.

Upgrade Instructions

↑ Back to top
  1. Navigate to: WordPress Admin Dashboard
  2. Navigate to: Plugins > Installed Plugins
  3. Locate the ‘Clearpay Gateway for WooCommerce’ in the plugin list. Note: The version update notification will be displayed, with links to the release details and to updated the plugin.
  4. Click the ‘update now’ link.
The ‘Clearpay Gateway for WooCommerce’ plugin will now commence the update process. Once complete, the notification bar will turn green and the text will change to ‘Updated!’.

Express Checkout

↑ Back to top
Clearpay Express Checkout reduces the overall checkout steps so that your shoppers can complete their orders quickly. We’ll let customers checkout directly from the shopping cart and use their pre-filled information on Clearpay – name, shipping address, phone number, email – to complete their orders on your website. Simply – less checkout steps, more conversions.

Checkout Steps for Customers

↑ Back to top
The customer can proceed to the cart where they can choose to ‘Checkout with Clearpay’. Clearpay will pre-fill shipping and billing details, and shoppers can complete their order with 1-click. Clearpay Express checkout comes with Integrated shipping options where Clearpay displays your shipping options to consumers within the Afterpay checkout, with the ability to confirm the order within Clearpay.

Enable or Disable Express Checkout

↑ Back to top
  1. Navigate to: WordPress Admin Dashboard
  2. Navigate 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 toggle the checkbox.
The ‘Clearpay Gateway for WooCommerce’ plugin is available for extension or customisation, without alternations to the plugin code. This allows for a greater level of compatibility with future updates. Advanced Configuration is divided into the following sections:

Check Product Eligibility

↑ Back to top
The Clearpay plugin runs a series of checks to determine whether Clearpay should be an available payment option for each individual product. Third-party plugins can exclude Clearpay from products that would otherwise be considered supported. This can be done by attaching to the following filter hook:  clearpay_is_product_supported
Example (PHP):
/**
* @param bool $bool_result
* @param WC_Product $product
*/
function clearpay_ips_callback( $bool_result, $product ) {
# My custom products don’t support Clearpay.
if ($product->get_type() == ‘my-custom-product-type’) {
$bool_result = false;
} return $bool_result;
}
add_filter( ‘clearpay_is_product_supported’, ‘clearpay_ips_callback’, 10, 2 );

Display on Individual Product Pages

↑ Back to top
Third-party plugins can also filter the HTML content rendered on individual product pages using the following filter hook: clearpay_html_on_individual_product_pages *Note: This is intended for altering the HTML based on custom, varying criteria. For setting the default HTML, use the admin interface under: “WooCommerce > Settings > Checkout > Clearpay”. For hiding the HTML for a subset of products, consider using the following filter hook: clearpay_is_product_supported
Example (PHP):
/** * @param string $str_html
* @param WC_Product $product
* @param float $price
*/ function clearpay_hoipp_callback( $str_html, $product, $price ) {
     # Show a different message for products below a custom threshold.
     # Note that this will only be called if the product price is within
     # the payment limits defined at the account level.
     if ($price < 10.00) {
$str_html = “<p>Shop Now, Pay Later with Clearpay. Supported for orders over $10.00</p>”; }
     return $str_html;
}
add_filter( ‘clearpay_html_on_individual_product_pages’, ‘clearpay_hoipp_callback’, 10, 3 );

Display on Category Pages and Search Results

↑ Back to top
To filter the HTML content rendered on category pages and search results, use the following filter hook: clearpay_html_on_product_thumbnails
*Note: This is intended for altering the HTML based on custom, varying criteria. For setting the default HTML, use the admin interface under: “WooCommerce > Settings > Checkout > Clearpay”. For hiding the HTML for a subset of products, consider using the following filter hook: clearpay_is_product_supported

Display on the Cart Page

↑ Back to top
To filter the HTML content rendered on the cart page, use the following filter hook: clearpay_html_on_cart_page

Display at the Checkout

↑ Back to top
To filter the HTML content rendered at the checkout, use the following filter hook: clearpay_html_at_checkout

Customising Hooks & Priorities

↑ Back to top
As discussed in the section entitled “Theme Support” above, various WooCommerce hooks are assumed to be implemented by the active WordPress theme. Clearpay methods can be detached from their default hooks and reattached to different hooks, or to the same hooks with different priorities. Since version 2.1.0, hooks and priorities can be customised from within the plugin settings page.

Shortcodes

↑ Back to top

Clearpay Product Logo

This is provided for rendering an advanced img tag for displaying the Clearpay logo on individual product pages. The img tag uses the srcset attribute to include 3 different resolutions of the logo for screens with varying pixel density ratios.
Or make 4 payments [OF_OR_FROM] [AMOUNT] with [clearpay_product_logo]
There are 3 different versions of the logo to chose from:
  • colour
  • black
  • white
The default theme is colour. This can be overridden by including a theme attribute inside the shortcode. For example, if you have a dark themed website and wish to use the white mono version of the Clearpay logo:
Or make 4 payments [OF_OR_FROM] [AMOUNT] with [clearpay_product_logo theme=”white”]

FAQ

↑ Back to top

Why is Clearpay not showing on product pages?

↑ Back to top
To display the Clearpay installment detail on the product pages, the active WordPress theme must implement the below action hook: woocommerce_single_product_summary Note: The ‘Payment Info on Individual Product Pages’ setting must also be enabled, and the product must be eligible. For advanced configuration, see our hooks documentation

Why is Clearpay not showing on category and search result pages?

↑ Back to top
To display the Clearpay installment detail on the category and search result pages, the active WordPress theme must implement the below action hook: woocommerce_after_shop_loop_item_title Note: The “Payment Info on Category Pages” setting must also be enabled, and the product/s must be eligible. For advanced configuration, see our hooks documentation

Why is Clearpay not showing on the cart page?

↑ Back to top
A: To display the Clearpay installment detail on the cart page, the active WordPress theme must implement the below action hook: woocommerce_cart_totals_after_order_total
Note: The “Payment Info on Cart Page” setting must also be enabled, and all the cart items must be eligible. For advanced configuration, see our hooks documentation

When do I get paid?

↑ Back to top

Settlement payments are processed 1-5 business days after the order date, with banks typically taking an additional day or two to deposit the settlement into your company account.