Documentation
Documentation
Docs

1Connecting with Lightspeed eCom

To use the Lightspeed eCom integration please proceed as follows:

  1. Select the app from the Lightspeed eCom marketplace.

  2. Click on the install button. You will now be redirected to your Lightspeed eCom store to login and grant us access.

  3. After you have granted the permissions, you will be requested to authenticate. If you don’t have an account yet, please use the signup button to create one.

  4. When the installation of the app is successful, you should see the Lightspeed eCom integration with the options you can use.

  5. Invoice settings can be found in your Lightspeed eCom store back office. The invoice creation method should be set to Paid or Direct. If the Manual create method is set, the order state will not be updated automatically.

Lightspeed eCom Store Back Office - Invoice Settings
Figure 1. The invoice creation method setting in Lightspeed eCom store.

This is all that is necessary. The payment method’s name, description, etc. are now synchronized automatically to Lightspeed eCom. Make sure that you have selected your payment processor.

2Transaction Maintenance

Please note that it is not possible to capture and refund payments from the Lightspeed eCom admin area.

All maintenance operations for refunds and captures have to be done within your VR Payment account.

3Order Status Handling

The order status in Lightspeed eCom is automatically updated based on the payment status of the order.

When a user is redirected to VR Payment, the payment status is initially set to PENDING. Once the transaction reaches the FULFILL state, the payment status is updated to PAID.

Depending on the type of product in the order, the order is then marked either as ready to be shipped (for physical products) or ready for download (for digital products).

If the transaction is marked as DECLINED or VOIDED, the order status is set to CANCELLED. This ensures that the buyer cannot reattempt the payment for the same order through their Lightspeed eCom account.

3.1State Graph

The diagram below shows the state machine of Lightspeed eCom orders, including additional information for the state transitions.

Lightspeed eCom orders - State transitions
Figure 1. State transitions for Lightspeed eCom orders.

4Payment Method Adjustments

Lightspeed eCom updates the displayed payment methods directly from VR Payment. This means any payment method configured is automatically available in Lightspeed eCom. The names of the payment methods and their icons can be configured in the payment method configuration.

Lightspeed eCom is not updating the payment methods on each reload of the payment method selection page. As such you might need to restart the checkout process to see the updates.

5Payment Method Fees

Each payment method allows to have an additional payment fee (payment cost). The calculation of the fee depends on the total amount with a percentage of it or the fee can be a fixed amount. There must be at least one payment method configured otherwise no fee can be assigned to it.

Lightspeed eCom Store - Payment method fee
Figure 2. The payment method fee on the Lightspeed eCom checkout page.
Important

Payment Method Fees: Lightspeed eCom provides the ability to set fees for different payment methods.

In the Upgraded Checkout, these fees are applied exclusively to regular products and shipping, excluding gift cards.

In the Legacy Checkout, fees are applied to all products.

6Gift Cards

Gift cards are a popular and practical option—more personal than cash and an easy choice for any occasion.

You can take advantage of their popularity by making it simple for customers to purchase and redeem gift cards with your business, both in-store and online. You have full control over where gift cards are sold and how they can be redeemed.

Get started by configuring your gift card settings in your Lightspeed eCom store.

Lightspeed eCom Store - Purchased gift card line item
Figure 3. The purchased gift card on the Transaction Line Items.
Lightspeed eCom Store - Applied gift card line item
Figure 4. The applied gift card code on the Transaction Line Items.
Important

If your cart contains gift card products, your Lightspeed store must be configured for automatic invoice creation (DIRECT-Standard mode).

Without this setting, payments cannot be processed, and order creation will fail.

Make sure to enable DIRECT mode in your store settings to ensure a smooth checkout experience.

Required Action:

To edit invoice settings in your Lightspeed eCom back office:

  1. Login to Lightspeed eCom Admit store.

  2. Navigate to Settings > Administration.

  3. In the Invoices section, select Direct from the Create dropdown.

  4. Click Save.

For more information on configuring invoice settings in Lightspeed eCom, consult the official Lightspeed eCom documentation.
Warning

Gift Card Cancellations: When a customer begins a checkout using a gift card but then cancels the process, Lightspeed eCom may incorrectly mark the gift card as redeemed.

This limitation is known, and Lightspeed eCom is currently addressing it.

6.1Refund a gift card (in Lightspeed eCom)

Currently, refunding a customer for a gift card they purchased is not supported in Lightspeed eCom store.

However, it is possible to refund your customer in Lightspeed eCom by:

  1. Canceling the gift card

  2. Creating a unique discount code

See more: Refunding gift cards purchased online in Lightspeed eCom

6.2Refund a gift card (in VR Payment)

You have the possibility to refund already completed transactions, from the VR Payment. In order to do so, open the completed transaction. By clicking on Refunds the window for refunds will show.

Note
 Ensure that the connector which processed this payment supports the refund feature. In order to check that have a look at the processor list and check the connector of a processor.

You can carry out as many individual refunds as you wish until you have reached the quantity of the original order.