CheckoutChamp
Submit TicketStatus
  • CheckoutChamp
  • Funnel Builder
    • Onboarding & Activation
      • Go Live Checklist
    • Dashboard Overview (APP)
    • Creating & Editing Funnels/Pages
      • Funnel Visualizer and Page Builder
        • Funnel Visualizer
          • Page Types
          • Connecting Funnel Pages
            • Route An Arrow For New And Repeat Customers
          • Edit Funnel Settings
            • Tracking Pixels
            • Offers and Upsells
            • Collections
            • Coupons
            • Configure Google Analytics
            • Gateways
            • Affiliates
              • Everflow
            • Sales Tax Profiles
            • Add Ons
              • PAAY Add On
              • Route Add On
              • ShipEngine Add On
              • Google Places
              • Fraud Manager Add On
              • Facebook Messenger
              • reCAPTCHA Enterprise
            • SMTP Accounts
            • Fulfillment Houses
            • Ship Profiles
            • Fonts
            • Payments
              • Affirm
              • Afterpay
              • Amazon Pay
              • Apple Pay
                • Legacy Apple Pay Setup (Apple Pay Plugin)
              • Multi-Pay Rebills
              • BitPay
              • Bancontact
              • BLIK
              • Boleto
              • Google Pay
              • iDEAL
              • Klarna
              • P24
              • PayPal Seamless Checkout
                • Fastlane
              • SEPA
              • Sezzle
              • TWINT
            • Social Proof
            • Maintenance
          • URL Customization
          • Page Templates
        • Page Builder
          • Builder Toolbar
            • Device View Changer
            • Popups
          • Style Manager
          • Layer Manager
            • Hiding and Revealing Elements
          • Building Blocks
            • Basic Blocks
              • Rows & Columns
            • Form Blocks
              • Shopping Cart Element
            • Button Blocks
              • Button & Link Actions
            • Product Blocks
            • Carousel / Slider Blocks
            • Icon Blocks
            • Social Media Blocks
            • Testimonial Blocks
            • Extra Blocks
            • My Element Blocks
        • 🆕Page Builder 2.0
          • 📰New Features!
          • Builder Toolbar
            • Device View Changer
            • Popups
          • Settings & Style Manager
          • Layer Manager
            • Hiding and Revealing Elements
          • Building Blocks
            • Basic Blocks
              • Rows & Columns
            • Form Blocks
              • Shopping Cart Element
            • Button Blocks
              • Button & Link Actions
            • Product Blocks
            • Extra Blocks
              • Bullet List
              • Progress Bar
              • Collapsible List / FAQ Section
              • Testimonial Blocks
              • Carousel / Slider Blocks
              • Survey
              • Timer
            • My Element Blocks
          • Page Building Tips
            • Using Shopify information on a Thank You page
            • Placeholders and Input Formats
            • Hide element if box is checked/ Billing address same as Shipping
            • How to set Anchor Links
            • How to convert a button into a link
            • Adding Age Consent
            • Creating a Split Variation
            • Subscribe & Save
            • Tokens
            • Redirect from CheckoutChamp to externally hosted upsell or Thank You page
            • Duplicate Input Indicator
            • Product Quantity Select
            • Make a button appear after a set amount of time
            • Making A New Section Appear After a Timer Expires
            • Timer - Route to next page
            • Use link or button to initiate a pop-up
            • Convert Checkbox and Radio
            • Lazy Loading
            • Element Toolbar
            • Applying custom fields to inputs
            • Shipping Profiles
            • Duplicating Pages & Funnels
            • Bootstrap Integration
            • Customer File Uploads
            • Product Tiles
            • Variant Selection
              • Product Variant Selection
              • Customized Variant Bundles (Single Variant)
              • Product Checkbox
            • Product Table
            • Hover Effects (adding Pseudo-classes)
            • Page Sizes and Image Dimensions
            • Flex Settings
            • Using the Survey Element
            • Custom Classes
            • Creating a Marketing Opt-in Checkbox
            • Common Page Elements
            • Create a Common Menu
            • Currency Selector
            • Acquire and Send Session Data to 3rd Party
            • Language Replacement Mapping
            • "Upgrade" or Replace a Product
            • Pass custom parameter on URL and store onto order
            • Product Drop Down / Select
            • Genders
            • Keep customers on Upsell Page after buying an upsell
            • Dynamic Order Bumps
            • Dynamic Upsells
            • Main Site Color
      • Adding Local HTML Files
      • Domain Configuration
        • Domain Trouble Shooting
        • DNS Troubleshooting Guide
        • Redirecting your Root (Apex) Domain
        • GDPR by Clym
      • Publishing a Funnel
      • Basic SEO
    • Redirect Storefront to CheckoutChamp
      • BigCommerce Plugin
        • BigCommerce Checkout Redirect
        • Recurring Products
      • WooCommerce Plugin
        • WooCommerce Checkout Redirect
      • Magento Plugin
      • Redirect external funnel to CheckoutChamp Checkout
      • Using Google Analytics with Redirect
    • Customer/Membership Portal
      • Customer Portal (Without Plugin)
      • Membership Portal with CustomClub Plugin
      • SSO with External Sites
    • Account Settings
      • Domain Forwarding
    • Analytics Definitions
  • CRM
    • Getting Started in your CRM!
    • CRM Dashboard
    • CRM Account Settings
      • Fraud Protection
      • CRM Subscription Page
      • Enable Automatic Cancel on Refund and Void
      • Staggered Rebills
    • Customer Section
      • Customer Service
        • Customer Service Tutorial
        • Locate a Customer Record
        • Continuity Purchase Profile
        • Refund/Void a Transaction
        • Cancel an Order
        • Cancel or Pause a Subscription
        • Restart a Subscription
        • C/S Fulfillment Actions
        • Resend emails to customers
        • Rerun a Declined New Sale
        • Merge Existing Customers
      • Order Entry
      • Fulfillment
      • Quality Assurance
    • CRM Setup
      • Product Setup
        • Product Creation
        • Product Variations
          • Variant Bundles
      • Campaign Setup
        • Creating a Campaign
        • Campaign Categories
        • Campaign Types
        • Adding a Product to a Campaign
          • Common Offer Setups
            • T-Shirt Club
        • Auto-Responder Setup
          • Autoresponder Date Formats
        • Shipping Profiles
        • Taxes
        • Campaign Coupons
        • Custom Fields
        • Adding C.O.D. to Campaigns
        • Single Transaction Orders
        • Multi-Currency
      • Call Center Setup
        • Adding and Editing Call Centers
        • Adding Call Center Agents
        • Setting Call Center Commissions
        • Batch Update Call Center Source Values
        • Cancellation Reasons, Refund Reasons, and Call Dispositions
      • Affiliate Setup
        • Adding and Editing Affiliates
        • Affiliate Tracking Link/String
        • Affiliate Pixels
          • Testing and Troubleshooting CPA Pixels
          • Testing CPC Pixels
        • Affiliate Commissions
        • Setting up an Affiliate User
        • Batch Update Affiliate Source Values
        • General External Affiliate Software/Network Setup
        • Facebook Pixel Setup (Direct API)
    • Fulfillment Section
      • Add and Editing Fulfillment House
      • Fulfillment Batch Update
      • Fulfillment Summary Report
      • Bundle Fulfillment
      • Fulfillment Statuses
      • Testing Fulfillment through Order Entry
      • Cash on Delivery setup
        • C.O.D. Order Entry Option
      • Upload Returned Orders
      • Edit Fulfillment Items
      • Fulfillment Inventory
      • Shipping Validation
    • Gateway Setup
      • Gateway List
      • Adding a Gateway
        • Testing Your Gateway Through Order Entry
      • Gateway Integrations
        • Adyen
        • Adyen V2
          • Klarna on AdyenV2
          • PayByBank on AdyenV2
          • Afterpay on AdyenV2
        • Affirm
        • Afterpay
        • Airwallex
          • Airwallex - Alternate Payments
        • Amazon Pay API Integration
        • Apple Pay
        • Authorize.net
        • Bank of America
        • BitPay
        • Braintree
        • Cardinity
        • Cardstream
          • Cardstream - Alternate Payments
        • Celerispay
        • Centrobill
        • Checkout.com
          • Checkout.com - Alternate Payments
        • Corefy
        • Easytransac
        • eMerchantPay V3
          • eMerchantPay - Alternate Payments
        • Everyware
        • Fat Zebra
        • FibonatixV2
        • FlexFactor
        • Gala Technology
          • Gala Technology - Alternate Payments
        • Google Pay API
        • HiPay 3DS
        • Innova
        • iyzico
        • Klarna
        • MARKETFLOW
        • Maverick
        • Merchant Warrior
        • MojoPay
        • Mollie
        • Moonlight Payments
        • MuchBetter
        • MyCPO
        • NMI
          • NMI - useCustomerVault Configuration
        • NomuPay
          • NomuPay - Alternate Payments
          • Klarna on NomuPay
        • OpenPath
          • IoniaPay Instant Direct Payments (OpenPath)
        • PagBrasil
        • Pathly
        • Pay.com
        • PAY.ON
        • Payex-GreenMoney
        • PayGate
        • Paynetworx
        • PayPal Commerce Checkout
          • PayPal Commerce Checkout (Direct API)
          • PayPal Commerce Checkout (Legacy)
            • PayPal Seamless Checkout - 2-Click Upsells (without Reference Transactions)
          • PayPal Commerce Checkout (SDK)
        • Paysafe V2
        • Paystrax
        • PayXpert 3DS V2
        • Pixxles
        • Poynt
        • Priority Payments
        • Quaife
        • Quantum
        • QuickPay
        • Radom
        • RocketGate
        • SafeCharge
        • Sezzle
        • Skrill
        • Solid
        • Splitit
        • Square Payments
          • Square Payments V2 (Checkout Champ builder set-up)
        • Stripe
          • Stripe - Alternate Payments
          • Klarna on Stripe
        • SurePay
        • TruCommerce
        • Trust Payments
          • Trust Payments - Alternate Payments
        • TRX
        • UrPay
        • Vantiv
        • WAAVE
        • WEBPAY
        • WhiteLabel (WL) Payments
        • WithReach
        • WorldLine (Bambora)
        • Worldline V2
          • Worldline V2 - Alternate Payments
        • Worldnet
        • Worldpay
      • Advanced Transaction Routing Interface (ATRI)
        • ATRI Algorithms
        • Cascade Profiles
        • ATRI Settings and Notifications
      • Recycle Billing
      • Standard BIN Mapping
      • PrePaid BIN Mapping
      • Decline Message Mapping
      • Dynamic Descriptors
      • RDR
      • Ethoca Refunds
      • Direct API 3DS Instructions
      • dLocal Properties
      • Zero dollar card verification
    • Reports
      • Customer Reports
        • Order Summary
        • Order Details
          • Order Statuses
        • Cancellation Report
        • Retention Report
        • Revenue Summary
        • Customer Details Report
      • Payment Reports
        • Transaction Summary Report
        • Transaction Details Report
        • Account Updater
        • Card Processing
        • Refund Details
        • Chargeback Details
        • Billing Report
        • Projected Billing
        • Sales Tax
      • Gateway Reports
        • Reserve Report
      • Sale Reports
        • Continuity Report
          • Continuity Purchase Statuses
        • Affiliate Report
      • Call Center Reports
        • Customer Service Report
      • Fulfillment Reports
        • Fulfillment Details
      • UTM Filters
      • Key Performance Indicators - KPIs
    • Admin Setup
      • Plugin Setup
      • Create a User
        • Create an Affiliate User
        • Create An API User
        • Leads Agents
      • Import
        • Import Coupons
      • Export Webhook Profiles
        • Postback Export Profiles
        • FTP Export Profile
        • Export Webhook Field Mapping Options
      • Blacklist
      • Event Logs
      • Test Cards
      • Legacy Data Import
        • CheckoutChamp PGP Encryption Procedures
        • Migrating Data From a Processor To Checkout Champ
    • Plugins
      • Accounting
        • QuickBooks Online Plugin
      • Affiliate Systems
        • Everflow Integration
        • Trackfiliates
      • Analytics and Reporting
        • Wicked Reports
      • Authentication
        • PAAY
          • Authenticating with PAAY 3DS on Landers
        • PAAY 3RI
      • Chargeback Management
        • Fraud Deflect
        • Ethoca
        • Midigator
        • Optimal Alerts
        • ChargebackHelp
      • Data Sources
        • Big Commerce
          • BigCommerce Checkout Redirect
        • Smarty
        • ClickBank
        • Facebook Marketplace
        • FFL Scope
        • FluidPay Account Updater
        • Google Shopping
        • Gorgias
        • HubSpot
        • Listrak
        • OpenBorder
        • Paperform
        • Re:amaze
        • Recharge
        • ShipEngine
        • Shopify
          • Use Shopify Products Without Shopify Redirect
          • Octane AI
        • Triple Whale
        • WooCommerce
          • Using WooCommerce Catalog with Checkout Page
        • Zapier
        • Zendesk
        • DataDojo
        • ViralSweep
      • Debt Collection
      • Email Service Providers
        • Email Service Provider Plugins
        • Email Service Provider General Set Up
        • Active Campaign Deep Integration
        • InboxFirst
        • Klaviyo
        • Constant Contact
        • SendLane
        • Infusionsoft/Keap
        • Sendgrid
        • Ontraport
        • TxtFlo
        • Postscript
        • Maropost
        • Mailchimp
        • ConvertKit
        • Attentive
      • Express Consent
        • Expressed Consent
        • Expressed Consent CRM Configuration
        • Expressed Consent Guidelines
      • FlexPay
      • Fraud Services
        • Fraud Manager
        • Kount Enterprise
        • Device Data Collector Pixel (DDC Pixel)
        • IPQS
        • NoFraud
      • Fulfillment Houses
        • General Fulfillment House Setup
        • AliExpress
        • Amware
        • CJ Dropshipping
        • DesktopShipper
        • FTP Fulfillment Option
        • Fulfillment by Amazon
        • mintsoft
        • ShipBob
        • Shiphero
        • ShipStation
        • Save Rack
        • Store Pickup
        • Pharmacy Hub
        • Promise Pharmacy
      • Identity Verification
        • 1account
        • AgeChecker.net
        • ID.me
      • IVR Systems
      • List Management Services
        • Red Crane Media
        • Sociallity
      • Membership Services
        • Circle.so Webhook Guide
        • General Membership Club Plugin Setup
        • CustomClub
        • MemberMouse
        • Kajabi Webhook Guide
      • Phone Switches
        • ViciDial
        • Ytel
        • Five9 Sales Agent Call Pop
      • Rewards
        • LoyaltyLion
        • Stamped
      • RMA Services
      • Sales Call Tracking Services
      • Shipping Services
        • InsureShip
        • Route
      • SMS
        • ClickSend (Data Shuttle)
        • Twilio SMS Setup
        • SendPlex SMS Plugin
      • SMTP Maintenance
        • SMTP Maintenance Setup
        • Sendgrid SMTP Profile
        • Maropost SMTP Profile
        • Gmail SMTP Profile
      • Tax Services
        • Avalara Tax
          • Enabling and Setting Up the Avalara AvaTax Plugin
          • Add Avalara Tax to a Campaign
          • Add Tax Code to Products
          • Add Freight Tax to Shipping
          • Avalara Tax - Order Entry
        • Interpayments
        • TaxJar
          • Add TaxJar to Campaigns
          • Add Tax Code to Products
          • Add Freight Tax Code to Shipping
          • TaxJar Address Verification- Customer Service/ Order Entry
          • TaxJar Support Page
      • Telehealth
        • Beluga EHR
      • Upsell
        • Integrated Upsell Program
    • Frequently Asked Questions (FAQS)
      • General CRM Questions
      • Order Processing Questions
      • Fulfillment Questions
      • Reporting Questions
      • Affiliate Tracking Questions
      • Developer Questions
      • Builder Questions
      • How-to articles
        • Force Bill a Purchase
        • Submit a Support Ticket
    • Click-to-Cancel
  • API Documentation
    • API Documentation
      • Recommended API Flow
      • Performing API Calls
  • Policies
    • EULA
    • Privacy Policy
    • Acceptable Use Policy
    • Billing Policy
    • GDPR
    • A-C&B
Powered by GitBook
On this page
  • Step 1 - Activate NMI
  • Step 2 - Add NMI credentials
  • Step 3 - Fill the rest of the gateway profile
  • Step 4 - Test the newly added gateway
  • Step 5 - Apply to live campaign offers
  • Decline References
  1. CRM
  2. Gateway Setup
  3. Gateway Integrations

NMI

PreviousMyCPONextNMI - useCustomerVault Configuration

Last updated 2 months ago

LogoLogo

CheckoutChamp Links

  • Website Builder
  • CRM
  • Status
  • Need more help?

Refer a Friend

  • Referral Program

No account yet?

  • Schedule Sales Demo

This article will walk you through adding your NMI gateway.

  • Step 1 - Activate NMI

  • Step 2 - Add NMI credentials

  • Step 3 - Fill the rest of the gateway profile

  • Step 4 - Test the newly added gateway

  • Step 5 - Apply to live campaign offers

  • Decline References


Step 1 - Activate NMI

Go to Gateways | Gateway Integrations and select the NMI tile.

Select the + Activate button

Step 2 - Add NMI credentials

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.

  • 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 here for instructions (these instructions are already implemented on CheckoutChamp hosted pages).

  • 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 useCustomerVault if using NMI's customer vault feature. See more

  • Enable useStoredCredentials to send stored credential indicators to NMI on every sale and rebill. See more

  • 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.

Step 3 - Fill the rest of the gateway profile

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.

Please review all information for accuracy before creating the new gateway.

Step 4 - Test the newly added gateway

Please follow this article for instructions on testing a new gateway.

Step 5 - Apply to live campaign offers

If your tests are successful, you can now apply the gateway to the offers within your campaigns.


Decline References

https://support.nmi.com/hc/en-gb/articles/360033116632-Bank-Errors-and-Declines

https://support.nmi.com/hc/en-gb/articles/360033371552-Processor-Errors