NMI
Last updated
Last updated
This article will walk you through adding your NMI gateway.
Go to Gateways | Gateway Integrations and select the NMI tile.
Select the + Activate button
Now the Create New Gateway page will appear. Double check that NMI is selected in the gateway field and fill in the rest of the info on the gateway profile.
username and password. This will be the credentials of a user within NMI that has API access enabled in the Account settings of NMI. (Permission “K”)
security_key. An alternative authentication method to username and password that has API access enabled in the Account settings of NMI. (Permission “K”)
processorId is only needed if there are multiple mids on the same gateway. This can be used so the CRM knows which mid to send the transaction to within the gateway.
Enable useRebillTxnId to use the initial transaction’s txnId to validate the rebills. With this disabled, the CRM will default to attempt to use the externalToken (rebill token) tied to that customer.
disableOrderDescription will prevent sending NMI a description of the order. If unchecked, the order product names are concatenated together and sent to NMI as the order description.
Enable RequiresExpressConsent if the mid is subject to the Express Consent guidelines mandated by Visa and MasterCard.
Enable sendDescriptor to send NMI the Gateway Descriptor assigned to the profile.
Enable disablePhone & disableEmail if you would like to not send either phone numbers or email addresses from consumers to NMI.
Enable digitalProductsOnly to send “digital” to NMI as merchant defined field 18.
Enable doNotSend3DS to not send 3DS parameters. This is most likely used on a cascade.
Enable zeroAuth to authenticate a card for zero amount. This could be a good alternative to a validate card trial. Do verify with NMI that your accounts supports this.
Enter customData to send key/value pairs to NMI on each sale. Enter key and value separated by a colon. Example color:blue. Use a new line for each entry.
Special characters on the username or password may result in authentication errors.
Customer Service
Phone #: The customer service phone number that customers should call related to this gateway.
Chargeback #: The customer service phone number for chargebacks on the gateway.
Email #: The customer service email that customers should use.
URL: A support web page related to the gateway.
Limits
Monthly Cap: This is the total volume per month that is allowed to process on the gateway. The CRM can calculate your cap usage two different ways:
The first calculation includes only gross billings against the gateway and ignores refunds (this is default).
The second calculation shows net billings and includes refunds to give the net billings for the month. You can enable the second option by enabling the Include Refunds checkbox.
Discount Rate: The discount rate associated with the processor. This a percentage of volume taken by the bank on every sale.
Transaction Fee: This is a flat rate that is charged by the gateway for each transaction.
Reserve Rate: This is a percentage on billings that the bank keeps in a rolling reserve.
Chargeback Fee: The fee paid for a chargeback. This is used to calculate expenses.
RDR Fee: The fee paid for a RDR. This is used to calculate expenses.
Trial Limits
Validate Card Amount: This is used for the Validate Card authorization type. This value determines the authorization amount ran to the gateway if the offer is using Validate Card. This can be used to authorize a card for up to $15.
Additional Options
Enabled: Whether or not to allow any sales on the gateway. When this box is deselected, no sales are allowed to process against the gateway.
Block Pre-Paid: Whether or not to allow prepaid cards to process against the gateway. If checked, prepaid cards will be blocked.
Block Debit Cards: Whether or not to allow debit cards to process against the gateway. If checked, debit cards will be blocked.
Accepted Payments
Echeck: Check this if your gateway allows eCheck transactions.
Mastercard: Check this if your gateway allows Master Cards.
Visa: Check this if your gateway allows Visa Cards.
AmEx: Check this if your gateway allowed American Express Cards.
Discover: Check this if your gateway allowed Discover.
Merchant Details
Descriptor: (Required) The descriptor that the customers will see on their bank statements. Can be used as a token on some autoresponders.
Mid#: (Required) This is the mid# for the mid. This can be found on the VAR sheet or by contacting your merchant provider.
Processor: This is the processor that the particular mid on the gateway is using.
Now Click on "Create Gateway" to save your settings.
PublicKey enables NMI native 3DS processing. Leave this blank if not using 3DS or if using a third-party for 3DS (such as PAAY). Native 3DS processing requires proper handling on pages. See for instructions (these instructions are already implemented on CheckoutChamp hosted pages).
Enable useCustomerVault if using NMI's customer vault feature.
Enable useStoredCredentials to send stored credential indicators to NMI on every sale and rebill.
Please follow for instructions on testing a new gateway.
If your tests are successful, you can now to the offers within your campaigns.
