Skip to main content
Entering Clearent API Keys: Card Terminal

Learn how to add Clearent API keys to your CleanCloud account for in-store card terminal payments.

Rafael avatar
Written by Rafael
Updated over 3 weeks ago

This guide outlines how to enter your Clearent API keys into CleanCloud for terminal-based transactions, ensuring seamless payment processing.


Step 1: Obtain Your Clearent API Details

Clearent will provide API details in a password-protected PDF. Once opened, verify the following:

Business Name & Address – Ensure accuracy, especially for multi-store businesses.
Merchant Number – Matches your Clearent account.
Terminal Control Number (TCN) – Found on the terminal’s white label/sticker (usually on the back).
Product Name – Should be "CleanCloud Dejavoo Zline" (corresponding to your terminal model).

📑 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 → Hardware → Payment Terminals → Clearent Terminal API.

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

    • API Key → Enter in the designated field.

📌 Note:

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

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


Step 3: Set Up Stations (If Necessary)

If you are using multiple card terminals or stations, configure them before entering the API keys.

👉 Go to Settings → Hardware → Stations (top-right corner).
👉 Add new stations or select existing ones.


Step 4: Save & Verify Changes

✔ Click Submit to save your changes.

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

✔ Navigate to the New Order page and check for the "Pay by Card Terminal (Clearent)" payment option.


Step 5: Process Orders with Clearent Terminal

✔ When processing an order, select "Pay by Card Terminal (Clearent)".
✔ The payment terminal will activate, displaying on-screen instructions.
✔ Clearent will assist with test payments to confirm the setup.

🪄 Tip: Ensure the "POS Online" message appears on the terminal screen. If not, contact Clearent Support for assistance.

That’s it! Your terminal is now ready for in-store card payments.


Additional Resources

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

📑 Need help with hosted payments (saved cards)? Check out our guide: Entering Clearent API Keys: Card Not Present (CNP).


🛟 Need more help?

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

Did this answer your question?