Setting up NMI integration

Overview

This article explains how to connect your NMI Payment Gateway to gaiia. You’ll need to create security keys in NMI, set up a webhook, and then configure the integration in gaiia.

Step 1: Gather your NMI credentials

Private and public security keys

gaiia requires both a Private Security Key and a Public Security Key to process payments through NMI.

1. Log in to your NMI Payment Gateway instance
2. Click on My Settings in the top menu
3. Select Security Keys
4. Click Add a New Private Key
   1. Key Name: For example, “gaiia NMI Integration”
   2. Username: Your NMI username
   3. Key Permission: Check API
5. Click Create to save
6. Scroll to Public Security Keys and click Add a New Public Key
   1. Key Name: Same format as private key
   2. Username: Your NMI username
   3. Key Permission: Select Tokenization
7. Click Create to save

Make sure to copy both keys. You’ll need them later to complete the integration in gaiia.

Webhook setup

Webhooks allow gaiia to receive real-time payment updates from NMI, including returns and chargebacks.

1. Click on My Settings in the top menu
2. Select All Settings
3. Scroll to the Transaction Options section and click Webhooks
4. Click Create
5. Use the following settings:
   1. URL: https://6bpu8a02c8.execute-api.us-east-1.amazonaws.com/production/on-nmi-webhook-event?billingSettingsId=YOUR_BILLING_ID
      

      Your gaiia billing setting ID can be found under Settings (Admin) → Billing → Currency Settings → Other settings.

   2. Available Events:
      • transaction.check.status.latereturn
      • transaction.check.status.return
      • transaction.check.status.settle
      • transaction.void.success
6. Click Save Changes 

Make sure to copy the Signing Key displayed in the Endpoints area. It will also be required when connecting NMI in gaiia.

Step 2: Configure NMI in gaiia

1. Go to the Admin Settings menu
2. Select Integrations, then go to the App Directory tab
3. Find NMI under the Payments category and click Install
4. Select the payment types you'll be accepting and click Next
5. Enter the following:
   • Private Security Key
   • Public Security Key
   • Webhook Signing Key
6. Click Connect to finish setup

Once connected, you can begin processing payments and receiving updates through the NMI gateway.