This guide outlines the process of entering your Clearent API keys into CleanCloud for terminal-based transactions.
Step 1: Obtaining Your Clearent API Details
Clearent will provide you with your API details typically in a password-protected PDF document. Upon entering the provided password, you'll find a document containing essential information.
Verify your business name, address, and Merchant Number for accuracy.
Ensure the TCN number on the terminal matches the one provided in the PDF, usually attached to a white label/sticker on the back of the terminal.
Ensure the product name is correct, often showing as 'CleanCloud Dejavoo Zline' corresponding to your terminal model.
📑 The Clearent PDF will have a format similar to the image below:
Step 2: Entering API Key into CleanCloud
Access your CleanCloud account.
Navigate to Settings > Hardware > Payment Terminals > Clearent Terminal API > API Key.
Copy the API Key from the Clearent PDF and paste it into the designated field in CleanCloud.
🗒️ Note:
Ensure there are no extra spaces at the beginning or end of the keys.
Double-check that the information entered in CleanCloud matches precisely with the Clearent PDF document.
Step 3: Setting Up Stations (If Necessary)
If using multiple terminals or stations, before entering the keys, create a new station on CleanCloud for each specific terminal.
👉 Access Settings > Hardware > Stations (in the top right corner) to add or select existing stations.
Step 4: Saving Changes
After verifying all details, click the 'Submit' button to save your changes.
💡 Pro Tip: In case the page freezes on 'Updating', simply refresh the browser and revisit the Hardware section to confirm the changes.
Step 5: Verification
To confirm the successful setup, navigate to the New Order page where you'll find a new payment method titled 'Pay by Card Terminal (Clearent)'.
Step 6: Processing Orders
When processing an order, selecting 'Pay by Card Terminal (Clearent)' will activate the terminal and prompt further instructions on the terminal screen.
Clearent will typically assist with testing payments to ensure proper setup.
💡 Pro Tip: Check for 'POS Online' on the terminal screen to verify successful setup; if not displayed, contact Clearent for assistance.
✅ That's it! Now you're ready to initiate card terminal payments.
🔎 Additional Information
🎥 You can refer to this step-by-step video guide to assist you through all the processes outlined in the guide.
📑 In case you need help adding the Clearent keys for hosted payment, please follow this guide: 'Entering Clearent API Keys: Card Not Present (CNP)'.
💡 Tip
Need more help?
Explore our Help Center articles for answers. Contact us if you need further assistance.