The Clearpay Online Developer Hub

Welcome to the Clearpay Online developer hub. You'll find comprehensive guides and documentation to help you start working with Clearpay Online as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Add Payment Option

How can I add Clearpay as a payment option at checkout?

Configuration

Completing the below steps will enable and display Clearpay as a Payment Method.

  1. Ensure you are logged in to the Shopify Admin as the Shopify Store Owner.

  2. Navigate to Settings > Payment Providers.

  3. Under the ‘Alternative payments’ section, click on the ‘Select additional payment method’ dropdown.

  4. Select ‘Clearpay’ from the dropdown options.

  5. Enter the Merchant ID provided by Clearpay into the Merchant ID field.
    The Merchant ID is a 9 digit number (please remove your email address if in this field). If you don't have this please contact your Clearpay Delivery Manager

  6. Enter the Secret Key provided by Clearpay into the Secret Key field.
    The secret key is a long mixture of numbers and letters (please make sure there are no blank spaces copied as this will cause an error)

  7. Be sure not to check the Enable test mode box, as pictured below. The integration will not work if this box is checked.

  8. Click the ‘Activate Clearpay’ button.

❗️

Do Not Enable Test Mode

Do not check this as the integration will not work.
The ‘Enable test mode’ checkbox/function is only applicable for dedicated test websites.
Please advise your Clearpay Delivery Manager should test credentials be required.

Notes

The ‘Enable test mode’ checkbox/function is only applicable for dedicated test websites.
Advise your Clearpay Account Manager should test credentials be required.

Updated about a month ago


Add Payment Option


How can I add Clearpay as a payment option at checkout?

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.