Overview
NMI TurboApp Boarding allows you to create an NMI gateway account at the same time you board a merchant to a processor in TurboApp.
This eliminates the need for users to return after merchant approval and separately board the NMI gateway using the existing NMI boarding integration through the Helpdesk. By incorporating NMI gateway creation directly into TurboApp, Merchant Central can further automate merchant onboarding and help reduce the time it takes merchants to begin processing.
While boarding a merchant through TurboApp, users can enable NMI Boarding. Merchant Central automatically populates the NMI Boarding step with information from the corresponding lead and TurboApp application.
After the application is submitted, Merchant Central holds the gateway creation request while the processor reviews the merchant application. Once the merchant is approved and a MID is generated, Merchant Central automatically adds the MID to the gateway request and creates the NMI gateway.
Prerequisites
Before using NMI TurboApp Boarding, make sure you have:
- An NMI reseller account.
- Access to your NMI reseller login URL.
- An NMI V4 API security key.
- Access to the NMI integration settings in Merchant Central.
- TurboApp configured for the processor you want to use for merchant boarding.
How does NMI TurboApp Boarding work?
NMI TurboApp Boarding connects the merchant boarding workflow in TurboApp with NMI gateway creation.
When NMI Boarding is enabled, Merchant Central uses information already entered on the lead and TurboApp application to populate the NMI Boarding step. This allows users to review the gateway information as part of the same merchant application workflow.
After the merchant application is submitted, the gateway creation request is held while the processor reviews the application. The NMI gateway is not submitted immediately.
Once the processor approves the merchant and generates the MID, Merchant Central adds the MID and any other required information to the gateway request and automatically submits the gateway creation request to NMI.
Merchant Central also automatically creates an NMI Create Gateway Account Helpdesk ticket and links it to the boarded merchant, providing an audit trail of the gateway data submitted through TurboApp.
Enabling NMI TurboApp Boarding
Before NMI Boarding can be used in TurboApp, connect your NMI reseller credentials to Merchant Central. You can then choose whether NMI Boarding should be enabled by default for individual processors.
Connecting NMI Reseller Credentials
If your NMI reseller credentials are not already connected to Merchant Central, follow these steps.
- Log in to your NMI gateway account and note the login URL. The URL should use the following format: https://yourcompany.transactiongateway.com/resellers.
-
Generate your API Key by navigating to Settings → Security Keys.
Enter a Key Name, select your user and the V4 API permission, and click Create a New Key.
After the key is generated, locate it in the list of current security keys. Click Copy next to the key to copy it to your clipboard.
- Return to Merchant Central and navigate to Manage → Integrations and click NMI - Boarding & Reporting.
-
On the New Account page, enter the credentials for the NMI reseller account.
You can enable multiple reseller accounts if needed. Enter the account name, reseller login URL, and API key. If you are adding multiple accounts and this account should be the default, select Is Default.
Click Test API Key.
-
If the credentials are correct, Merchant Central displays a confirmation message in the top-right corner.
Click Create New Account to add the reseller account.
The account is created and appears in the NMI Reseller Account dropdown.
Enable NMI Boarding by Default
NMI Boarding can be enabled by default on a processor-by-processor basis from the TurboApp Default Values page.
- Open the TurboApp Default Values page.
- Select the processor you want to configure in the top-right corner.
- Select the Rates & Fees tab.
- Scroll down until you see the purple Enable NMI Gateway After Approval banner.
- Select the checkbox to enable NMI Boarding by default for applications boarded to the selected processor.
If the checkbox is not selected, users can still enable NMI Boarding on individual applications manually.
Mapping Lead Fields to NMI Gateway TurboApp Fields (beta)
Instead of relying on hard-coded field defaults, ISOs can choose which lead fields populate NMI Gateway boarding values. This makes NMI Gateway onboarding more configurable and automated while supporting partners with multiple sub-affiliates and complex pricing models.
By using customizable field mappings alongside Gateway Boarding Profiles, Merchant Central can populate the appropriate gateway settings during either manual or automated boarding. This helps reduce manual configuration and eliminates the need to update gateway settings after a merchant has been created.
To map your NMI Gateway fields, follow the steps below:
- Open the side navigation panel on the left.
- Navigate to Manage → TurboApp, then click Field Mappings.
- On the Field Mappings page, select the appropriate processor from the dropdown menu in the top-left corner.
- Open the NMI Gateway tab. For each TurboApp gateway field, select the corresponding lead field from the middle column. The field mappings are saved automatically.
How to use NMI Boarding in TurboApp
When NMI Boarding is enabled by default for the selected processor, users see an NMI Boarding step at the top of the TurboApp application.
How to enable NMI Boarding for an individual application
If NMI Boarding is not enabled by default for the selected processor, it can still be enabled for an individual application.
- Open the Rates & Fees step of the TurboApp application.
- Select Enable NMI Gateway After Approval.
- After the option is enabled, the NMI Boarding step is displayed in the application.
How to review NMI Boarding data
When you reach the NMI Boarding step, Merchant Central automatically populates its fields using information entered on the lead and TurboApp application. Changes made to the application are reflected in the NMI Boarding step while the data remains synchronized.
If you manually change data on the NMI Boarding step, those changes are not synchronized back to the corresponding fields in earlier TurboApp steps. Data only flows from the application into the NMI Boarding page.
After NMI data has been manually changed, subsequent changes made on another TurboApp step will no longer synchronize to the changed NMI data.
The NMI Boarding information is also included on the Review step so users can verify the application and gateway data before submitting the application.
How to submit the application
Submit the TurboApp application as normal. Merchant Central then handles the gateway account creation process alongside the merchant boarding workflow.
The gateway request remains queued while the processor reviews the application. Once the merchant is approved and the MID is generated, Merchant Central automatically submits the gateway creation request to NMI.
How to track NMI TurboApp Boarding submissions
After a merchant application has been boarded, you can monitor the NMI Boarding status alongside the TurboApp application status on the main TurboApp Applications and Submitted Apps pages.
TurboApp Applications page
Submitted Apps page
How to cancel NMI Boarding
If NMI Gateway Boarding was included with an application but you no longer want to create the gateway, you can cancel the NMI request while the merchant application is still in process.
- Locate the application on the TurboApp applications page.
- Open the application's Actions column.
- Click Cancel NMI Boarding.
Canceling NMI Boarding affects only the NMI gateway request. It does not cancel or otherwise affect the merchant application.
NMI Boarding cannot be canceled after the merchant application is complete.
How the NMI Helpdesk ticket works
Once the merchant is approved and the MID is generated, Merchant Central adds the MID and any other required data to the NMI gateway request.
Merchant Central also automatically generates the NMI Create Gateway Account Helpdesk ticket and links it to the boarded merchant. This creates an audit trail containing the gateway data submitted through TurboApp.
Because a Helpdesk ticket is created, users can configure their notifications to receive a Helpdesk ticket notification when the gateway has been created.
Frequently Asked Questions
- Can I connect more than one NMI reseller account? Yes. Merchant Central supports multiple NMI reseller accounts. When adding an account, you can select Is Default if that account should be used as the default.
- Do I have to enable NMI Boarding by default? No. If NMI Boarding is not enabled by default for a processor, users can enable Enable NMI Gateway After Approval on the Rates & Fees step of an individual TurboApp application.
- When is the NMI gateway created? The gateway creation request is held while the processor reviews the merchant application. Once the merchant is approved and the MID is generated, Merchant Central adds the required information and submits the gateway creation request to NMI.
- Does changing information on the NMI Boarding step update the earlier TurboApp steps? No. Data flows from the lead and TurboApp application into the NMI Boarding step, but changes made directly on the NMI Boarding step do not synchronize back to earlier TurboApp fields.
- What happens to synchronization after I manually edit NMI Boarding data? Once NMI data has been manually changed, updates made on another TurboApp step will no longer synchronize to the changed NMI data.
- Can I cancel NMI Boarding after submitting an application? Yes, while the merchant application is still in process. Click Cancel NMI Boarding from the application's Actions column. NMI Boarding cannot be canceled after the merchant application is complete.
- Does canceling NMI Boarding cancel the merchant application? No. Canceling NMI Boarding affects only the NMI gateway request and does not affect the merchant application.
- Is a Helpdesk ticket still created when using NMI TurboApp Boarding? Yes. Merchant Central automatically creates the NMI Create Gateway Account Helpdesk ticket and links it to the boarded merchant, providing an audit trail of the gateway data submitted through TurboApp.
Video Tutorial
Watch the following tutorial for an overview of NMI TurboApp Boarding.