NMI gateway guide
Adding an NMI gateway
Security key only mode
curl https://core.spreedly.com/v1/gateways.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<gateway>
<gateway_type>nmi</gateway_type>
<mode>security_key_only</mode>
<security_key>your security key</security_key>
</gateway>'
<gateway>
<token>CqqlvwWwW5Q1lpIsbbcFC4k2rPn</token>
<gateway_type>nmi</gateway_type>
<name>NMI</name>
<description nil="true"/>
<merchant_profile_key nil="true"/>
<sub_merchant_key nil="true"/>
<security_key>your security key</security_key>
<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_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
<supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_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>
<supports_inquire type="boolean">false</supports_inquire>
</characteristics>
<credentials>
<credential>
<name>security_key</name>
<value>your security key</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>dup_seconds</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>
<mode>security_key_only</mode>
<created_at type="dateTime">2022-10-11T20:19:20Z</created_at>
<updated_at type="dateTime">2022-10-11T20:19:20Z</updated_at>
</gateway>
Login and password
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>5y5RkRJl9kfD5X2yN0Luecp8crB</token>
<gateway_type>nmi</gateway_type>
<name>NMI</name>
<description nil="true"/>
<merchant_profile_key nil="true"/>
<sub_merchant_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_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
<supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_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>
<supports_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
<supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
<supports_transaction_retry type="boolean">true</supports_transaction_retry>
<supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
<supports_stored_credentials type="boolean">true</supports_stored_credentials>
</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>dup_seconds</gateway_specific_field>
<gateway_specific_field>shipping_email</gateway_specific_field>
<gateway_specific_field>surcharge</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_method>apple_pay</payment_method>
<payment_method>google_pay</payment_method>
</payment_methods>
<state>retained</state>
<redacted type="boolean">false</redacted>
<sandbox type="boolean">false</sandbox>
<mode>default</mode>
<created_at type="dateTime">2023-07-14T18:07:18Z</created_at>
<updated_at type="dateTime">2023-07-14T18:07:18Z</updated_at>
</gateway>
To learn more about creating and managing gateways in our Marketplace, review the Gateway user guide. For gateways not included in the Marketplace, review the steps below.
Create a gateway
Visit your Connections area to review all gateways and add new ones. When creating your gateways, select the gateway name and authentication mode (if prompted) before completing required fields. Select ☑️Sandbox to create a gateway in Sandbox mode, for processing test card data and transactions in your Spreedly environment.
Enter your security_key for Security key only mode, or your login and password for Default mode to create a new NMI gateway.
Third-party 3DS2 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 |
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).
The dup_seconds field sets the time in seconds for duplicate transaction checking on supported processors. Set to 0 to disable duplicate checking. This value should not exceed 7862400.
The surcharge field should be applied using the format 'x.xx'.
The industry_identifier: eCommerce or MOTO can help prevent transaction failures for Mastercard's on Apple Pay and Google Pay.
The optional network_transaction_id field can be used in conjunction with Spreedly's stored credential framework to send a previously existing network transaction id for the payment method in use.
When sending a request to the purchase, authorize, or verify endpoint, you can send the customer_vault field with add_customer to securely store customer's payment information at NMI. The optional customer_vault_id can also be used in conjunction when sending the customer_vaultfield. If not set, the payment gateway will randomly generate a Customer Vault id. For more information please visit the NMI gateway guide
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>
<network_transaction_id>12345</network_transaction_id>
<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>
<dup_seconds>0</dup_seconds>
<surcharge>0.25</surcharge>
<shipping_email>[email protected]</shipping_email>
<customer_vault>add_customer</customer_vault>
<customer_vault_id>12345abcde<customer_vault_id>
</nmi>
</gateway_specific_fields>
</transaction>'
<transaction>
<on_test_gateway type="boolean">true</on_test_gateway>
<created_at type="dateTime">2023-07-14T18:01:40Z</created_at>
<updated_at type="dateTime">2023-07-14T18:01:40Z</updated_at>
<succeeded type="boolean">true</succeeded>
<state>succeeded</state>
<token>MUSlFqYmYivtXwjCNwROEs9SSGA</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>
<network_transaction_id>12345</network_transaction_id>
<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>
<dup_seconds>0</dup_seconds>
<surcharge>0.25</surcharge>
<shipping_email>[email protected]</shipping_email>
<customer_vault>add_customer</customer_vault>
<customer_vault_id>12345abcde<customer_vault_id>
</nmi>
</gateway_specific_fields>
<gateway_specific_response_fields>
</gateway_specific_response_fields>
<gateway_transaction_id>67</gateway_transaction_id>
<sub_merchant_key nil="true"/>
<gateway_latency_ms type="integer">1</gateway_latency_ms>
<warning nil="true"/>
<application_id nil="true"/>
<amount type="integer">100</amount>
<local_amount nil="true"/>
<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>
<stored_credential_initiator nil="true"/>
<stored_credential_reason_type nil="true"/>
<stored_credential_gateway_override nil="true"/>
<populate_mit_fields type="boolean">false</populate_mit_fields>
<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">2023-07-14T18:01:40Z</created_at>
<updated_at type="dateTime">2023-07-14T18:01:40Z</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">2023-07-14T18:01:39Z</updated_at>
<email>[email protected]</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"/>
<issuer_identification_number nil="true"/>
<click_to_pay type="boolean">false</click_to_pay>
<managed 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>
<stored_credential_usage>
<test>
<original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
<network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
</test>
</stored_credential_usage>
</payment_method>
<attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>
Merchant defined fields
You can specify 20 different merchant defined fields. The following is an example using a few of them:
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>[email protected]</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>
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, the processor_id, and customer_vault_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>
<processor_response_code>123</processor_response_code>
<processor_response_text>Test123</processor_response_text>
<customer_vault_id>12345abcde<customer_vault_id>
</nmi>
</gateway_specific_response_fields>
</transaction>
Google Pay and Apple Pay transactions
Spreedly has integrated with the Merchant-Decrypted Data feature provided by NMI. However, this feature is not available for all merchants, so you should contact NMI support to enable it
Merchant will need to enable "Merchant-Decrypted Data" for Apply Pay and Google Pay.
Spreedly does not retain billing data from Apple Pay PM's which can cause issues with AVS checks on gateways. To avoid this you will need to request to get billing data info back from Apple in the Apple Pay session.
Google Pay does not use CVV, but rather CAVV, for additional information please refer to NMI docs .
Including the industry_identifier: eCommerce or MOTO GSF could help resolve potential failed transactions for Mastercard branded cards:
Please visit the Google Pay and Apple Pay guides respectively to get more information.
Updated 3 days ago