This guide explains how to set up Toggle gift cards on Lightspeed, covering the required steps for both your Toggle and Lightspeed accounts.
Part 1: The Toggle set up
These steps need to be done on Toggle.
Summary of what to do:
☑️Add your sites on Toggle
☑️Create an API
☑️Create a webhook
☑️Add your Lightspeed site references (Location IDs)
1 - Add Sites in Toggle
If you already have your sites set up on Toggle please skip this step.
Log in to Toggle and go to Settings > Site Settings.
Add each site with its name, address, and a reference number (the reference number can be any number or word)
Repeat for all sites.
Example below:
2 - Create API
Please note: Only Store Owner users can perform this step.
Go to Settings > Integrations > Lightspeed
Click Create New User (blue button)
Copy the Username into a secure document
Copy the Password into a secure document
Tick the 'I've taken a note...' box and then click Create (blue button) to save the API
Brief demo:
3 - Create Webhook Config
Please note: Only Store Owner users can perform this step.
On the same page as above:
Click Create webhook config (blue button)
Copy the Username into a secure document
Copy the Password into a secure document
Tick the 'I've taken a note...' box and then click Create (blue button) to save the API
Brief demo:
You'll see both your API and webhook saved on your dashboard like this after these two steps are done, like in the example below:
4 - Add Lightspeed site references
You will need to ask your Account Manager at Lightspeed for your site references (also known as 'Lightspeed business location IDs').
When you have them add them to the respective sites listed on your Toggle dashboard on Settings > Integrations > Lightspeed.
After adding them, click the green Save button.
Example below:
Part 2: The Lightspeed set up
These steps need to be done on Lightspeed (K series) manager.
Summary of what to do:
☑️Add payment method
☑️Hide payment method
☑️Create a Gift Card Item
☑️Set up Web Extension
☑️Add Toggle Button to menu
1 - Add payment method
You'll need to make Toggle gift cards a payment type.
Click on Settings > Payment methods
Click Add a payment method (blue button)
Payment method type - put "Other payment method"
Code - make this "toggle"
Name - make this "Toggle Card"
Example below:
2 - Hide payment method
After completing the above step you now need to hide that payment method.
Click Settings > Configurations > Fixed POS
Click Payments
Click Toggle Card (this will unselect it and make it grey)
Press Save
You can check this change has worked by seeing if 'Toggle Card' isn't in the list of payment options when closing a Lightspeed transaction.
3 - Create a Gift Card item
Go to Menu Management > Items
Click the 'Create' button and click 'Single item'
Create an item named 'Toggle Gift Card',
Then click 'Change Price Type' and select 'Manually-entered price'.
Click 'Enter custom SKU' and enter: toggle-giftcard-4712
Click Save.
For 'Accounting Group' select the option you'd prefer.
After saving, click on a different page from the side bar and then go back to Menu Management > Items and click on 'Toggle Gift Card' (the one you've just made). The URL of that page now contains a 15-digit number after '...items/
Example below:
Copy this number and paste it into a separate document (e.g. a Word document) as you'll need that number for the next step below.
4 - Set up Web Extension
Go to Configuration > Settings > Web Extension
Click 'Add new web extension'.
Complete the set up as following:
Name: [Anything you like!]
URL: Copy and paste the below URL, and then add the 15 digit number you have already copied from step 3 above to the end, after the '='
Tick the box 'Provide a JavaScript context to the loaded page'
On the "Authentication (optional)" section:
Add the API user name and API password you generated earlier (on the step 2 of the Toggle setup part above). Ensure it's the API username and password, not the webhook username and password.
Click Save.
Example below:
5 - Add Toggle Button to menu
Next you need to add the Toggle button to your menu so your servers can see it.
Head to Menu Management > Menu, and select where in your menu you want the button to show.
When you've chosen this, click Add button > Web extension
Select your Toggle Gift Card web extension
Part 3: The Lightspeed Account Manager set up
Now you have completed Part 1 and Part 2 on your dashboards, you will need to ask your Lightspeed Account Manager to help with this final part before you can start testing the integration.
The below table and the webhook you created on Part 1 of the Toggle set up (detailed above) will need to be sent to your Account Manager at Lightspeed.
Please ask them to set up 'Real Time Notifications' with the following details:
Partners Data |
|
Name of the integration | Toggle x K-Series |
Requester |
|
Customers Data |
|
Business | Business ID |
Business Location(s) | All locations (unless you want to restrict usage of Toggle to certain location. If this is the case, only send location IDs that are relevant) |
Name of the Account | Business Name |
Settings |
|
Code |
|
URL | |
Condition (please specify which one is required) | this.notificationType=='CLOSE' || |
Authentication (optional) |
|
User name | WEBHOOK USERNAME (we recommend sending this securely rather than in the body of the email) |
Password | WEBHOOK PASSWORD (we recommend sending this securely rather than in the body of the email) |
Wait until you have received confirmation that Lightspeed have set this up, then we recommend you run a full end-to-end test of selling and redeeming gift cards.
Part 4: Testing the integration
After all the above parts are completed, to check gift cards work on Lightspeed we recommend you try:
Redeeming a gift card (you can send yourself a free voucher from your Toggle dashboard to use as a 'test')
Selling a gift card (if you have physical cards to sell)
If you have questions or issues using gift cards on Lightspeed get in touch with us.
For more info about how to use Toggle gift cards on Lightspeed see our guide here: Using Lightspeed on Toggle
FAQs
Can I sell and redeem gift cards on Lightspeed?
Yes - once all the set up has been completed, you can sell and redeem gift cards on Lightspeed.
How do I refund a gift card?
Sometimes you'll need to issue a refund for a gift card. To do this, you will need to refund back onto the guests payment card or with cash. You can't refund money back onto a gift card directly through Lightspeed.