Magento

This guide explains the required steps in order to successfully set up MultiSafepay as the payment provider in Magento. It assumes that you already have a working installation of Magento.

Before continuing you may want to review our Getting Started guide.

Installation

  1. Upgrading an existing installation
    1. In order to avoid possible conflicts rename the config file 
      ./app/code/community/Mage/Msp/etc/config.xml
      to
      ./app/code/community/Mage/Msp/etc/config.xml-old
    2. Upload the folders applib, and media from the plugin ZIP file to the root of your Magento web shop. This may overwrite some existing files and add new files to the MultiSafepay Magento plugin. These changes are intentional and required.
  2. Installing for the first time
    1. Install the plugin from Magento Connect, or
    2. Unzip the .tgz plugin file from the plugin downloaded earlier to a local folder
    3. Navigate to System -> Magento Connect -> Magento Connect Manager
    4. Choose the Direct package file upload
    5. Select and upload the .tqz plugin file
    6. Click Commit to save your changes

Configuration

There are two different ways to configure the MultiSafepay plugin for Magento. 

  1. Basic
    Using the basic configuration MultiSafepay will be shown in the payment menu within Magento. The customer can select their preferred payment method on the next screen.
  2. Separate gateways
    Under the separate gateways configuration customers select their preferred payment method directly on the Magento payment menu. This creates a simpler and faster payment process than the Basic method.

1. Basic Configuration

  1. In the Magento back office navigate to System -> Configuration -> Payment Methods -> MultiSafepay
  2. Enter the following settings

    Enabled

    Enable, or disable, MultiSafepay as a payment method

    Allowed Currency

    Select the currencies allowed for this payment method.
    Note that only the Euro is supported in your account by default. Other currencies will be converted to Euros automatically if the option below is enabled. To add support for additional currencies in your account you must contact MultiSafepay. 

    Allow convert currency to EUR

    Convert any store currency, other than the ones supported, to Euros.
    To accept, and retain, payments in other currencies you must contact MultiSafepay to have this enabled for your account.

    Title

    MultiSafepay
    Provide the description for this payment method which is show on the Magento payment menu

    Account type

    Live
    Select Test while configuring and validating your plugin setup 

    Account ID

    Your MultiSafepay account ID

    Site ID

    The MultiSafepay Site ID for this website

    Site Secure Code

    The MultiSafepay Site Secure Code for this website

    API Key

    The MultiSafepay API Key for this website. You can find this under the website settings in your merchant back office.
    Note: The key is only required if you intend on processing refunds directly from the Magento back end 

    Credit Memo

    Enable, or  disable, refunds via Magento

    Automatic redirection

    If e nabled customers will be presented with the Magento success page rather than MultiSafepay's transaction completed page

    One Step Checkout

    Enable if you're using the official OneStepCheckout module, otherwise disable.

    New order e-mail

    Specify at which stage the Order Confirmation e-mail is to be sent.

    Instructions

    Here you may optionally provide your customers with additional payment instructions

    Gateway selection

     

    Create invoices after payment

    Enable to automatically create invoice an after payment

    E-mail invoices to customers

    Enable to automatically e-mail invoices to customers.

    Send the order update e-mail to customer

    Enable to automatically e-mail Magento order status changes.

    Keep the cart

    Saves the content of a Magento shopping cart when cancelling a transaction

    Status new (unpaid) orders

    Pending

    Status paid orders

    Processing

    Status: initialized

    Pending

    Status: uncleared

    Pending

    Status: reserved

    Pending

    Status: void

    Cancelled

    Status: declined

    Cancelled

    Status: reversed

    Cancelled

    Status: refunded

    Cancelled

    Status: expired

    Cancelled

    Payment  from applicable countries

    Allows you to set the visibility of the MultiSafepay payment method to 'All Allowed Countries' or restrict to 'Specific Countries'

    Payment from specific countries

    A list of 'Specific C ountries' to accept payments from.

    Sort order

    0
    Sets MultiSafepay as the first payment option on the payment menu

    Debug

    Enable, or disable, the plug-in’s debug mode (Developers only)

  3. Save your changes

2. Separate gateways configuration

  1. In the Magento back office navigate to System -> Configuration -> MultiSafepay Gateways
  2. Enter the following settings

    Account type

    Live
    Select Test while configuring and validating your plugin setup  

    Account ID

    Your MultiSafepay account ID

    Site ID

    The MultiSafepay Site ID for this website

    Site Secure Code

    The MultiSafepay Site Secure Code for this website

    API Key

    The MultiSafepay API Key for this website. You can find this under the website settings in your merchant back office.
    Note: The key is only required if you intend on processing refunds directly from the Magento back end 

    Credit Memo

    Enable, or  disable, refunds via Magento

    Allow convert currency to EUR

    Convert any store currency, other than the ones supported, to Euros.
    To accept, and retain, payments in other currencies you must contact MultiSafepay to have this enabled for your account.

    Automatic redirection

    Enable, or disable, automatic redirection

    Customers will be presented with the Magento success page rather than MultiSafepay's transactio completed page

    One Step Checkout

    Enable if you’re using the official OneStepCheckout module, otherwise disable.

    Create invoices after payment

    Enable to automatically create invoice an after payment

    E-mail invoices to customers

    Enable to automatically e-mail invoices to customers.

    New order e-mail

    Specify at which stage the Order Confirmation e-mail is to be sent.

    Send the order update e-mail to customer

    Enable to automatically e-mail Magento order status changes.

    Keep the cart

    Saves the content of a Magento shopping cart when cancelling a transaction.

    Show the gateway images

    Enable, or disable, payment method logo's on the payment menu

    Show the images in front of the title

    Enable, or disable, payment method logo's in front of the payment method title.

    Status new (unpaid) orders

    Pending

    Status paid orders

    Processing

    Status: initialized

    Pending

    Status: uncleared

    Pending

    Status: reserved

    Pending

    Status: void

    Cancelled

    Status: declined

    Cancelled

    Status: reversed

    Cancelled

    Status: refunded

    Cancelled

    Status: expired

    Cancelled

    Debug

    Enable, or disable, the plug-in’s debug mode (Developers only)

  3. Save your changes

  4. For each of the payment methods you wish to provide to your customers open the corresponding tab and set Enabled to Yes

Verification

We recommend verifying the functionality once the plugin has been installed and configured. 

Verify Plugin Installation

 


Pay After Delivery Configuration

  1. Navigate to System -> Configuration -> MultiSafepay Gateways in your Magento back office
  2. Select the Pay After Delivery tab
  3. Enter the following settings
     

    Enabled

    Enable, or disable, this payment method

    Account type

    Live
    Select Test while configuring and validating your plugin setup  

    Account ID

    Your MultiSafepay account ID

    Site ID

    The MultiSafepay Site ID for this website

    Site Secure Code

    The MultiSafepay Site Secure Code for this website

    Account ID (for Test account)

    Your MultiSafepay Test Account ID (optional)

    Site ID(for Test account)

    Your MultiSafepay Test Site ID (optional)

    Site Code for Test account)

    Your MultiSafepay Test Site Code (optional)  

    Title

    Provide a description for this payment method to be shown on the checkout page

    Enable fee (inc. Tax)

    Enable, or disable, surcharge for this payment method

    Fee amount

    Fee amount incl. tax

    Show incl tax during checkout

    Show, or hide, the surcharge incl. tax in the checkout process

    Tax class for Payment Fee

    Select a tax class for the payment fee

    Fee description

    Enter a fee description

    Minimum order Total

    Minimum order amount for Pay After Delivery

    Maximum order Total

    Maximum order amount for Pay After Delivery

    Enable the invoice  E-mail

    Enable, or disable, the sending of invoices for this payment method

    Allowed Currency

    Convert any store currency, other than the ones supported, to Euros
    To accept, and retain, payments in other currencies you must contact MultiSafepay to have this enabled for your account

    Payment  from applicable countries

    Allows you to set the visibility of the MultiSafepay payment method to 'All Allowed Countries' or restrict to 'Specific Countries'

    Payment from specific countries

    A list of 'Specific C ountries' to accept payments from

    Sort order

    0
    Sets MultiSafepay as the first payment option on the payment menu

    Enable IP Validation

    Restrict the use of Pay After Delivery to certain IP-addresses

    Only visible for IP address

    Enter one or multiple IP-addresses, separated by a semicolon

    Only visible for IP address(for testaccount)

    Enter one or multiple IP-addresses, separated by a semicolon

    Enable test account for these IP’s

    Enter one or multiple IP-addresses, separated by a semicolon

    Send request after complete order

     

    Instructions

    Here you may provide your customers with additional payment instructions

  4. Save your changes

 

FastCheckout Configuration

  1. Navigate to System -> Configuration -> MultiSafepay FastCheckout in your Magento back office
  2. Enter the following settings

     

    Enabled

    Enable, or disable, this payment method

    Account type

    Live
    Select Test while configuring and validating your plugin setup

    Account ID

    Your MultiSafepay account ID

    Site ID

    The MultiSafepay Site ID for this website

    Site Secure Code

    The MultiSafepay Site Secure Code for this website

    API Key

    The MultiSafepay API Key for this website. You can find this under the website settings in your merchant back office.
    Note: The key is only required if you intend on processing refunds directly from the Magento back end 

    Credit Memo

    Enable, or  disable, refunds via Magento.

    Automatic redirect

    Enable,or disable, automatic redirection.

    Customers will be presented with the Magento success page rather than MultiSafepay's transaction completed page

    Send new account e-mail

    Send FastCheckout account registration e-mails to new customers

    Automatic login

    Automatically log customers in after returning from Fast Checkout

    Redirect customers to their account page

    Enable, or disable, automatic redirection to their Magento customer account

    Create invoices after payment

    Enable to create invoices after payments

    E-mail invoices to customers

    Enable to automatically e-mail invoices to customers

    New order mail

    Specify at which stage the Order Confirmation e-mail is to be sent

    Status new (unpaid) orders

    Pending

    Status paid orders

    Processing

    Status: initialized

    Pending

    Status: uncleared

    Pending

    Status: reserved

    Pending

    Status: void

    Cancelled

    Status: declined

    Cancelled

    Status: reversed

    Cancelled

    Status: refunded

    Cancelled

    Status: expired

    Cancelled

    Debug

    Enable, or disable, the plug-in’s debug mode (Developers only)

  3. Save your changes

Verification

We recommend verifying the functionality once the plugin has been installed and configured. 

Verify Plugin Installation

 


Troubleshooting

Payment methods aren't shown

Ensure that all separate gateway settings are correct and enabled, especially if you are updating from an older version of the plugin.

Error 404 while configuring the module

  1. Navigate to System -> Configuration -> Payment Methods
  2. Click on Save Configuration
  3. Log out of the administrator account
  4. Log back into the administrator account

The FastCheckout button isn't displayed

Occasionally the FastCheckout button will not be visible in the shopping cart even though it has been configured correctly. In this case you should flush the Magento shop cache.

  1. Navigate to System -> Cache Management
  2. Refresh all caches
  3. You may also want to update your indexes while you are here. System -> Index Management

During an iDEAL payment the bank list is not display

Ensure that this feature is enable.

  1. Navigate to System -> Configuration -> MultiSafepay Gateways
  2. Open the iDEAL payment tab
  3. Ensure Show banklist in checkout is enabled

Service Temporarily Unavailable

Sometimes a pre-existing issue with a Magento installation can cause the plugin installation to fail. This may leave your site in maintenance mode resulting in the message "503 - Service is unavailable" when trying to access the site.

To resolve this remove the maintenance.flag file from the root of your Magento installation.