Smart Fields Api Keys

Smart Fields provide a secure way to collect sensitive payment information directly on your website. To integrate them , you first need to generate a unique API key. This key authenticates your requests and links the tokenized payment data to your account.

Prerequisites

Before you begin, ensure you have:

Navigation Path

Side Menu → PayIn → Checkout → Smart Fields Api Keys

Step-by-Step Guide

1. Navigate to the PayIn module from the side menu.
2. Select the Checkout section.
3. Then, select the Smart Fields Api Keys section.
4. Click the Add API Key button.
5. Fill in the required details:
   • Title: Enter a descriptive name for this key (e.g., "Production Website," "John's Test Store"). This helps you identify it later.
   • Domain: Enter the domain name from which this API key will be used (e.g., myshop.com). For security, the key will only work on the specified domain.
6. Click the "Accept" button to generate the API key.
7. Your new API Key will now be visible in the Smart Fields Api Key list. It will be a long string of random characters. Copy this key and store it securely in your application's environment variables or configuration files.

👍

Now that you have your keys, you can start building with SmartFields. For implementation details, see Embedded Iframe

1234567

Step 1

Navigate to the PayIn module from the dashboard side menu.

BackNext

Managing Your Iframe Keys

Viewing Existing Keys

Navigate to the Iframe Keys section to see a comprehensive list of all your created keys, including:

• Key title and creation date
• Associated domain
• Status (Active/Inactive)
• Public Key

Removing Iframe Key

1. Locate the key you want to remove in your keys list.
2. Click the Delete icon next to the key.
3. Review the confirmation message carefully - this action cannot be undone.
4. Click OK to permanently remove the key.

❗️

Warning

Deleting a key will immediately disable any integrations using it. Ensure you have updated your implementations before deletion.

Deactivate/Activate Iframe Key

1. Find the key you wish to deactivate or activate in your keys list.
2. Click the Deactivate/Activate toggle icon next to the key.
3. Review the confirmation message carefully.
4. Click OK to change the key status.

✅

Tip

Deactivating a key temporarily disables it without deletion, useful for maintenance or troubleshooting.