NMI Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
NMI
Services that work with Spreedly:
  • NMI
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, Store, General Credit
Supported payment types:
Credit Card, Bank Account
Spreedly 3DS2 Global Supported
Yes
Gateway Specific 3DS1 Supported
No
Gateway Specific 3D2 Supported
No
Regions:
North America
API endpoint URL:
https://secure.nmi.com/api/transact.php

Authentication and Security

Specific names for credentials:
Login, Password

Onboarding Merchants in:

Adding an NMI gateway

To add a NMI gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>nmi</gateway_type>
        <login>login</login>
        <password>password</password>
      </gateway>'

<gateway>
  <token>1QFz4bb2zzFKd4ktJyFnhHn7qxm</token>
  <gateway_type>nmi</gateway_type>
  <name>NMI</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <login>login</login>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">true</supports_authorize>
    <supports_capture type="boolean">true</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">true</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_adjust type="boolean">false</supports_adjust>
    <supports_verify type="boolean">true</supports_verify>
    <supports_reference_purchase type="boolean">false</supports_reference_purchase>
    <supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
    <supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
    <supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
    <supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
    <supports_3dsecure_2_mpi_purchase type="boolean">true</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">true</supports_3dsecure_2_mpi_authorize>
    <supports_store type="boolean">true</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_network_tokenization type="boolean">false</supports_network_tokenization>
    <supports_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
  </characteristics>
  <credentials>
    <credential>
      <name>login</name>
      <value>login</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>sec_code</gateway_specific_field>
    <gateway_specific_field>recurring</gateway_specific_field>
    <gateway_specific_field>customer_vault_id</gateway_specific_field>
    <gateway_specific_field>customer_id</gateway_specific_field>
    <gateway_specific_field>vendor_id</gateway_specific_field>
    <gateway_specific_field>processor_id</gateway_specific_field>
    <gateway_specific_field>tax</gateway_specific_field>
    <gateway_specific_field>shipping</gateway_specific_field>
    <gateway_specific_field>ponumber</gateway_specific_field>
    <gateway_specific_field>descriptors</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_1</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_2</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_3</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_4</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_5</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_6</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_7</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_8</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_9</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_10</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_11</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_12</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_13</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_14</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_15</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_16</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_17</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_18</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_19</gateway_specific_field>
    <gateway_specific_field>merchant_defined_field_20</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>bank_account</payment_method>
    <payment_method>third_party_token</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <sandbox type="boolean">false</sandbox>
  <created_at type="dateTime">2021-10-14T08:48:06Z</created_at>
  <updated_at type="dateTime">2021-10-14T08:48:06Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:nmi, login: "Your login", password: "Your password")


#<Spreedly::Gateway:0x00007f83e1a86a80
@token="YUq5lYpG2ZWaq0wOnKjs6LCBnVH",
@created_at="2020-01-23T20:32:27Z",
@updated_at="2020-01-23T20:32:27Z",
@gateway_type="nmi",
@state="retained",
@name="NMI",
@credentials={"login"=>"Your login"}>

Third-party 3D Secure 2 Auth Data

Spreedly will automatically handle the field mapping for sending third-party 3DS2 authentication data to NMI. For more information about how to use this feature, see the 3DS2 Third-party Authentication Guide. Spreedly fields map to the relevant NMI fields as described in the following table. Please see NMI’s transaction variable documentation for detailed descriptions of each of these fields and when to use them.

Spreedly Field NMI Field
three_ds_version three_ds_version
authentication_response_status cardholder_auth
authentication_value cavv
directory_server_transaction_id directory_server_id

Note: NMI uses the cardholder_auth field to determine the eci value at the gateway level. Spreedly maps a Y status in authentication_response_status to verified and all other status values to attempted.

Gateway specific fields

When interacting with an NMI gateway to run transactions, there are some gateway specific fields you can specify when making a purchase or authorize call.

By default, if a card has already been used successfully, the request’s billing_method flag is set as recurring, otherwise it is not sent. If you wish to override this, you can specify the recurring gateway specific field as false to not send the billing_method field, or as true to ensure that it is sent.

When sending stored credential data, the stored_credential_reason_type you provide will override the recurring option if there is a conflict between them (e.g. specifying recurring to true but stored_credential_reason_type to anything other than recurring will override the value or even presence of the billing_method field).


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
          <nmi>
            <sec_code>PPD</sec_code>
            <recurring>true</recurring>
            <customer_vault_id>The customer vault id</customer_vault_id>
            <customer_id>The customer id</customer_id>
            <vendor_id>The vendor id</vendor_id>
            <processor_id>The processor id</processor_id>
            <tax>Total tax amount</tax>
            <shipping>Total shipping amount</shipping>
            <ponumber>Original purchase order</ponumber>
            <descriptors>
              <descriptor>The payment descriptor</descriptor>
              <descriptor_phone>The payment descriptor phone</descriptor_phone>
              <descriptor_address>The payment descriptor address</descriptor_address>
              <descriptor_city>The payment descriptor city</descriptor_city>
              <descriptor_state>The payment descriptor state</descriptor_state>
              <descriptor_postal>The payment descriptor postal code</descriptor_postal>
              <descriptor_country>The payment descriptor country</descriptor_country>
              <descriptor_mcc>The payment descriptor mcc</descriptor_mcc>
              <descriptor_merchant_id>The payment descriptor merchant id</descriptor_merchant_id>
              <descriptor_url>The payment descriptor url</descriptor_url>
            </descriptors>
          </nmi>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2021-10-14T08:48:04Z</created_at>
  <updated_at type="dateTime">2021-10-14T08:48:04Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>YJEzV2Mwyb36XuVonNP58oVkqaA</token>
  <transaction_type>Purchase</transaction_type>
  <order_id nil="true"/>
  <ip nil="true"/>
  <description nil="true"/>
  <email nil="true"/>
  <merchant_name_descriptor nil="true"/>
  <merchant_location_descriptor nil="true"/>
  <merchant_profile_key nil="true"/>
  <gateway_specific_fields>
    <nmi>
      <sec_code>PPD</sec_code>
      <recurring>true</recurring>
      <customer_vault_id>The customer vault id</customer_vault_id>
      <customer_id>The customer id</customer_id>
      <vendor_id>The vendor id</vendor_id>
      <processor_id>The processor id</processor_id>
      <tax>Total tax amount</tax>
      <shipping>Total shipping amount</shipping>
      <ponumber>Original purchase order</ponumber>
      <descriptors>
        <descriptor>The payment descriptor</descriptor>
        <descriptor_phone>The payment descriptor phone</descriptor_phone>
        <descriptor_address>The payment descriptor address</descriptor_address>
        <descriptor_city>The payment descriptor city</descriptor_city>
        <descriptor_state>The payment descriptor state</descriptor_state>
        <descriptor_postal>The payment descriptor postal code</descriptor_postal>
        <descriptor_country>The payment descriptor country</descriptor_country>
        <descriptor_mcc>The payment descriptor mcc</descriptor_mcc>
        <descriptor_merchant_id>The payment descriptor merchant id</descriptor_merchant_id>
        <descriptor_url>The payment descriptor url</descriptor_url>
      </descriptors>
    </nmi>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>64</gateway_transaction_id>
  <gateway_latency_ms type="integer">0</gateway_latency_ms>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <warning nil="true"/>
  <application_id nil="true"/>
  <amount type="integer">100</amount>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <smart_routed type="boolean">false</smart_routed>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <gateway_type>test</gateway_type>
  <shipping_address>
    <name>Newfirst Newlast</name>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
  </shipping_address>
  <response>
    <success type="boolean">true</success>
    <message>Successful purchase</message>
    <avs_code nil="true"/>
    <avs_message nil="true"/>
    <cvv_code nil="true"/>
    <cvv_message nil="true"/>
    <pending type="boolean">false</pending>
    <result_unknown type="boolean">false</result_unknown>
    <error_code nil="true"/>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2021-10-14T08:48:04Z</created_at>
    <updated_at type="dateTime">2021-10-14T08:48:04Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
    <created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
    <updated_at type="dateTime">2021-10-13T20:32:55Z</updated_at>
    <email>joey@example.com</email>
    <data>
      <my_payment_method_identifier>448</my_payment_method_identifier>
      <extra_stuff>
        <some_other_things>Can be anything really</some_other_things>
      </extra_stuff>
    </data>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <metadata>
      <key>string value</key>
    </metadata>
    <callback_url nil="true"/>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Newfirst</first_name>
    <last_name>Newlast</last_name>
    <month type="integer">3</month>
    <year type="integer">2032</year>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
    <company nil="true"/>
    <full_name>Newfirst Newlast</full_name>
    <eligible_for_card_updater type="boolean">true</eligible_for_card_updater>
    <shipping_address1 nil="true"/>
    <shipping_address2 nil="true"/>
    <shipping_city nil="true"/>
    <shipping_state nil="true"/>
    <shipping_zip nil="true"/>
    <shipping_country nil="true"/>
    <shipping_phone_number nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Merchant defined fields

You can specify 20 different merchant defined fields. Here is an example using a few:


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
          <nmi>
            <merchant_defined_field_1>A value</merchant_defined_field_1>
            <merchant_defined_field_8>Another value</merchant_defined_field_8>
            <merchant_defined_field_20>Another custom value</merchant_defined_field_20>
          </nmi>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2017-07-27T17:49:39Z</created_at>
  <updated_at type="dateTime">2017-07-27T17:49:39Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>E4rJBY0h71o4ZZpDomiLQmQcJ2g</token>
  <transaction_type>Purchase</transaction_type>
  <order_id nil="true"/>
  <ip nil="true"/>
  <description nil="true"/>
  <email nil="true"/>
  <merchant_name_descriptor nil="true"/>
  <merchant_location_descriptor nil="true"/>
  <gateway_specific_fields>
    <nmi>
      <merchant_defined_field_1>A value</merchant_defined_field_1>
      <merchant_defined_field_8>Another value</merchant_defined_field_8>
      <merchant_defined_field_20>Another custom value</merchant_defined_field_20>
    </nmi>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>54</gateway_transaction_id>
  <gateway_latency_ms type="integer">29</gateway_latency_ms>
  <amount type="integer">100</amount>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <shipping_address>
    <name>Newfirst Newlast</name>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
  </shipping_address>
  <response>
    <success type="boolean">true</success>
    <message>Successful purchase</message>
    <avs_code nil="true"/>
    <avs_message nil="true"/>
    <cvv_code nil="true"/>
    <cvv_message nil="true"/>
    <pending type="boolean">false</pending>
    <result_unknown type="boolean">false</result_unknown>
    <error_code></error_code>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2017-07-27T17:49:39Z</created_at>
    <updated_at type="dateTime">2017-07-27T17:49:39Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
    <created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
    <updated_at type="dateTime">2017-07-27T17:49:33Z</updated_at>
    <email>joey@example.com</email>
    <data>
      <my_payment_method_identifier>448</my_payment_method_identifier>
      <extra_stuff>
        <some_other_things>Can be anything really</some_other_things>
      </extra_stuff>
    </data>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Newfirst</first_name>
    <last_name>Newlast</last_name>
    <month type="integer">3</month>
    <year type="integer">2032</year>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
    <company nil="true"/>
    <full_name>Newfirst Newlast</full_name>
    <eligible_for_card_updater nil="true"/>
    <shipping_address1 nil="true"/>
    <shipping_address2 nil="true"/>
    <shipping_city nil="true"/>
    <shipping_state nil="true"/>
    <shipping_zip nil="true"/>
    <shipping_country nil="true"/>
    <shipping_phone_number nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
</transaction>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 4432,
  gateway_specific_fields: {
    nmi: {
      merchant_defined_field_1: "A value",
      merchant_defined_field_8: "Another value",
      merchant_defined_field_20: "Another custom value"
    }
  }
)


#<Spreedly::Purchase:0x007fe333b3f2e0
@token="Igr2pXyuiI9CIHDF8yVmmcM0rTo",
@created_at="2017-07-27T17:49:40Z",
@updated_at="2017-07-27T17:49:40Z",
@state="succeeded",
@message="Succeeded!",
@succeeded="true",
@order_id="",
@ip="",
@description="",
@gateway_token="T11bJAANtTWnxl36GYjKWvbNK0g",
@gateway_transaction_id="66",
@email="",
@merchant_name_descriptor="",
@merchant_location_descriptor="",
@on_test_gateway="true",
@currency_code="USD",
@amount="4432",
@response,=
#<Spreedly::Response:0x007fe333b2ca78
@success="true",
@pending="false",
@cancelled="false",
@fraud_review="",
@created_at="2017-07-27T17:49:40Z",
@updated_at="2017-07-27T17:49:40Z",
@message="Successful purchase",
@avs_code="",
@avs_message="",
@cvv_code="",
@cvv_message="",
@error_code="",
@error_detail="">,
@shipping_address,=
#<Spreedly::ShippingAddress:0x007fe333b1e798
@name="Newfirst Newlast",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="">,
@gateway_specific_fields={:nmi=>{:merchant_defined_field_1=>"A value", :merchant_defined_field_8=>"Another value", :merchant_defined_field_20=>"Another custom value"}},
@payment_method,=
#<Spreedly::CreditCard:0x007fe333b16958
@token="1rpKvP8zOUhj4Y9EDrIoIYQzzD5",
@created_at="2017-06-26T17:04:38Z",
@updated_at="2017-07-27T17:49:39Z",
@email="joey@example.com",
@storage_state="retained",
@data="<my_payment_method_identifier>448</my_payment_method_identifier>\n      <extra_stuff>\n        <some_other_things>Can be anything really</some_other_things>\n      </extra_stuff>",
@first_name="Newfirst",
@last_name="Newlast",
@full_name="Newfirst Newlast",
@month="3",
@year="2032",
@number="XXXX-XXXX-XXXX-1111",
@last_four_digits="1111",
@first_six_digits="411111",
@card_type="visa",
@verification_value="",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="",
@company="",
@fingerprint="e3cef43464fc832f6e04f187df25af497994",
@eligible_for_card_updater="",
@errors=[]>>

Gateway specific response fields

A response from NMI gateway may contain information from the processor which you can find in the gateway_specific_response_fields. When available, NMI gateway will also return the platform_id and the processor_id fields. For example, a transaction could have something like this:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <nmi>
       <authcode>1234</authcode>
       <platform_id>1234</platform_id>
       <processor_id>ccprocessorb</processor_id>
     </nmi>
  </gateway_specific_response_fields>
</transaction>