Configuring the MaxMind MinFraud Plugin

The plugin sends queries to MaxMind minFraud and receives risk reports for each order within the Ubersmith Order Manager. The plugin creates a minFraud template that can be applied or overlaid to your order queues. Once configured, you can further tailor each order queue to have different interactions with minFraud.

There are three levels of reports to select for the plugin, minFraud Score, minFraud Insights, and minFraud Factors. It is assumed you already have an existing account with MaxMind minFraud. 

In order to begin sending queries and receiving risk reports from minFraud, you need to configure Ubersmith. The configuration steps are as follows:

1. Configure the MaxMind minFraud plugin.
2. Customize the mapped data.
3. Add the MaxMind minFraud to the order queue 
4. Customize the minFraud order queue.
5. Process the order 
6. Review your results.

Configuring the MaxMind MinFraud Plugin

1. Access the Plugins page 
2. Click MaxMind minFraud. The MaxMind MinFraud plugin page appears.
3. Click Disabled to toggle the plugin to Enabled.
4. In the Modules section, click add new instance. The Associated Components section appears.
5. Click in the Brands field to display the brands you can apply the plugin to work with, select one or select Apply to all.
6. Click Save.
   
7. In the MinFraud Order Queues section, click add new instance. The Associated Components section appears.
8. Click in the Order Queues field to display the order queues you can apply the plugin to work with, select one or select Apply to all.
9. In the Instance Name field, enter a descriptive name of the instance, such as the name of the order queue.
10. In the minFraud Account ID field, enter your MaxMind account ID.
11. In the minFraud License Key field, enter your MaxMind license key.
12. In the minFraud Service Type field, select score, insights, or factors.
13. In the Fraud Score Limit field, enter the acceptable risk scoring limit to allow the order to process without taking any further actions.
14. In the Currency used field, select the currency you use to pay for your MaxMind minFraud transactions.
15. Click Save.
    
16. Click Go to Plugin Home.
    

Customizing The Mapped Data

You can customize the data sent to minFraud, so it can analyze and report on potential fraud risks with the data fields you choose. The minFraud data categories in the plugin are billing, shipping, account, credit card, email, payment, order, device, event, and custom.

Each available minFraud field listed in the plugin can be mapped two ways. You can use an internal Ubersmith client field, which automatically sends the proper data according to the selected client field. Alternately, you can use a custom field mapping, which is a key you are responsible for defining. It associates and sends the proper value to the minFraud field when orders are created or updated. The data must be sent to the order info array, using the following format: info[min_fraud_request][category][custom_mapping_key]. For example, info[min_fraud_request][device][custom_ip_address].

Adding and Changing Client Maps

All plugin fields for minFraud are available in the Setup tab. The most common fields are already map, but many are not. You can change the defaults and add maps to the fields you need by using the Client Field or Custom Mapping toggle option.

1. Click on the Setup tab.
2. Click on the caret icon to expand the order queue you need to customize.
3. Click on the caret to expand the client group you need to customize.
   
4. To change a default map or add a existing Ubersmith value to one not mapped, click in the Client field, and select an available Ubersmith option.
   - OR -
   To use your own map, click the toggle button to enable the Custom Mapping field and enter your custom data for Ubersmith to send, using info[min_fraud_request][category][custom_mapping_key]. For example, info[min_fraud_request][device][custom_ip_address].
   
5. Click Save Configuration.

Creating Custom Inputs

You can create a map to custom inputs you have previously created in minFraud. Custom inputs are like custom field mappings. In both cases you add the field values to the plugin order data yourself; Ubersmith does not do that for you automatically. The format to use when sending custom data is info[min_fraud_request][custom_inputs][your_custom_input_mapping_key]. Notice that custom_inputs is a category in the custom field mappings. It is assumed you already have custom input parameters and corresponding rules defined in MaxMind minFraud.

created in minFraud. It is assumed you already have custom input parameters and corresponding rules defined in MaxMind minFraud.

1. Click on the Setup tab.
2. Click on the caret icon to expand the order queue you need to customize.
3. Click on the caret to expand the Custom Inputs group.
4. Click Add New Custom Input.
5. In the Field Key field, enter your MinFraud input parameter key.

6. In the Client Field or Custom Mapping field, either select the existing Ubersmith value from the Client Field drop down, or toggle to enable the Custom Mapping field and enter your own custom data.

7. Click Save Configuration.
   

Customizing MinFraud Order Queues

Once you have configured the MaxMind minFraud plugin, which acts as a template, and added the minFraud plugin to order queues, you can customize them. This section details how to access the configuration from the plugin, but you can also customize each order queue when adding the minFraud plugin.

1. From the Dashboard tab, click edit. The Manage Order Queue page appears.
2. Select the minFraud order action. The Edit Order Action page appears.
3. Click on the Config tab to adjust the selected order queues’ minFraud field mappings.

Reviewing your Results

1. Click the Dashboard tab. Your active order queues configured in the Plugin Configuration page appear.
2. Click on the Order Count link.
   
   The Order Queue Order Steps page appears.
3. Click the order step link you want to see.
   
   The order steps for the order queue displays in the Order Manager.
4. Click the Order ID link you want to see.
   
   The order appears with the minFraud information in the minFraud section.

5. Click the to expand each section, based on the minFraud options you configured in the plugin.