Product Manual

Your one-stop shop for the details of everything related to our solution.

Magento Extension v3.16 to v3.17

This guide applies to the versions 3.16 and 3.17 of our Magento 1 extension.

Magento 1 is only available to merchants on Signifyd's Mid-Market and Enterprise plan.

Overview

Signifyd’s Magento extension enables merchants on Magento 1 to integrate with Signifyd in minutes, automating fraud prevention and protecting them in case of chargebacks.

Specifically, Magento merchants can:

  • Automatically send all orders to Signifyd for Guaranteed Fraud Protection
  • Configure order workflows based on Signifyd’s Guarantee decision
  • View the Signifyd Guarantee decision and score within the Orders grid

When an order is placed on your Magento store, Signifyd immediately reviews the order in real-time to determine whether it's a legitimate customer or fraudulent purchase attempt.

How It Works

When an order is placed on your Magento store, Signifyd immediately places the order on hold to determine if it's fraudulent.

Within seconds, we'll tell you whether you should accept and ship the order (Approved), or cancel and not ship the order (Declined). The decision is displayed in the "Guarantee Status" column in the Magento Orders grid, and links to the case details within the Signifyd console.

If an order is approved for Guarantee, Signifyd will unhold the order and update the order status to Processing within the Orders grid. (Please note that Signifyd can't send out any emails to this effect.) Signifyd can also simply leave the order on hold, if the merchant prefers.

If an order is declined for Guarantee, Signifyd will leave the order on hold, allowing the merchant to decide if they choose to cancel the order, or ship without chargeback protection.

Signifyd Decision Magento Action
Approve Unhold the order, and update order status to Processing, OR,

Leave order on hold

Decline Leave order on hold

(Note: merchants on Magento 1 also have the option of automating their order fulfillment based on Signifyd’s guarantee decision, allowing merchants to effectively speed up the order fulfillment process and ship good orders faster. Read more about auto fulfillment here, and if you'd like to use this feature, please reach out to our support team to obtain the version of our extension that support auto fulfillment.)

Within the order's Comments History, you can view a history of all the updates Signifyd has made to an order. Below are examples of how Signifyd updates an order, using both an example of an approved order and a declined order.

Approved Orders

screen-shot-2016-10-25-at-1-58-34-pm-copy

magento1_1

In the above scenario, the order was submitted and immediately placed on hold. Within seconds, Signifyd approved the order, unheld it, and updated the order status to Processing. The Guarantee Status was updated to Approved.

Declined Orders

magento1_2

In the above scenario, the order was submitted and immediately placed on hold. Within seconds, Signifyd determined the order to be fraudulent, and left the order on hold. The Guarantee Status was updated to Declined.

Installation

In order to be successful on Magento, it is recommended that you follow the below sequence in your installation process.

  1. Contact sales to request a Signifyd account.
  2. Download the Signifyd extension from the Magento store.
  3. Install the extension in Magento.
  4. Configure the extension within Signifyd and Magento.
  5. Test the integration.
  6. Go live.

You'll also need to have the following:

  • A compatible version of Magento
  • A Magento Connect account
  • A Magento Admin account
1. Contact sales to request a Signifyd account.

From the Signifyd home page, submit a sales inquiry. Our team will reach out promptly and set you up with an account, and discuss pricing and plan options.

2. Download the Signifyd extension from the Magento store.

Visit the Signifyd extension page on Magento Connect.

screen-shot-2016-10-19-at-12-30-01-pm

Select your applicable platform from the dropdown: Community or Enterprise.

Click Install Now.

Select your connect type.

  • For Community 1.5 or lower, select Connect 1.0
  • For Community 1.5 or higher, select Connect 2.0

Click Select Key.

Copy the extension key and keep this on hand for the next step.

3. Install the Signifyd extension in Magento.

From within Magento Admin, you'll need to take a few steps to complete the initial installation.

1. Paste extension key into Magento Connect.

Login to your Magento Admin account.

Take note of any warnings or error messages displayed in your dashboard, and correct them before continuing.

From the navigation bar, go to System → Magento Connect → Magento Connect Manager.

screen-shot-2016-10-07-at-1-00-48-pm

magento2_102

Within the Install New Extensions section, paste the Extension Key you copied from the download process. Click Install.

Then select Proceed to begin your installation process.

magento3_103

Check to make sure the plugin installed successfully at the page bottom. Take note of any errors and correct them if possible. Select the Refresh button.

magento4_104

Click on Return to Admin at the page’s top right corner when the installation is complete.

2. Flush your System Cache.

From the navigation bar, go to System → Cache Management

screen-shot-2016-10-07-at-1-11-09-pm

Click on Flush Cache Storage. You should receive a message on the screen that says “The cache storage has been flushed."

magento7_105

3. Confirm extension has been installed correctly.

Log out of your Magento Admin panel and log back in. 

Once you've logged back in, go to SystemConfiguration. Within the Configuration menu, scroll down and click on Signifyd.

You should see a screen like the one below.

screen-shot-2016-10-20-at-12-58-54-pm

Now that you've completed the installation process, the next step is configuration.

4. Configure the extension within Magento and the Signifyd console.

In order to configure the Signifyd extension, you'll need to work in both Magento Admin and the Signifyd console. We recommend keeping two windows open: one with your Magento Admin page and one with the Signifyd console.

Part of our recommended configuration process involves setting up a test team, in addition to a production team. This allows you to test your store's integration with Signifyd before going live. We won't charge for orders submitted through this team, and please note that once a team is designated as a test team, it cannot be changed. (Learn more about test teams here.)

1. Login to your Signifyd account and create a test team and a production team.

Sign in to your Signifyd account and select Settings from the menu in the upper right hand corner.

Select Teams from the left hand menu.

Enter a name for your test team, and check the box labeled Test Team. Click Create Team.

screen-shot-2016-10-20-at-2-32-34-pm

Now, create your production team.

From the top of the Teams page, click Add New.

screen-shot-2016-10-20-at-2-37-32-pm

Enter a name for your production team, and click the green check mark.

screen-shot-2016-10-19-at-1-38-01-pm

You should see both teams now in the General section.

screen-shot-2016-10-20-at-2-38-00-pm

2. Copy the API Key for your test team.

In the General section, under API Keys, locate your test team and copy the API key for that team.

You'll need that API Key for the next step.

Keep your Signifyd Settings window open, and now switch over to your Magento Admin page.

3. Login to Magento Admin, go to your test store and configure the extension.

Open a new window and login to your Magento Admin panel. Switch to your test store.

Go to System → Configuration. Within the Configuration menu, scroll down and click on Signifyd.

You should see the screen below.

screen-shot-2016-10-20-at-12-58-54-pm-1

Within the Signifyd extension panel, please complete the following steps:

General section:

  • In the API Key field, paste the API Key you copied from your Signifyd test team

Order Workflow section:

  • In the When an order is approved for Guarantee dropdown, select Unhold Order
  • In the When an order is declined for Guarantee dropdown, select Leave On Hold

Logging section:

  • In the Enable logging, select Yes.

Webhook URL section:

  • Copy the URL in this section. You'll need this to complete configuration back in your Signifyd settings page.

Your screen should look like the below.

screen-shot-2016-10-20-at-3-22-35-pm

Click on Save Config in the upper corner.

Now, switch back over to your Signifyd console window.

4. Return to your Signifyd window, and create a webhook.

Webhook URL
Webhooks are used to push Signifyd's guarantee decision back to Magento and enable a two-way sync between Magento and Signifyd.
  • To configure a webhook: copy the URL from the Webhook URL setting. You'll need this to complete the configuration in the next step.
  • Then navigate to the Signifyd console, settings, and then click on Notifications.
In the Webhooks section, complete the following steps:
  • In the Webhook address field, paste the Webhook URL you copied from your Magento Admin panel
  • In the Team dropdown, select the test team you just created
  • In the Event Type dropdown, select Guarantee Completion
Finally, click Add to save the webhook.
screen-shot-2016-10-21-at-10-51-39-am-1

screen-shot-2016-10-21-at-10-51-56-am-1

5. Enable the extension in Magento Admin.

Once you've confirmed that the extension has been configured correctly in your Magento Admin and the Signifyd settings page, it's time to enable the extension in your test store.

From within the Signifyd extension panel in your Magento Admin, do the following:

General section:

  • In the Enable extension dropdown, select Yes

screen-shot-2016-10-20-at-1-13-26-pm

Click Save Config.

Now that your Signifyd extension has officially been configured in your test store, it's time to test the integration.

5. Test your integration.

We recommend testing your Signifyd integration in order to confirm that it has been configured successfully.

Depending on the complexity of your Magento store's set up, testing can be completed in less than a day or over a series of days.

1. Create test orders.

We recommend creating orders in your Magento testing environment that allow you to test integration for the following scenarios:

  • Integration with your shipping fulfillment software
  • Integration with your order management system
  • Different payment methods
  • etc.

2. Examine the test orders from within the Magento Orders grid and the Signifyd console.

When you create a test order in your Magento store, you should confirm that:

  1. A case has been created in Signifyd.
  2. The Signifyd case details match the test order details.
  3. The guarantee status and score shown in the Signifyd console match what is displayed in your Magento Orders grid.
  4. If the order has been approved for guarantee, that Magento is triggered to unhold the order.
  5. If the order has been declined for guarantee, that Magento is triggered to keep the order on hold.
  6. Logging is working correctly.

From within your Magento Orders grid, choose a test order and click on the Guarantee Status (or Signifyd Score).

screen-shot-2016-10-21-at-10-58-39-am-copy

You should be taken to the case details of that order within the Signifyd console.
screen-shot-2016-10-21-at-11-00-36-am

If you have any questions throughout this testing process, or run into any problems, please reach out to our support team.

6. Go live.

Once testing has been completed, and you've confirmed that your integration is working, it's time to go live.

This involves repeating the configuration process (all of step 4) on your production site. 

Again, in order to configure the Signifyd extension within your production environment, you'll need to work in both Magento Admin and the Signifyd console. We recommend keeping two windows open: one with your Magento Admin page and one with the Signifyd console.

1. Login to your Signifyd account and grab the API key for your production team.

Sign your Signifyd account and go to Settings → Teams.

Copy the API Key that appears under your production team.

Keep your Signifyd Settings window open, and switch over to your Magento Admin page.

2. Login to Magento Admin, go to your production environment and configure the extension.

Open a new window and to your Magento Admin panel. Make sure you're in your production environment.

Go to System → Configuration → Signifyd.

Within the Signifyd extension panel, please complete the following steps:

General section:

  • In the API Key field, paste the API Key you copied from your Signifyd production team

Order Workflow section:

  • In the When an order is approved for Guarantee dropdown, select Unhold Order
  • In the When an order is declined for Guarantee dropdown, select Leave On Hold

Logging section:

  • In the Enable logging dropdown, select Yes.

Webhook URL section:

  • Copy the URL in this section.

Click on Save Config.

Now, switch back over to your Signifyd console window.

3. Return to your Signifyd window, and create a webhook.

From within your Signifyd settings window, click on Notifications.

In the Webhooks section, complete the following steps:

  • In the Webhook address field, paste the Webhook URL you copied from your Magento Admin panel
  • In the Team dropdown, select the production team
  • In the Event Type dropdown, select Guarantee Completion

Click Add.

4. Review the configuration in both Signifyd and Magento Admin.

Take a moment to review the configuration in both the Signifyd settings section (both Notifications and Teams) and the Magento Admin panel to ensure that the extension has been configured correctly.

5. Enable the extension in Magento Admin and go live.

Once you've confirmed that the extension has been configured correctly in both Magento Admin and the Signifyd settings page, it's time to enable the extension and go live.

From within the Signifyd extension panel in your Magento Admin, do the following:

General section:

  • In the Enable extension dropdown, select Yes

Click Save Config.

Your installation and configuration of the Signifyd extension for Magento 1 is now complete.

As a reminder, if you have any questions throughout this process, please reach out to our support team.