Customers who are utilizing the NMI Gateway can view the gateway reporting data directly in the CRM on the Merchant Details page.
The gateway reporting data includes the merchants' account, pricing, and transactions data as well as residuals data.
Additionally, the reporting integration adds a page called My Gateway (under the My Merchants menu) where all of the gateways are listed including the MIDs linked to each gateway.
Continue reading to learn how to enabled the NMI Gateway Reporting on your site.
NMI Gateway Reporting Permissions
To see the NMI Gateway Reporting information you'll need to enable the following permissions, which are available for any user class including Merchant:
Add Your NMI API Account
Once the NMI Gateway settings and permissions are enabled, you'll need to add an NMI API account in the CRM. If you already have it added for boarding, you can skip this part.
For this purpose you'll need your NMI Reseller Login URL (typically https://secure.nmi.com) and the NMI Reseller API Key.
To generate the API key log into secure.nmi.com and click the Security Keys link under Settings:
Then select the V4 Api permission and create the key:
Once you have the key navigate to Manage > Integrations > NMI, and add your new account:
Note: By default, the API will provide your accounts, but not those of your sub-affiliates unless you contact NMI Gateway support and have them enable "Reseller Has The Ability To Turn On Recursive Affiliate Reports".
Once the account is added you will be able to find and select it in the scheduled task settings that are used to retrieve NMI Gateway data.
Retrieve NMI Gateway Account Data
To retrieve the merchants' NMI Gateway account data including the pricing information you'll need to scheduled the task to retrieve the account info each day.
1. Navigate to Manage > Site Options > Scheduled Tasks
2. Click Add Task, and select the 'NMI Gateway Reporting - Get Merchant's Account Information' task shown in the below screenshot:
3. When setting up the task, be sure to specify the NMI API account or accounts (created in the previous step) that will be used to pull data from NMI.
4. Once the task is enabled the NMI Gateway tab will be displayed in a new tab on the Merchant details page:
5. You should also run the task so the account information is pulled in without having to wait until the next day. Do this by clicking Manually Queue Task and selecting "NMI Gateway Reporting - Get merchant's Account Information" task:
Note: The Gateway tab's visibility can be managed on the "Manage Processor Tabs" page.
While the NMI Gateway account info is updated on a schedule, the transaction data is fetched in real-time when a user opens the Gateway tab. You can change the date range to look at more transactions, up to 3 years in the past. The My Gateway page shows live processing totals for all of your gateway accounts.
Retrieve NMI Residuals
To retrieve residuals a second background task called 'NMI Gateway Reporting - Import Residuals' needs to be scheduled.
For this task you need to specify the NMI API account, and the Processor to which the data will be loaded:
In case there are several active NMI Accounts and commission reports from these accounts, they can be imported into different Processors. It is possible to schedule several tasks, one for each additional Processor.
This may be done if you are provided multiple commission reports across multiple NMI accounts due to region (for example a CAD commission report for NMI Account 1 and a US report for NMI Account 2).
If commission reports are being imported for the first time, then the system automatically creates a residuals mapping for them:
If a user has created a custom mapping for the report then the system automatically defaults to the last used mapping.
Note: The merchant ID is determined by Gateway ID from the report. All records with an unknown (empty) merchant ID will be skipped.
My Gateway Page
The My Gateway page displays a list of your gateway accounts including linked MIDs, account info, and processing totals as seen in the NMI portal.
The page can be accessed via the My Merchants > My Gateway menu:
Here is an example of the page:
In the top-right corner you can filter the gateway accounts by date range, group, and assigned users (based on the linked merchant):
The applied filter is displayed in the top-left corner, and the sliding transaction overview tiles show the totals for the selected filters:
Within the report table you can use the search box to find a gateway account faster and export the information to a CSV file:
Use the horizontal scrollbar at the bottom of the table to view all of the gateway information such as pending authorizations, charges, refunds, voids, etc. The processing totals are retrieved when the page loads, so everything is current.
The Linked MID column shows the merchant(s) to which the gateway account is tied. If the MID matches a merchant in your site, it will be clickable and open in a new tab.