How To Create An API Username/Key In An NMI Account - Internal

Overview: This tutorial will walk you through how to create an API user account (API Username & API Key) within a Merchant account in the NMI Portal. 

API Username = Username created for API account within the Merchant NMI Portal.

API Key = Password Created for API account.

1. While on the Merchant Details page of the merchant in question, select the "Log in" button neighboring the Admin Account in the Merchant Users section.

2. This will prompt you with the Merchant Dashboard screen. Here you will need to select the "Settings" option towards the bottom of your screen in the Utilities section.

3. You will now be on the admin accounts Option screen. Select the "User Accounts" option in the General Options section.

4. Here is where all the Admins user accounts will be displayed and where you can edit or add new users. To Create an API user account, select the purple "Add A New User" button.

5. Fill in all the required fields and be sure to include an email address that you have access to.

Note 1: The email address designated will receive an email notification to set up a password (Which will be the API Key) so it's imperative that you're using an accessible email address.

Note 2: When you Create The API Username, it is in good practice to name the API username after the Admin user. See the example below.


Merchant Admin account is: new-springfield-church-Admin

Then the API username is generally set up to read as...

Recommended API Username: new-springfield-church-API

Important Permissions to check off in the "Permissions" section when setting up your API User.

1. Virtual Terminal Access (Credit and Electronic Check - If Applicable)

2. API Access (Credit and Electronic Check - If Applicable) 

3. Batch Access (Credit and Electronic Check - If Applicable) 

4. Select "Access the Customer Vault."

5. Select "Access Other Users' Transactions"

6. Once you fill out all the required information, select the green "Create User" button located at the bottom of the questionnaire.

7. You will then receive an email from NMI requesting that you set up a password (this will be your "API Key") so this is very important to generate a lengthy and difficult password.

8. Save your password (API Key and Username) somewhere safe. Then Provide the API Username which in this example would be "new-springfield-church-API" and the newly generated password/API Key to the production team assigned to integrating the Keys to the platform.

Important: All donor information has been hidden to protect their privacy and information.