Skip to main content

Generate an NMI Secret Key for Phoenix

To connect your payment gateway to Phoenix, you must generate a Secret Key from your NMI account.

This key allows Phoenix to securely communicate with your gateway and process transactions correctly.

To follow this guide, make sure you have access to your payment gateway account and a user profile with permission to manage API settings.

In this guide, you’ll learn how to configure your API settings, generate a new private key, and ensure your account is ready for production use.

Access Your Gateway Account​

To begin:

  1. Log in to your payment gateway account.

  2. Go to Options.

  3. Click Settings.

  4. Select API Configuration.

Configure API Settings​

Before generating the key, you must update your API configuration to ensure compatibility with Phoenix.

In the API Configuration section:

  1. Locate the available API options and ensure the following parameters are enabled:

    • CC Type

    • Customer Vault ID

      Customer Vault Requirement

      If you are using a third-party gateway, make sure Customer Vault ID is enabled. This is required for proper integration with Phoenix.

  2. Click Save to apply your changes.

  3. Click Ok to confirm.

Generate the Secret Key​

Once the API settings are configured:

  1. Go back to Options.

  2. Click Settings.

  3. Select Security Keys.

  4. Click Add New Private Key.

  5. Enter a descriptive name for your private security key (for example, CRM 3.0).

  6. Assign the key to your user profile.

  7. Enable the following permissions:

    • API
    • Cart

  8. Click Create to save and generate your private key.

  9. Locate the newly generated private key and copy the Secret Key.

This key will be used to complete your gateway configuration in Phoenix.

Disable Test Mode​

Before using the key, confirm that your account is not in test mode:

  1. Go to My Settings.

  2. Select the Test Mode option.

  3. Make sure Test Mode is disabled.

    Test Mode

    If test mode is enabled, transactions will not be processed correctly in Phoenix.

To continue configuring your payment setup and complete your Phoenix integration, review these guides: