Process Payments In IRIS CRM With NMI Payment Gateway

NMI Payment Gateway Integration

IRIS CRM is happy to share that we have added NMI’s payment gateway as an option when taking payments through IRIS CRM.

The new NMI Payment Gateway integration is easy to set up, simply follow the instructions detailed below or watch our video walkthrough. You will need access to the NMI Portal and admin-level permissions to your IRIS CRM site in order to configure the integration. 

Once all of the setup steps have been completed, your organization will be able to start processing credit card payments through NMI within your IRIS CRM site. Adding support for NMI provides more choice when it comes to processing payments all while maintaining the ease of doing it from your CRM. 

If you’d like to use NMI as the gateway when merchants pay their invoices, update the gateway to NMI in your invoice templates so any future invoice payments are processed through them. 

That’s it! Complete the configuration and you’ll be ready to start processing credit card payments using NMI.


How To Configure NMI Payment Gateway

IRIS CRM – NMI Payment Gateway Integration Walkthrough

Step 1: NMI Portal Access

In order to integrate the NMI payment gateway with your IRIS CRM site, you will first need to have NMI Portal access. You will need to log in to your NMI Portal in order to complete the remaining setup steps.

NMI Partner Portal Login


Step 2: Add Private Key In NMI Portal

Once you’ve logged into your NMI Portal, navigate to the Settings page. This can be accessed under Options in the menu, or under Utilities on the main page:

NMI Portal Settings  

On the Settings page, click Security Keys on the right side under Security Options:

NMI Security Keys  

Once you’re on the Security Keys page, click Add a New Private Key: NMI Add Private Key  

When adding the new private key, you can name it however you’d like, something related to IRIS CRM is recommended. Select the user to associate with the key. Check the API box! Finally, click Create:

New NMI Private Key


Once you’ve created the new private key in the NMI Portal, copy the key:

Copy NMI private key


Step 3: Create New Payment Gateway in IRIS CRM

Once you’ve logged in to your NMI Portal, you will need to log in to your IRIS CRM site. Then, navigate to Manage > Administration > Integrations > NMI (Process credit card payments using NMI). You can also reach this page by adding “/payment/gateways” to the end of your site’s URL.

IRIS CRM Payment Gateways


Click + New Gateway in the top right of the Payment Gateways page to create a new gateway connection:

Add New IRIS CRM Payment Gateway


Select NMI as the payment gateway, the default name will be NMI which you can update if you’d like:

Add NMI Gateway to IRIS CRM


Paste the private key that you copied from the NMI Portal at the end of Step 2 in the API Key field:

Add API Key For NMI Gateway in IRIS CRM


Click the toggle to make NMI your Default Credit Card Gateway, if you’d like, and then click Create:

Create NMI Gateway in IRIS CRM


Step 4: Configure API Settings In NMI Portal

In your NMI Portal, again under Settings, click on API Configuration:

NMI API Configuration


Leave the 9 default values in the right column, Fields Returned. Then, move Customer Vault ID and Billing Address ID from the left to the right so they are in the Fields Returned column:

Updated NMI API Configuration


Scroll to the bottom of the page and click Save once the two fields are added:

Save NMI API Configuration


A confirmation message will appear to confirm the changes, click Ok to proceed:

Confirm NMI Configuration Update


Step 5: Configure Web Hooks

On the IRIS CRM Payment Gateways page where your new NMI gateway was added in step 3, click the Sync Web Hooks icon (arrows) in the Actions column:


This will provide instructions on how to complete the web hooks sync, which are also listed below:

IRIS CRM Webhooks Instructions


5.1 – 5.3: Log In To NMI Portal 

In your NMI Portal, again under Settings, click on Webhooks:


5.4: Create Endpoint

Click the Create button under Endpoints:

NMI Create Endpoint


5.5: Enter URL & Subscribe To Events

Copy the URL provided in the IRIS CRM web hooks instruction pop-up in step 5:



Paste the URL from IRIS CRM into the URL field at the top of the NMI Endpoints page:

NMI Endpoint URL


Move the following 18 events from the left, Available Events, to the Right, Subscribed Events:

  7. transaction.refund.success
  8. transaction.refund.failure
  9. transaction.refund.unknown
  10. transaction.void.success
  11. transaction.void.failure
  12. transaction.void.unknown
  13. transaction.capture.success
  14. transaction.capture.failure
  15. transaction.capture.unknown
  16. transaction.auth.success
  17. transaction.auth.failure
  18. transaction.auth.unknown

NMI Webhook Subscribed Events


5.6: Save Changes

Click Save Changes at the bottom of the page:

Save NMI Webhook changes


5.7: Create Another Endpoint

Click on the Create button again under Endpoints:

NMI Create 2nd Endpoint


5.8: Enter URL & Subscribe to Events

Copy the URL from step 8 of the IRIS CRM web hooks instructions pop-up:

IRIS CRM 2nd Webhook URL

Paste the URL from IRIS CRM into the URL field of the NMI create endpoint page:

NMI 2nd Endpoint URL

Move settlement.batch.complete from the left to the right under Subscribed Events:

NMI Settle Complete Event

5.9: Save Changes

Click Save at the bottom of the page to save the endpoint changes: Save 2nd NMI Endpoint  

5.10: Copy The NMI Signing Key & Paste In To IRIS CRM

Copy the NMI Signing Key:

NMI Signing Key


Paste the NMI Signing Key into the empty field on step 10 of the IRIS CRM Web Hooks instruction pop-up:

IRIS CRM Signing Key


5.11: Save IRIS CRM Web Hooks

Click Save at the bottom right of the IRIS CRM web hooks pop-up:

Save IRIS CRM Webhooks


Step 6: Enable Webhooks in IRIS CRM

No user action is needed to enable IRIS CRM web hooks for the NMI Payment Gateway. Once a transaction is processed through the gateway, IRIS CRM’s web hooks will automatically be activated. 

IRIS CRM Webhooks Status

Enabled IRIS CRM Webhooks Status


Step 7: Set Level 3 Default Values

Once the NMI Payment Gateway is configured, you can set Level Three Defaults by clicking the gear icon under Actions:

NMI Level Three Defaults


This will bring you the Manage Level Three Data page, which can also be accessed by appending /manage/payment/level-three to your URL:

Manage Level Three NMI Data


Here, you can configure level 3 data to map values from lead fields so they have data specific to the lead you’re processing a payment for:

Map Level 3 Data From Field


If there is no lead field you want to map for the default, or if you want a backup default value when the field is empty, add a value to If Empty, Insert Default:

Level 3 Default When Empty

Click Save at the bottom of the page to save all of your Level Three Defaults:


Step 8: Edit Level Three Data During Payment

Level Three Defaults can be set to make processing payments more efficient to reduce how much users need to enter when processing a merchant’s payment. However, default data may not be able to be set, or need to be updated when processing a payment. In order to do this, users can simply click Edit Level Three Data at the bottom of the Payments tab to update the Level Three values:

Edit Level Three Data


This will open a pop up where the user can input values for all of the Level Three Data fields manually:

Level 3 Data Values


Once the values are updated accordingly, click Save at the bottom of the pop-up:

Save Level 3 Data


Your IRIS CRM NMI Payment Gateway integration is now configured so you can process payments directly from IRIS CRM through NMI!

Schedule Demo