Skip to main content

Entering Clearent API Keys: Card Not Present (CNP)

Learn how to add Clearent API keys to your CleanCloud account for hosted payments, also known as Card Not Present (CNP).

Written by Rafael
Updated over a year ago

This guide walks you through entering your Clearent API details into CleanCloud for hosted and saved card payments, also known as Card Not Present (CNP) transactions.


Step 1: Obtain Your Clearent API Details

Clearent will provide your API details in a password-protected PDF. Once opened, ensure the document contains:

Correct Business Name & Address – Especially important for multi-store businesses.
Merchant Number – Verify it matches your store.
Product Name – It should specifically mention "CleanCloud (CNP)" for Card Not Present transactions.

📑 The Clearent PDF will have a format similar to the image below:


Step 2: Enter API Keys into CleanCloud

  1. Log in to CleanCloud.

  2. Go to Settings → Admin → Payments & Finances → Payments → Clearent → Hosted Payments.

  3. Copy and paste the API details from your Clearent PDF:

    • API Key → Enter in the 'API Key' field.

    • Public Key → Enter in the 'HPP Key' field.

📌 Note:

  • Ensure there are no extra spaces when copying the keys.

  • Double-check the details match exactly with your Clearent PDF.


Step 3: Save & Verify Changes

✔ Click Submit to save your changes.

🪄 Tip: If the page freezes on "Updating," refresh your browser and check the Payments section to confirm changes.

✔ To verify the setup, navigate to the New Order page, where a new payment option "Pay With Saved Card (Clearent)" should be available.


Step 4: Add Saved Card to a Customer Profile

  1. Open the Customer CRM → Edit Customer tab.

  2. Locate the 'Clearent Credit Card' field and add the customer's card details.

  3. Once saved, a banner will appear on the New Order page, confirming a saved card is linked to the customer's account.

That’s it! You’re now ready to process hosted card payments.


Additional Resources

🎥 Video Guide: Follow this step-by-step tutorial for setup assistance.

📑 Need help setting up Clearent for terminal-based payments? Check out our guide: Entering Clearent API Keys: Card Terminal.


🛟 Need more help?

Explore our Help Center articles for answers. Contact us for further assistance.

Did this answer your question?