Create a Smart Fields API Key

Step-by-step guide to generating and managing your Smart Fields API key in the LocalPayment dashboard.

Smart Fields provide a secure and PCI-compliant 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.

Generate a Smart Fields API Key in the LocalPayment Dashboard

Follow this simple guide to create your new Smart Fields API key.

  1. Access your Localpayment Dashboard.

    • Your user account must have the necessary permissions to access the Smart Fields API Key section.

  2. Click on "Payin".

  3. Click on "Checkout".

  4. Click on "Smart Fields Api Keys". This will take you to the management page for all your API keys.

  5. Click the "Add API Key" button.

  6. A form will appear. You need to provide the following required information:

    • 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.

  7. Click the "Accept" button to generate the API key.

  8. 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.

Additional Smart Fields API Key Management

The LocalPayment dashboard also allows you to manage your existing keys easily:

Deactivate/Activate a Key

Instead of deleting a key, you can temporarily deactivate it. This is useful for pausing access without losing the key's historical data. Simply find the key in the list and click Deactivate/Activate icon to change its status. You will be prompted to confirm this action.

Delete a Key

If you are sure a key is no longer needed, you can permanently delete it. Find the key in the list and click the Delete icon. You will be prompted to confirm this action.

Warning:

This action is irreversible. Any integration using that key will immediately stop working.

PreviousWire OutNextIntro to FX operations

Last updated

Was this helpful?