Docs

Support
Home Billing Payments Receivables RevRec Retention
Payments
Home
Billing
Payments
Receivables
RevRec
Retention
API Reference
Release Notes
Tutorials
Frontend Capabilities
Partner SPI
API Changelog
API Reference
Release Notes
Tutorials
Frontend Capabilities
Partner SPI
API Changelog

Network Merchants Incorporated (NMI) 

This feature is a Private Beta Release. Contact Chargebee support  to enable NMI for your Test and Live site.

Introduction 

NMI (Network Merchants, Inc.)  is a leading payment gateway provider that enables secure and flexible payment processing across online, in-store, mobile, and unattended channels. NMI allows merchants to offer seamless connectivity to a wide range of processors and payment methods. Their robust API infrastructure and extensive feature set make them a reliable choice for powering customized payment experiences.

Chargebee is integrating NMI via payFURL , which is a payment orchestration platform that provides payment-related API services and specialises in payment gateway integrations.

Integration Options 

You can integrate NMI using the following:

Integration Method Description PCI Requirements
Chargebee Hosted Pages In this method, customers' card information is collected by Chargebee's checkout and directly passed on to NMI. Low (Your PCI compliance requirements are greatly reduced due to usage of Chargebee's checkout.)
Chargebee JS In this method, you can use Chargebee Components and Hosted Fields to collect the customer's card details. Low
Chargebee JS Using Permanent Token ??? a token that represents a customer's card details stored in NMI???s vault to process payments. When creating a new token and converting card details to tokens using:
Hosted Components: Low
Your own Checkout: High
Chargebee JS Via Raw Card details
You will collect raw card details via your custom checkout and pass it to Chargebee.js. 		High
Chargebee API In this method, you will have to collect card information and pass it on to Chargebee via API. Chargebee then routes this card information to NMI.

Since you will be collecting card information directly, you will have to take care of PCI Compliance requirements. 		High

Choosing NMI 

Consider the following factors before choosing NMI as a payment solution:

  • Countries supported: NMI is available for companies based in the USA.
  • Payment Methods: Chargebee currently supports only Card payments made via NMI.
  • Pricing: Contact NMI Support to know about their pricing.

Retrieve keys from your NMI account 

Follow the steps below to fetch the API Key from NMI that you will be required to enter during your gateway configuration in your Chargebee site:

  1. Login to your NMI Account.
  2. Go to Utilities > Settings.
  3. Select Security Keys.
  4. Under the Private Security Keys section, copy a private security key with API as the Source or create a new one if it doesn't exist. Keep this key safe for use in the next steps. Make sure to use the right key for the environment (use the test key in the sandbox and the live key in production).

Configuring NMI in your Chargebee site 

Follow the steps below to configure Nuvei in your Chargebee site:

  1. Login to your Chargebee site .

  2. Go to Settings > Configure Chargebee > Payment Gateways.

  3. Click Add Gateway and select NMI.

  4. Enter the API Security Key from your NMI account.

  5. Click Connect.

Configuring Card Settings 

Follow the steps below to configure Card settings for your NMI account in Chargebee:

  1. On the Configure NMI page, click Settings > Configure Chargebee > Payment Gateways > NMI. Cards are enabled by default.

  2. Click Manage in the Cards section.

  3. Configure the following settings based on your business requirements:

    • Card Verification: Chargebee verifies the customer's card before adding them. In this process, a small amount will be debited from the customer's card and will be refunded instantly. In case this authorization fails, the customer cannot add their card.
    • Always retain card information in NMI when the customer updates it: If you have configured multiple payment gateways in Chargebee, enabling this option stores the updated card information in NMI rather than the default gateway.
    • Enable 3D Secure: Enable this option if you wish to enable authentication for payments made via cards

  4. Click Save > Apply.

NMI Token Formats 

NMI offers two types of token formats:

  • Customer Vault ID only ??? NMI stores all cards in a separate vault layer and assigns each customer a unique token (Customer Vault ID) for reference.
  • Customer Vault ID + Billing ID ??? When a customer has multiple cards, NMI nests each card under the Customer Vault ID with a unique Billing ID. Referencing a specific card requires both the Customer Vault ID and Billing ID.

Functional Differences 

NMI confirms that both token formats function similarly, with no major advantages or disadvantages. However, the Customer Vault ID-only format remains the most widely used.

Chargebee???s Integration with NMI 

Chargebee integrates with NMI via PayFURL and primarily supports the Customer Vault ID-only format.

Migration Requirements 

Before migrating tokens into Chargebee, coordinate with NMI to:

  • Update the token format to Customer Vault ID only, if possible.
  • If updating isn't feasible, explore fresh token migration to NMI using the Customer Vault ID-only format.
Was this article helpful?
Loading…