MultiSafepay app for Lightspeed


This technical manual is for installing and configuring our free app for integrating MultiSafepay payment solutions into your Lightspeed webshop.

For our deprecated Lightspeed core integration, see Lightspeed core.

Test environment

 
We recommend first installing the app in a test environment following the recommended Lightspeed installation procedure. Make sure you have made a backup.

This app is tested using the default one-step and one-page checkout using the default theme.

Support

 
Contact us:

  • Telephone: +31 (0)20 8500 500
  • Email: [email protected]
  • GitHub: Create a technical issue

Requirements

  • MultiSafepay account – See Getting started.
  • A MultiSafepay API key
  • The app only supports one account per webshop

Payment icons

To use MultiSafepay payment icons, see GitHub MultiSafepay icons.

JavaScript

For the best user experience, we provide some Javascript and images, e.g. to add a drop-down for iDEAL and MultiSafepay icons for other payment methods.

Some user-added themes or scripts may cause issues, e.g. missing images for payment methods.

For assistance, ask your developer.

All payment methods still work if you don’t use the Javascript files.

Installation

  1. Sign in to your Lightspeed backend.
  2. Go to Apps on the left-hand side of the dashboard.
  3. Search for the MultiSafepay payments app.
  4. Click on the app, and then on Install app in the top-right corner.
  5. A dialog appears. Approve the permissions required for the app.
    You are redirected to Lightspeed – MultiSafepay: How to log in.
  6. In the Setup page:
    • Enter your email address.
    • Enter your account or website API key.
    • Select Test or Live environment.
    • Click Save and continue. You are redirected to the Settings page.
  7. Verify the current settings and then click Save. The app is now activated.

Updates

You don’t need to manually update our app.

User guide

Deleting MultiSafepay

After terminating your contract with MultiSafepay, our payment methods may still be visible in your checkout.

To delete the MultiSafepay integration from Lightspeed and remove the payment methods, follow these steps:

  1. Sign in to your Lightspeed app.
  2. Go to Apps > Purchased apps > MultiSafepay payments.
  3. Click Go to app.
  4. Sign in to the MultiSafepay app.
  5. Click Disable all payment methods.
Adding payment method logos

By default, our Lightspeed app does not support adding logos for payment methods to your website footer. You can either:

  • Ask your developer to add the logos to your theme. Themes can differ and you may need to make some changes for it to function, or

  • Use our automated script, follow these steps:

  1. Sign in to your Lightspeed app.
  2. Go to Settings > Storefront payment icons.
  3. Click the copy to clipboard button.
  4. In your Lightspeed admin area, go to Settings > Web extras and custom Javascript.
  5. Paste the script into the Javascript textbox.
  6. Set the status to Enable.
  7. Click Save. The logos appear in the footer.

Display order
Depending on the storefront, the display order of the logos is determined by the settings at the time of generation. If you update these settings, you need to update the script as well.

Size
By default the logos are 16px high. In most themes, footer logos are found in the “div.payment-methods p”. If needed, you can change the selector based on the theme.

To resize logos, follow these steps:

  1. In the JavaScript for displaying the logos, locate the following img element near the end of the script:

    <img src="${msplt[e]}" alt="${e}" />

  2. Specify the height and width in pixels as required, e.g.:

    <img height="16" width="37" src="${msplt[e]}" alt="${e}" />

Missing logos

Logos may be missing due to your website theme settings.

To add missing payment method logos, follow these steps:

  1. Download the logos from our Github repo.
  2. Rename the file with upper case formatting, e.g applepay.png > APPLEPAY.png.
  3. Sign in to your Lightspeed app.
  4. Go to Design > Theme editor > Advanced > Edit code > Assets, and drop in the logos.

The logos won’t appear instantly. It takes a little time.

Changing API key and environment

To change your API key or environment after installation, follow these steps:

  1. Sign in to your MultiSafepay app for Lightspeed app.
  2. Tap the hamburger menu and go to Environment.
  3. Edit your API key and the Environment.
Changing internationalization

When changing internationalization in your Lightspeed eCom backend, do not change the primary language setting while installing the app.

Lightspeed eCom requires a language, an API key, and a cluster to validate API requests.

If you remove the language used during installation instead of deactivating it, the app cannot communicate with Lightspeed eCom services.

Disabling payment methods

Disabling payment methods You can disable payment methods in the Payment method settings list. Enabled payment methods show a green dot, when disabled its grey.

To disable payment methods for specific languages, follow these steps:

  1. Sign in to your Lightspeed app.
  2. Select the relevant storefont.
  3. For each language, disable the relevant payment methods.

If no specific language rule-set is found, Default is used.

Missing payment methods

By default, newly activated payment methods in your MultiSafepay account are disabled in the Lightspeed app’s MultiSafepay payments settings. You need to enable them in both environments.

If a payment method is missing:

  1. Sign in to your MultiSafepay account and check that the payment method is enabled.
  2. Sign in to your Lightspeed app, go to Settings, and then enable the payment method again.
Displaying payment methods

To set a maximum/minimum order amount for a payment method to display on your checkout page, follow these steps:

  1. In the Payment methods ordering list, click the + button to open the relevant payment method.
  2. Enter an amount in EUR cents in the:
    • Maximum field. E.g. A maximum value of 1500 cents means the payment method only appears on the checkout page if the total order amount is less then 15 EUR. If you don’t want a maximum amount, enter -1. OR
    • Minimum field. E.g. A minimum value of 1500 cents means the payment method only appears on the checkout page if the total order amount is more then 15 EUR.

Setting a maximum/minimum order amount per language

To set different maximum/minimum order amounts for different languages, under the Payment methods ordering header > Country dropdown menu, select a country and set the maximum/minimum amount per language.

If no specific rule is set for a language, Default language is used.

Logging in

In early 2021, we changed the login method from a password to Lightspeed’s single sign-on. You can now sign in to the app’s Settings directly from the Lightspeed eCom store. You don’t need to click or tap the Login button.

To sign in using Lightspeed single sign-on, follow these steps:

Step 1: Sign in to the Admin section of your Lightspeed store.

Step 2: In the sidebar, click Apps.

Step 3: Click Purchased apps / Aangeschafte apps.

Step 4: In the sidebar, click Apps.

Step 5: Click MultiSafepay Payments.

OR Paste /admin/store/apps/1517 after the base URL of your store to take you straight to the store page.

Step 6: On the store page, click Go to app / Ga naar app.

Ordering payment methods

To change the order in which payment methods appear on your checkout page, follow these steps:

  1. Go to Settings > Payment method settings.
  2. Drag and drop the payment methods to the preferred order.
  3. Click Save.

Setting payment method order per language

To set the payment method order for different languages, under the Payment method settings select a country / store language and set the order per language.

If no specific rule is set for a country, the Default order is used..

Processing refunds

Refund rules

Enabling refunds

To enable refunds from your backend, follow these steps:

  1. Sign in to your Lightspeed app.
  2. Go to Settings.
  3. In the sidebar, click Enable refunds.
  4. Select the relevant setting:
    • Refunds disabled (default)
    • Refunds enabled:
      • Create a refund when the credit memo status is Unpaid (default when refunds are enabled).
      • Always create a refund, no matter the credit memo status.

Notes

  • If you use Lightspeed eCom linked to Lightspeed Retail, to process refunds via MultiSafepay, you must enable the Always create a refund, no matter the status setting.

  • When creating a credit memo, set the status to Not paid. If the Always create a refund, no matter the status setting is not enabled, MultiSafepay ignores Paid status.

Known issues

  • For refunds created in your Lightspeed backend, a short message appears in the Notes section of the order where any errors are explained.

  • Refunds created in your MultiSafepay account are not reported back to Lightspeed. Under Offline actions, an error appears: “Already a completed transaction”.

  • Some pay later methods require product IDs for each refunded item. When using product variants, make sure each variant has a unique identifier. If you provide duplicate IDs, we cannot distinguish which items to refund.

  • Some pay later payment methods do not let you refund a partial amount and a full item in a single request.
    Example: A shopping cart contains 3 items for a total of 1.70 EUR. If you refund 1 item and 0.40 EUR, it fails. Make sure you refund items and amounts separately.

  • Some pay later payment methods do not let you refund a partial amount and a full item in a single request, e.g. a shopping cart contains 3 items for a total of 1.70 EUR. If you refund 1 item and 0.40 EUR, it fails. Make sure you refund items and amounts separately.

  • You cannot issue multiple refunds for the same amount within 5 minutes of each other, even for different items.

For any questions, email the Integration Team at [email protected]

Sending payment reminders

The Lightspeed app doesn’t support Second Chance emails because Lightspeed orders expire after 12 hours.

Lightspeed offers a functionality that lets you configure payment reminders and emails for orders with Pending status. For more information and instructions, see Lightspeed - Configuring payment reminders

Upgrading to the new app

Upgrading to the new app

To upgrade from our deprecated core integration to the Lightspeed app, follow these steps:

  1. In the Lightspeed app manual, follow the steps to install the Lightspeed app.

  2. Place a test order to make sure it’s working properly.

  3. Open the classic MultiSafepay payment gateway settings, and then disable the payment provider.

To access the MultiSafepay Payments app Settings page:

  • You are automatically redirected after installing the app, or
  • Select the MultiSafepay Payments app, and then click Go to app.

Disabling the core integration

To disable the core integration after migrating to the new app, follow these steps:

  1. Sign in to your Lightspeed backend.
  2. Go to Settings > Payment providers > MultiSafepay.
  3. At the top of the screen, click Disable this payment provider.

For any questions about the app, email the Integration Team at [email protected]

Returning to the core integration

To switch back to the core integration, uninstall the app from the app store and re-enable the core integration.

Viewing your shop ID

To view your shop ID, follow these steps:

  1. Sign in to the /admin area of your Lightspeed app.
  2. Click Help in the bottom-left corner.
  3. A popup appears containing your shop ID (also known as the store ID).

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.