Configure Extension
What settings are required for the Adobe Commerce extension?
Basic Settings
-
Login to Adobe Commerce Admin and go to Stores → Configuration → Sales → Payment Methods → Clearpay (scroll down).
-
Click Basic Settings.
| Setting | Value |
|---|---|
| Enabled | Yes - Clearpay turned on. No - Clearpay disabled. Click the Use Default checkbox to use the default setting, which is Yes. |
| API Mode | Sandbox - for development or staging environments. Production - for your live website. Click the Use Default checkbox to use the default setting, which is Sandbox. |
| Merchant ID | Your 9 digit Sandbox or Production Clearpay Merchant ID. |
| Merchant Key | Your Sandbox or Production Clearpay Secret Key. |
Advanced Settings
- Click Advanced Settings
| Setting | Value |
|---|---|
| Minimum Order Total | Shows the minimum price for an order payable with Clearpay. |
| Maximum Order Total | Shows the maximum proce for an order payable with Clearpay. |
| CBT Available Currencies | Lists the currencies available for Cross Border Trade (CBT). To enable this, contact your Clearpay Representative. |
The above three settings are all read-only display fields. The information they display comes from the Clearpay API, so you cannot edit them here.
| Setting | Value |
|---|---|
| Public Id | A publishable API key used by Clearpay's Dynamic Messaging feature. It is a unique identifier for the merchant account. |
| Consumer Lending Enabled | Shows if the merchant account is enabled for Pay Monthly which is for US merchants only. The Clearpay fixed setting is No. |
| Consumer Lending Minimum Order Total | The minimum order total for the use of the customer lending facility. This relates to the Consumer Lending field above, so is always 0. |
| Update Merchant Configuration | Click this button to update the limit configuration and specific countries from the Clearpay API. |
| Debug | Yes - Debug logs are written to "h-0": "/var/log/clearpay.log No - Disabled. Click the Use Default checkbox to use the default setting, which is Yes. |
| Display on Product Page | Yes - Clearpay displays on the Product Page. Click the Use Default checkbox to use the default setting, which is Yes. |
| Display on Cart Page | Yes - Adobe Commerce Checkout - proceed to checkout page as normal. Yes - Express Checkout - enable Clearpay Express Checkout from cart page. No - Clearpay will not display on the Cart page. Click the Use Default checkbox to use the default setting, which is Yes. |
| Sort Order | The order of payment methods at checkout. |
| Setting | Value |
|---|---|
| Exclude Categories | Select the relevant categories to exclude Clearpay from being available. Click the Use Default checkbox to use the default setting, which excludes nothing. |
| Payment Flow | Immediate Payment Flow - Capture full payment. Deferred Payment Flow - Capture incremental amounts as items are dispatched. |
| Enable Auto-Reversals | This is useful if an exception occurs when Adobe Commerce is finalising an order after Clearpay have approved the payment. In this case the payment is reversed automatically. This reversal helps prevent customers paying for orders that cannot be fulfilled. |
Warning
In the table above, we do not recommend the use of the Auto-Reversals feature if you use an external Order Management System (OMS).
Advanced Frontend Settings
Use these settings for custom-built themes on your website. The default of these settings is NO (disabled), which means your pages display in the default Adobe Commerce Luma theme, or similar.
These custom-built themes are not dependent on Knockout.js, which is the default frontend framework included with Adobe Commerce. If enabled, Advanced Frontend Settings allow Clearpay messaging to display on the product page, cart and mini-cart, regardless of the frontend framework used by your theme.
You, the merchant, must configure the Placement selectors and the Price selectors according to the theme you have designed and your web page type.
Note
This feature is only available for Adobe Commerce 2.4 (and above) users.
Do the following:
-
Login to Adobe Commerce Admin and go to Stores → Configuration → Sales → Payment Methods → Clearpay (scroll down).
-
Click Advanced Frontend Settings. The advanced frontend settings fields display, in the default setting of No, which means they are disabled. See screenshot below:
The example screen below shows the range of settings when the advanced frontend settings fields are enabled:
See the table below for information on the various settings.
Note
In all cases, you should place Clearpay messaging immediately below the price element in the PDP (Product Page), cart and mini cart.
| Setting | Value |
|---|---|
| Enable for Product Page | Select Yes to enable Advanced Frontend Settings for product pages. |
| Placement selector (Product Page) | Enter a CSS (Cascading Style Sheet) selector for a target element on the product page. Clearpay asset placement is injected below the first matching element. |
| Price selector (Product Page) | Enter a CSS selector for the product price element. The product price is extracted from the first matching element. |
| Placement selector (Bundle Product Page) | Enter a CSS selector for a target element on the bundle product page. Clearpay asset placement is injected below the first matching element. |
| Price selector (Bundle Product Page) | Enter a CSS selector for the bundle product price element. The bundle product price is extracted from the first matching element. |
| Enable for Cart Page | Select Yes to enable Advanced Frontend Settings for the shopping cart page. |
| Placement selector (Cart Page) | Enter a CSS selector for a target element on the cart page. Clearpay asset placement is injected below the first matching element. |
| Price selector (Cart Page) | Enter a CSS selector for the order price element. The order price is extracted from the first matching element. |
| Enable for Mini Cart | Select Yes to enable Advanced Frontend Settings for the mini cart. |
| Placement selector (Mini Cart) | Enter a CSS selector for a target element on the mini cart. Clearpay asset placement is injected below the first matching element. |
| Container selector (Mini Cart) | Enter a CSS selector to select a container on the mini cart page. |
| Price selector (Mini Cart) | Enter a CSS selector for the mini cart order price element. The order price is extracted from the first matching element. |
Express Checkout Settings
- Click Express Checkout Settings.
| Setting | Value |
|---|---|
| Display on Product Page | Yes - Can checkout directly from Product Page. No - No checkout from the Product Page. Click the Use Default checkbox to use the default setting, which is Yes. |
| Display on Cart Page | Yes - Can checkout directly from Cart Page. No - No checkout from the Cart Page. Click the Use Default checkbox to use the default setting, which is Yes. |
| Display on Mini-Cart | Yes - Can checkout directly from Mini-Cart. No - No direct checkout from the Mini-Cart. Click the Use Default checkbox to use the default setting, which is Yes. |
Updated 9 days ago