By using the NMI Query API and a Merchant Security Key, it is possible to inform your terminal management system of all necessary device merchant profile details in order to correctly configure their device to match the settings configured in the NMI Partner and Merchant Portals.

Query API Methods

Determining The Merchant's Processor

Sample Request:

https://secure.prep.nmi.com/api/query.php?username={{username}}&password={{password}}&report_type=gateway_processors&new_key_if_empty=true

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<nm_response>
    <gateway_processor>
        <description>TSYS - EMV</description>
        <processor_id>tsysemv</processor_id>
        <platform>tsys</platform>
        <emv_support>true</emv_support>
        <mcc>5999</mcc>
    </gateway_processor>
</nm_response>

You will need to reference the <processor_id> and <emv_support> fields from this report.

• In the majority of cases, merchants will only have one processor with <emv_support> listed as true.
• To cover edge cases, always select the first gateway processor where <emv_support> is true.
• Use the corresponding <processor_id> to configure appropriately.

Example Processor IDs

• TSYS: tsysemv
• First Data: fdrcnemv, fdmshemv, fdmstemv, fdmsoemv

Determining Additional Merchant Information

Sample Request

curl -v -X POST https://secure.networkmerchants.com/api/query.php?security_key=<Security-Key>&report_type=profile&processor_details=true

Sample Response

<?xml version="1.0" encoding="UTF-8"?>

<nm_response>
    <protected>false</protected>
    <is_gateway>false</is_gateway>
    <merchant>
        <company>Test Company</company>
        <email>[email protected]</email>
        <phone>123-456-7890</phone>
        <url></url>
        <address1>123 Fake St</address1>
        <address2></address2>
        <city>Beverly Hills</city>
        <state>CA</state>
        <zip>90210</zip>
        <country>US</country>
        <timezone>America/New_York (GMT-05:00) Eastern Time (US & Canada)</timezone>
        <card_schemes>Visa,Mastercard,American Express,Discover,Diner's Club,JCB,Maestro</card_schemes>
    </merchant>
    <processors>
        <processor id="elavonUK">
            <type>cc</type>
            <platform>elvnceuk</platform>
            <tap_to_mobile>
                <applications></applications>
            </tap_to_mobile>
            <required_fields></required_fields>
            <currencies>
                <currency>GBP</currency>
            </currencies>
            <merchant_category_code>1234</merchant_category_code>
        </processor>
    </processors>
</nm_response>

In the example above, you can see that the following key information is available:

• Merchant Name
• Merchant Address, including Country Code
• Merchant Time Zone
• Card Scheme Support Requested
• Acquirer / Processor
• Currency Support Requested
• Merchant Category Code

More Information

Visit our dedicated API Reference pages about the Query API to learn more and construct sample code now.

Click here to learn more about the NMI Query API.