solution25/maxmind

MaxMind fraud prevention plugin for Shopware 6

1.2.0 2025-04-11 11:31 UTC

Requires

• maxmind/minfraud: ^3.2
• shopware/core: ~6.6.0

MIT

• Solution25

README

MaxMind Fraud Prevention

Introduction

The MaxMind plugin helps detect and prevent fraud in Shopware stores. It checks every order for fraud risk using MaxMind’s service and assigns a risk score. If the score is too high, the order is flagged for review. The plugin helps store owners reduce fraud by automatically analyzing orders, flagging suspicious ones, and providing risk scores in the admin panel.

Key Features

1. Fraud Detection
   • Analyzes orders using MaxMind and assigns a risk score.
2. Automatic Order Review
   • Flags orders as “Fraud Review” if the risk score is too high.
3. Admin Panel Integration
   • Allows configuration of API keys, risk thresholds, and settings.
4. Device Tracking
   • Injects MaxMind’s JavaScript for fraud detection.
5. Easy Monitoring
   • Displays fraud scores in the Orders grid and Order Detail view.
6. Shopware Compatibility
   • Works with Shopware 6.4–6.5 and future updates.

Get Started

Installation & Activation

1. Download

Git

• Clone the Plugin Repository:
• Open your terminal and run the following command in your Shopware 6 custom plugins directory (usually located at custom/plugins/):

  git clone https://github.com/solution25com/maxmind-fraud-prevention-shopware-6-solution25.git
  

Packagist

 composer require solution25/maxmind

1. Install the Plugin in Shopware 6

• Log in to your Shopware 6 Administration panel.
• Navigate to Extensions > My Extensions.
• Locate the newly cloned plugin and click Install.

1. Activate the Plugin

• After installation, click Activate to enable the plugin.
• In your Shopware Admin, go to Settings > System > Plugins.
• Upload or install the “MaxMind” plugin.
• Once installed, toggle the plugin to activate it.

1. Verify Installation

• After activation, you will see MaxMind in the list of installed plugins.
• The plugin name, version, and installation date should appear as shown in the screenshot below.

Plugin Configuration

1. Access Plugin Settings

• Go to Settings > System > Plugins.
• Locate MaxMind and click the three dots (...) icon or the plugin name to open its settings.

1. General Settings

• Sales Channel
  • Select the sales channel(s) where you want MaxMind to be active. If you choose “All Sales Channels,” it will apply to every channel in your store.
• MaxMind Account ID
  • Enter the Account ID provided by MaxMind.
• MaxMind License Key
  • Enter the License Key from your MaxMind account.
• Risk Threshold (0 to 99)
  • If an order’s risk score exceeds this threshold, the order status is set to Fraud Review.

1. Save Configuration

• Click Save in the top-right corner to store your settings.

How It Works

1. Customer Places an Order

• When the customer checks out, the plugin sends order data to MaxMind’s API for a fraud assessment.

1. Risk Score Calculation

• MaxMind returns a Fraud Risk Score (0.01 to 99).
• If the score is above your configured threshold, the plugin automatically sets the order status to Fraud Review.
• If the score is below the threshold, the order is automatically marked as Fraud Pass.
• The Open and Cancel statuses are no longer used in this workflow.

1. Order Status Update

• The Order status field in Shopware will show “Fraud Review” if the risk score exceeds your threshold.
• You can see this status in the Orders overview page.

Viewing and Managing Orders

1. Navigate to Orders

• In the Shopware Admin, click Orders.
• You will see a list of all orders with columns for Order status, Payment status, Delivery status, and Fraud Risk Score.

1. Review Fraud Risk Score

• Look at the Fraud Risk Score (%) column.
• Orders with a risk score higher than your threshold will appear as Fraud Review in the Order status column.
• Orders with a risk score lower than your threshold will automatically be marked as Fraud Pass.
• The Open and Cancel statuses are no longer used in this workflow.

1. Manually Changing Order Status

• Click on an order to open its detail page.
• In the General tab, you can change the Order status from Fraud Review to Fraud Pass or Fraud Fail after reviewing the order details.

1. Orders Overview with Fraud Review & Fraud Risk Score

2. Order Detail Page with Status Options

Best Practices

• Set a Reasonable Threshold
  • Too low (e.g., 0.1) may flag many legitimate orders.
  • Too high (e.g., 99) may miss fraudulent ones.
• Monitor Flagged Orders
  • Always manually review orders marked as “Fraud Review.”
  • Look for suspicious details like mismatched addresses or unusual email domains.
• Keep Credentials Up to Date
  • Ensure your MaxMind Account ID and License Key are valid.
  • An expired key will stop risk scores from being retrieved.
• Stay Current with Plugin Updates
  • Keep the plugin updated to ensure compatibility with the latest Shopware and MaxMind API changes.

Troubleshooting

• No Risk Scores Appearing
  • Double-check your MaxMind credentials (Account ID and License Key).
  • Ensure the plugin is enabled for the correct Sales Channel.
• Orders Not Changing Status
  • Verify that your Risk Threshold is properly set.
  • Check for conflicts with other order management plugins.
• Settings Not Saving
  • Clear Shopware’s cache after saving.
  • Check file permissions if changes don’t persist.

FAQ

• Is a MaxMind account required?
  • Yes. You need an active MaxMind account and a valid license key for the plugin to function.
• Can I limit the plugin to specific sales channels?
  • Yes. In the plugin settings, you can select which channels it should apply to.
• What happens to orders flagged as ‘Fraud Review’?
  • You can investigate them and then manually change their status to Fraud Pass or Fraud Fail as needed.
• Does the plugin handle refunds or chargebacks automatically?
  • No. It only provides a fraud risk score and sets the order status. Refunds/chargebacks must be managed separately.

Wiki Documentation

Read more about the plugin configuration on our Wiki.