Magento 1 plugin


Magento 1 is end-of-life. We recommend upgrading as soon as possible.

This technical manual is for installing and configuring MultiSafepay’s free plugin for integrating with Magento 1.

MultiSafepay supports most Magento functionalities. For any questions, email [email protected]

Requirements

Support

  Contact us:

Our Magento 1 plugin is professionally supported by a certified Magento 1 Solution Specialist and receives regular updates to support the latest features provided by Magento and MultiSafepay.

Installation

These instructions are for SFTP upload. You can also install via .ZIP file upload in Connect.

Make sure you have a backup of your production environment, and that you test the plugin in a staging environment.
  1. Unpack the content of the .ZIP file in the root of your webshop.
  2. Sign in to your Magento 1 backend.
  3. Go to System > Configuration > Cache, and clear your invalid cache.
  4. Move all files and folders from Plugin_Magento_x.x.x to the root.
  5. Add the content of the app, lib, and media folders to the existing folders with the same name.
  6. Sign out.

Configuration

  1. Sign in to your Magento 1 backend.
  2. Go to System > Configuration > MultiSafepay x.x.x > Connect settings.
    This page contains all main settings and is used for all gateways and gift cards.
    To find your API key, see API key.
    From version 3.0.0, the plugin only needs your API key. Your account ID, site ID, and site secure code are no longer needed.
  3. To configure your selected payment methods, go to System > Configuration > MultiSafepay x.x.x:

User guide

Checkouts

The plugin is compatible with most Magento 1 checkouts. However, we cannot guarantee that all checkout features will function properly.

We test the plugin with Magento 1 core checkout and OneStepCheckout.com (Idev).

Note: Always test OneStepCheckout to make sure it is compatible with your configuration of the plugin.

Currencies

The default currency is EUR.

Changing the default currency

  1. Sign in to your Magento 1 backend.
  2. Go to System > Configuration > MultiSafepay x.x.x > Connect settings.
  3. Under Allow currency conversion to Euro, change to No.

Generic gateways

The plugin supports generic gateways, which redirect customers from your checkout to a MultiSafepay payment page. You can use them to integrate custom gift cards, or co-branded credit cards.

Configuring generic gateways

  1. Sign in to your Magento 1 backend.
  2. Go to System > Configuration > MultiSafepay > Connect gateways > Generic 1/2/3.
  3. Set the relevant payment method gateway IDs and the gateway label.
  4. Set how to display the payment method logos.
  5. For pay later methods, set whether to include the shopping cart.

Generic gateways support:

Gift cards

Generic gateways are particularly useful for integrating gift cards, including custom gift cards. This is because we don’t support all open-loop gift cards in our ready-made integrations and no closed-loop gift cards.

Co-branded credit cards

You can integrate Visa co-branded credit cards (Cartes Bancaires, Dankort, and V Pay), using the generic VISA gateway.

For the logo, see MultiSafepay GitHub – MultiSafepay icons.

Pay later orders

The status of all complete orders automatically changes to Shipped in order to collect funds from pay later payment methods.

Disabling Klarna checkout fields

Klarna requires the customer’s gender and date of birth. By default, the customer enters their birthday in the Magento checkout in the Klarna payment method fields, and their gender is automatically populated by the core Magento field.

You can disable both fields in the checkout. The customer enters this information on the MultiSafepay payment page instead.

Disabling Klarna checkout fields

This change is only for Magento developers. We recommend testing the change and placing it in your local folder.

  1. Open app\code\community\MultiSafepay\Msp\Model\Gateway\Klarna.php.
  2. Comment this line protected $_formBlockType = 'msp/klarna';
  3. Save the file.
  4. Clear your cache.
  5. Test the change.

Payment methods

Payment methods

Picquer

Enabling compatibility with Picquer

To make the MultiSafepay Magento 1 plugin compatible with Picqer, follow two additional steps, because orders must not receive Cancelled status.

  1. In your Magento 1 backend, go to the MultiSafepay Connect settings.
  2. Link Expired status to Waiting status.
  3. Open app\code\community\MultiSafepay\Msp\Model\Base.php, and then copy the file to the local folder in the Magento structure.
  4. Find the line $order > cancel(); at the expired signal and remove it.

All expired orders retain Waiting status until you cancel them:

  • Manually
  • With a custom cronjob
  • Using a plugin

Recurring payments

Enabling recurring payments

  1. Sign in to your Magento 1 backend.
  2. Go to Stores > Configuration > MultiSafepay > MultiSafepay settings.

For more information, see Recurring Payments.

Credit cards Recurring Payments are not available for the generic credit card gateway. You must enable the Visa, Mastercard, and/or Maestro gateways separately. This displays the Save card option at checkout.

Refunds

Refund rules

MultiSafepay dashboard Full refunds (may not appear in your backend)
Backend - Full refunds and credit memos
- You can’t refund more than the original amount
Pay later methods You can only refund a selected item from the order, not a set amount. If you enter an amount instead of selecting an item, the entire order is refunded.

Processing backend refunds

  1. Sign in to your Magento 1 backend.
  2. Go to System > Configuration > MultiSafepay > Connect settings.
  3. Check that you have:
    • Entered an API key
    • Enabled the Credit Memo option
  4. Search for and open the order you want to refund.
  5. Click the Invoices tab on the left of the Order overview.
  6. Open the invoice, and click Credit memo at the top right of the overview.
  7. Enter the refund amount, and then click Refund online to send the request to MultiSafepay.

Surcharges

You can:

  • Apply surcharges of a percentage or a fixed amount to transactions for every payment method.
  • Set the tax class for surcharges.
  • Show transaction amounts excluding the surcharge at checkout. Surcharges are always included at checkout.
  • Show surcharges with our without VAT at checkout.
Applying surcharges in your backend

  1. Sign in to your Magento 1 backend.
  2. Select systems and configuration.
  3. In the MultiSafepay module, select the Option connect gateway.
  4. Select the relevant payment method.
  5. Under Payment fee amount, enter a surcharge percentage or fixed amount.
  6. Place a test order to verify whether the fee has been correctly processed.

Attention Dutch merchants
We strongly recommend not applying surcharges to pay later methods. This is now considered providing credit under the Wet op het consumentenkrediet and article 7:57 of the Burgerlijk Wetboek, and requires a permit from the Authority for Financial Markets (AFM).

Updates

You can update the plugin in your Magento 1 backend or the CMS marketplace, or via SFTP.

Updating via SFTP

  1. Make sure you have a backup of your production environment, and that you test the plugin in a staging environment.
  2. Download the plugin again above.
  3. Follow the Installation and configuration instructions from step 2.

Upgrading

Magento 1 is end-of-life. If you are still running Magento 1, action is required. MultiSafepay has partnered with Mage One to continue supporting Magento 1.

For more information and instructions, see MultiSafepay blog – Magento 1: The final weeks.

Feedback

Propose a change on GitHubexternal-link-icon or
send an email to [email protected]

Other languages

For an explanation in another language, contact your account manager.