Webhooks

Connect NMI payment activity to the systems your business already uses with secure, event-driven notifications.

NMI Webhooks can send an HTTPS POST notification when selected gateway events occur. Instead of repeatedly polling the gateway for changes, a compatible application can receive relevant event data and trigger the next step in a reporting, customer-service or operational workflow.

VCCP can help confirm gateway availability and coordinate the NMI account configuration. Your developer or integration provider is responsible for building, securing, testing and maintaining the receiving endpoint and the business logic that acts on each event.

Why Use Webhooks?

  • Reduce repeated polling: Receive selected updates without continuously querying the gateway.
  • Respond faster: Start a supported workflow when an event is queued for delivery.
  • Connect business systems: Pass relevant payment events into compatible reporting, support, accounting or operational tools.
  • Monitor exceptions: Alert the appropriate team when a transaction, settlement or other subscribed event needs attention.

Available Gateway Event Categories

The events available to a particular merchant depend on the gateway configuration, processor support and enabled NMI services. Common categories include:

  • Transactions: Sales, authorizations, captures, voids, refunds and credits, with supported success, failure or unknown outcomes.
  • Check status: Supported settled, returned or late-return status changes.
  • Recurring billing: New, updated or canceled plans and subscriptions.
  • Settlement: Supported successful or failed batch-settlement events.
  • Chargebacks: Available only when the connected processor supports chargeback reporting.
  • Automatic Card Updater: Supported updates involving Customer Vault or recurring-payment card records.

How an NMI Webhook Works

  1. Your developer creates a publicly accessible HTTPS endpoint with valid TLS encryption.
  2. An authorized user creates the webhook configuration and selects the desired event types.
  3. When a subscribed event occurs, NMI queues a JSON notification for delivery to the endpoint.
  4. The receiving application verifies the webhook signature before trusting or processing the payload.
  5. The application records the event, returns the expected successful response and performs the appropriate workflow.

Security and Reliability Essentials

  • Use HTTPS: NMI requires webhook URLs to begin with HTTPS and use valid TLS encryption.
  • Verify every signature: Use the signing key shown in the webhook settings to confirm the notification came from the gateway and was not altered.
  • Design for duplicate delivery: Store the unique event identifier and make processing idempotent so a retry does not repeat a business action.
  • Acknowledge promptly: Validate and record the event, return the expected successful HTTP response, and move slower work to a separate process or queue.
  • Monitor delivery: Log failures, protect the signing key, restrict administrative access and maintain an alerting and recovery process.

Merchant and Partner Configuration

Merchants can configure supported webhooks from their NMI Merchant Portal when the appropriate user permission is available. Partners and authorized affiliate users may also configure portfolio-level notifications where supported. VCCP can help identify the appropriate account path, but webhook implementation normally requires a qualified developer or integration provider.

Important Limitations

  • Webhook delivery is near real time but is not guaranteed to be instantaneous.
  • Failed deliveries may be retried, so endpoints must safely handle duplicates and temporary outages.
  • Your application should not depend on a specific retry schedule or assume events always arrive in the same order they occurred.
  • A webhook is a notification, not a substitute for authorization controls, reconciliation or verification of the current transaction record when accuracy is critical.
  • Available event types and payload fields can vary by processor, service, account configuration and future platform updates.

Related NMI Tools

NMI Webhooks Frequently Asked Questions

What is an NMI webhook?

An NMI webhook is an event notification sent by HTTPS POST to a configured endpoint when a subscribed gateway event occurs. It lets a compatible application react without repeatedly polling the gateway.

What events can NMI webhooks report?

Depending on the account and connected services, events may include transaction results, recurring-billing changes, settlement activity, electronic-check status, chargebacks and Automatic Card Updater results.

Are NMI webhooks delivered in real time?

They are designed for near-real-time notification, but delivery is not guaranteed to be instantaneous. Applications should tolerate delays, retries, duplicates and events that arrive out of order.

How should an application verify an NMI webhook?

The receiving application should use the configured signing key to verify the notification signature before trusting the payload. The endpoint should use HTTPS, protect secrets and restrict administrative access.

Why might the same webhook be delivered more than once?

A notification may be retried if the expected successful response is not received. Developers should store the event identifier and make downstream processing idempotent so a duplicate does not repeat a refund, fulfillment step or other business action.

Do I need a developer to use NMI webhooks?

Usually, yes. VCCP can help with account availability and coordination, but a qualified developer or integration provider should build, test, secure, monitor and maintain the receiving endpoint and workflow logic.


Plan the Event Before You Build the Automation

Tell VCCP which NMI events matter, which application should receive them and what the business needs to do next. We can help confirm the gateway path and coordinate with your developer or integration provider.

Availability, event support, payloads, permissions, processor compatibility, pricing and implementation requirements depend on the NMI account, connected services and integration. VCCP does not guarantee delivery timing, downstream automation or third-party system behavior.