NMI
On this page
This topic explains how to configure NMI as a third party payment provider in StoreConnect, for standard checkout use.
This integration does not currently support subscription payments, Google Wallet, Apple Pay, or 3DS.
What you need
- An NMI account set up with an embedded payment component
- Minimal code and admin know-how
Get credentials from NMI
NMI provides credentials that you can use in the API key and API secret fields in the StoreConnect config. They also provide unique keys for testing the integration in a sandbox.
NMI sandbox credentials
- Sign into your NMI account.
- Go to My Sandbox Keys.
- Copy the following keys:
- Private Security Key for api (Payment and Query APIs)
- Partner key (for gateway).
NMI production credentials
When you set up the embedded payment component in NMI, you will be provided with credentials for use in production.
Configure NMI in StoreConnect
- Open StoreConnect and go to Settings > Payments > Payment providers.
- Select New. Complete the fields as follows, then Save:
| StoreConnect field | Select or enter |
|---|---|
| Name | NMI or NMI - test (for sandbox) |
| Provider | Select NMI from the list |
| API Mode | sandbox or production |
| API Key | Value not required |
| API Secret | Private Security Key (Payment and Query APIs). E.g., mK9vXpL2nQwR7jHsY4cTbF6uAeZ3dGiN |
| API Options | gateway_key = <Partner Key for Gateway> |
Configure a custom gateway endpoint
NMI reseller gateways — for example, Pinnacle Bank — host merchant accounts on their own API endpoints rather than NMI’s default infrastructure. To connect to a reseller gateway, add a gateway_host option to the API Options field on the Payment Provider record.
Add the following line alongside your existing gateway_key entry:
gateway_host = <your-reseller-gateway-hostname>
For example:
gateway_host = secure.pinnaclebankpayments.com
The gateway_host value is the fully-qualified domain name of the reseller’s gateway. StoreConnect uses this host for all API calls and for loading the Collect.js tokenization script. When gateway_host is not set, StoreConnect falls back to NMI’s default endpoints (sandbox.nmi.com in sandbox mode, secure.nmi.com in production).
:::note Contact your NMI reseller for the correct gateway hostname. This value is specific to each reseller’s infrastructure and cannot be found in the standard NMI documentation. :::