Lightspeed

Technical manual for MultiSafepay's free app.

Changelog

⚠️

Action required

We recommend upgrading to the latest version as soon as possible.

Prerequisites

How to install

Tip! Make sure you have a backup of your production environment, and that you test the plugin in a staging environment.

  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. In the dialog, 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, account ID and site API key.
  • Select Test or Live environment, and click Save and continue.
    You are redirected to the Settings page.
  1. We recommend enabling:
  • Refunds
  • MultiSafepay checkout scripts – Creates a list of iDEAL issuers, and suppresses Apple Pay for non-Apple devices.
  1. Verify the other settings, and then click Save.


User guide

API keys and environments

You can change your site API key or environment (live or test) after installation.

How to change API keys and environments
  1. Sign in to the app.
  2. Tap the hamburger menu and go to Environment.
  3. Edit your API key and/or the Environment.

Checkouts

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

How to order payment methods in your checkout

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.

How to set the 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.

Internationalization

How to change 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.

Lightspeed shop ID

How to view 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).

Order amounts

How to set maximum/minimum order amounts

Per payment method

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.

Per language

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

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

Payment links

When you generate a payment link in your MultiSafepay dashboard, you cannot update the transaction status or link it to a transaction in Lightspeed via our app. This is by design in Lightspeed.

Payment methods

Supported payment methods

To use MultiSafepay payment method icons, see GitHub MultiSafepay icons .

How to order payment methods in your checkout

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.

How to disable payment methods

You can disable payment methods in the Payment method settings list. The dot next to the payment methods is green when enabled, and grey when disabled.

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 for 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 dashboard 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.
How to remove payment methods

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

  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.

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 .

Refunds

Full and partial refunds and credit notes are supported in your MultiSafepay dashboard and backend.
You can't refund more than the original amount in your backend.

How to enable refunds in your backend
  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 dashboard are not reported back to Lightspeed. Under Offline actions, an error appears: "Already a completed transaction".
  • Some BNPL orders:
    • 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.
    • 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.

Single sign-on

Lightspeed single sign-on lets you sign in to the app's Settings directly from the Lightspeed eCom store. You don't need to click or tap the Login button.

How to use Lightspeed single sign-on
  1. Sign in to the Admin section of your Lightspeed store.
  2. In the sidebar, click Apps.
  3. Click Purchased apps.
  4. In the sidebar, click Apps.
  5. Click MultiSafepay Payments, or to take you straight to the store page, paste /admin/store/apps/1517 after the base URL of your store.
  6. On the store page, click Go to app / Ga naar app.

Surcharges

How to apply surcharges
  1. Sign in to your Lightspeed app.
  2. Go to App > Purchased app > MultiSafepay app.
  3. Select the payment method you want to apply a surcharge to.
  4. Enter the surcharge amount as a:
    • Fixed amount under Flat payment fee, or
    • Percentage under Dynamic payment fee.
  5. Click Save.

⚠️

Attention Dutch merchants

We strongly recommend not applying surcharges to BNPL orders. 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 don't need to manually update the app.

Upgrades

We recommend upgrading from our deprecated core integration to the Lightspeed app.

How to upgrade to the new app
  1. In the Lightspeed app manual, follow the steps to install the app.
  2. Place a test order to make sure it's working properly.
  3. Open the core integration, 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.
How to disable the core integration
  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.


💬

Support

Contact MultiSafepay:

Top of page


Did this page help you?