> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/connectors-integrations/payment-processor-capabilities/available-connectors/nmi.md).

# NMI

Accept card and wallet payments through NMI on Hyperswitch, with mandates, refunds, and manual capture.

NMI handles card payments and Apple Pay and Google Pay wallets through Hyperswitch, with mandates, refunds, and manual capture across the board, and optional 3DS on cards. The integration is live.

### Status and capabilities

**Integration status:** live

**Category:** payment gateway

**Webhook flows:** payments, refunds

| Payment method | Type        | Mandates  | Refunds   | Capture methods                         | 3DS                 | Card networks                                                                                                | Countries | Currencies |
| -------------- | ----------- | --------- | --------- | --------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------ | --------- | ---------- |
| card           | Credit Card | supported | supported | automatic, manual, sequential automatic | supported, optional | American Express, Cartes Bancaires, Diners Club, Discover, Interac, JCB, Maestro, Mastercard, UnionPay, Visa | 98        | 160        |
| card           | Debit Card  | supported | supported | automatic, manual, sequential automatic | supported, optional | American Express, Cartes Bancaires, Diners Club, Discover, Interac, JCB, Maestro, Mastercard, UnionPay, Visa | 98        | 160        |
| wallet         | Apple Pay   | supported | supported | automatic, manual, sequential automatic | not applicable      | -                                                                                                            | 96        | 160        |
| wallet         | Google Pay  | supported | supported | automatic, manual, sequential automatic | not applicable      | -                                                                                                            | 96        | 160        |

### Webhooks

Use NMI webhooks to keep payment and refund statuses updated in Hyperswitch after NMI sends transaction updates. Keep webhooks enabled for the Hyperswitch endpoint used by your account. See your NMI account settings for where to configure the endpoint.

NMI handles 10 event names that follow `transaction.<type>.<result>`, where `<type>` is `sale`, `auth`, `capture`, `void`, or `refund`, and `<result>` is `success` or `failure`.

| NMI event                     | Effect in Hyperswitch          |
| ----------------------------- | ------------------------------ |
| `transaction.auth.failure`    | Payment authorization fails    |
| `transaction.auth.success`    | Payment authorization succeeds |
| `transaction.capture.failure` | Payment capture fails          |
| `transaction.capture.success` | Payment capture succeeds       |
| `transaction.refund.failure`  | Refund fails                   |
| `transaction.refund.success`  | Refund succeeds                |
| `transaction.sale.failure`    | Payment fails                  |
| `transaction.sale.success`    | Payment succeeds               |
| `transaction.void.failure`    | Payment cancellation fails     |
| `transaction.void.success`    | Payment is cancelled           |

Any other event, including the `unknown` variants, is acknowledged without changing a status. Event names are defined in [`NmiWebhookEventType`](https://github.com/juspay/hyperswitch/blob/d3c487e91c4f492e8839838966cce47ff12dc648/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs#L1791-L1825), and mapped by [`get_nmi_webhook_event`](https://github.com/juspay/hyperswitch/blob/d3c487e91c4f492e8839838966cce47ff12dc648/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs#L1827-L1851).

Hyperswitch verifies the `webhook-signature` header before processing NMI webhooks in [`IncomingWebhook for Nmi`](https://github.com/juspay/hyperswitch/blob/d3c487e91c4f492e8839838966cce47ff12dc648/crates/hyperswitch_connectors/src/connectors/nmi.rs#L943-L1001).

### Source reference

Connector implementation: [`crates/hyperswitch_connectors/src/connectors/nmi.rs`](https://github.com/juspay/hyperswitch/blob/d3c487e91c4f492e8839838966cce47ff12dc648/crates/hyperswitch_connectors/src/connectors/nmi.rs).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hyperswitch.io/integrations/connectors-integrations/payment-processor-capabilities/available-connectors/nmi.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
