NMI is a gateway that allows you to collect card and eCheck payments. This guide is intended to help you implement NMI based on your preferred integration workflow.

Services and compatibility

Gateway-specific information

• NMI supports the Address Verification Service (AVS) feature.
• NMI supports the Security code verification feature.
• NMI supports terminal transactions: Configuring your terminal for NMI
• NMI supports adding a surcharge amount to a transaction.
  • This feature is for merchants who want to pass on the cost of credit card acceptance to the customer.
  • This is only supported for transactions with cards issued from the United States.
  • The surcharge can only be used with a sale transaction and not with an auth-only to capture workflow.
• NMI support of void and refund includes card or echeck transactions.

Configuration

Work with Integrations Support to add NMI as a connection. You will need the following credentials from NMI:

• username
• password
• processor ID

OR

• security key
• processor ID

📘

Note

If you will be using cloud-based terminals with NMI, you must provide the security key and processor ID values.

Required and optional fields

The following table shows the optional fields for NMI transactions in the Create one-time-use token or Run card transaction request.

Example requests

The following is an example Run card transaction request for NMI.

curl -X POST https://api.nexiopaysandbox.com/pay/v3/process \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'
  -d '{
  "data": {
    "amount": 4.00,
    "surcharge": 1.50,
    "descriptor": {
    	"name": "Our Company Name",
			"address": "123 Main St.",
			"city": "New York City",
      "state": "NY",
      "postal": "10001",
      "country": "US",
      "phone": "1555555555",
      "url": "https://your-ecommerce-website.example.com",
      "merchantId": "1234",
      "mcc": "5964"
		}
  },
  "paymentMethod": "card",
  "tokenex": {
		"token": "eb50a022-d6de-4244-a1e6-dcb8522b2d19"
  }
}'

The following is an example Run echeck transaction request for NMI.

curl -X POST https://api.nexiopaysandbox.com/pay/v3/processECheck \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'
  -d '{
  "data": {
    "amount": 4.00,
    "currency": "USD"
  },
  "tokenex": {
		"token": "eb50a022-d6de-4244-a1e6-dcb8522b2d19"
  }
}'

Testing data

If you do not have Advanced Testing Triggers enabled on your account, use the following test cards to test your NMI configuration.

If you do have Advanced Testing Triggers enabled on your account, use the following test cards to test your NMI configuration.

Testing terminal transactions

NMIs testing workflow uses the same card information for every transaction. Change the amount value in order to create different testing situations:

Status workflows

The status of a successful transaction with NMI varies, depending on the options you choose.

*Pending status displays as "authorized" or "AUTHORIZED" in the Nexio Dashboard; it displays as 10, meaning "authorized", in the response when querying transactions (for more information about transactionStatus, see the appropriate transactionStatus table).

If you have any additional questions or feedback, contact us.

See also

• Getting started with ecommerce
• Getting started with retail
• 3D Secure overview
• Using a third-party 3DS provider to run transactions
• Recurring billing overview
• View surcharge recommendation
• Sandbox environments
• Address Verification Service (AVS)
• Security code verification
• Register terminal
• Deregister terminal
• How to Set Up Your New NMI Swiper
• NMI Sale, Void and Refund