In this guide, we will walk you through entering your Clearent API details into your CleanCloud account specifically for hosted and saved card payments, also known as Card Not Present (CNP).
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 that the document contains the correct business name, address, and Merchant Number–especially if you manage multiple stores or have multiple Clearent merchant accounts.
Double-check the product name; for Card Not Present details, it should specify 'CleanCloud (CNP)'.
📑 The Clearent PDF will have a format similar to the image below:
Step 2: Entering API Keys into CleanCloud
Access your CleanCloud account.
Navigate to Settings > Admin > Payments & Finances > Payments > Clearent > Hosted Payments.
Copy the API Key and Public Key from the Clearent PDF.
Paste the API Key into the 'API Key' field and the Public Key into the 'HPP Key' 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: 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 Payments section to confirm the changes.
Step 4: Verification
To confirm successful setup, navigate to the New Order page where you'll find a new payment method titled 'Pay With Saved Card (Clearent)'.
Step 5: Adding Card Details to Customer Account
1. Access the customer CRM account and navigate to the 'Edit Customer' tab to add card details under the 'Clearent Credit Card' field.
2. Upon saving the card details, a banner on the New Order page will indicate the presence of a saved card on the customer's account.
✅ That's it! Now you're ready to initiate hosted card 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 terminal-based transactions, please follow this guide: 'Entering Clearent API Keys: Card Terminal'.
💡 Tip
Need more help?
Explore our Help Center articles for answers. Contact us if you need further assistance.