Note: Only Store Owner users can create the API on Step 2.
Step 1: Add your site(s) on Toggle
The sites you'll be redeeming gift cards at need adding to Toggle. This step might already be done, but it's worth checking.
Log in to Toggle
On the sidebar click Settings > Site Settings and click Add site
Add the site name, its address, and any number or reference for it
Click the green Add button to save the site
Repeat this step for however many sites you need to add.
If needed here's more info on how to add sites.
Example below:
Step 2: Create an API on Toggle
If needed here's more info on how to create the API (video included).
Log in to Toggle
On the sidebar click Settings > Integrations > Syrve
Click create new user
Copy the API username and then copy the password to this spreadsheet
Once copied across press Create to save the API*
β οΈ *Once you click create you can't retrieve the API password again. If you accidentally created the API without noting it down the password just re-start the above steps to make a new one.
π§ You only need one API for your Toggle account that can be used at all your sites that use Syrve.
Example below of creating the API username and password:
β
Product ID and Account ID
You'll need to send Syrve your Toggle product ID, product name and Account ID along with the API. You can add these to the same spreadsheet.
Pick what gift card product you want Syrve to link to on their system. You could pick your 'generic' gift card such as 'Your band name + gift card' like demonstrated below.
Example below:
Your Account ID is found on the account details section of your dashboard sidebar.
Example below:
After you have completed these steps your spreadsheet will look a bit like this -
The parts highlighted in blue shouldn't be edited or deleted - Syrve will use that info to complete their configuration later on.
Step 3: Send the API, product ID and Account ID to Syrve and ask for your store IDs
You'll need to send the API username and password you created on Step 2 along with your in-store product ID and Account ID to your Syrve Account Manager.
Ask your Syrve Account Manager for your store IDs during this stage too.
Please also remember to:
π Password protect your file containing the API for extra security when sending it to Syrve. Don't send the API username and password to Syrve within the email itself - hackers can potentially get hold of that info in the future.
One option here is you could password protect your file and text the password to your Syrve Account Manager to access the spreadsheet.
π§ Keep your API filed saved somewhere secure on your device in case you ever need to refer back to it in the future.
Example email to send to Syrve:
β
Step 4: Add site IDs to Toggle
Whilst your Syrve Account Manager configures your tills using your API details, add the site IDs they sent you to your Toggle account.
Log in to Toggle
On the sidebar click Settings > Integrations > Syrve
Paste in each ID to their respective site
Save
The store IDs allow the Syrve and Toggle system to know where a gift card was sold or redeemed at. Without these IDs in Toggle your integration won't work.
Example below of adding the site IDs to Toggle:
Step 5: Test the integration works
Once your Syrve Account Manager has confirmed they've configured your tills it's good to check vouchers do work.
We recommend you:
Send yourself a free of charge digital voucher
Use the voucher code on the till to see if it works (e.g. redeem/reverse, and check balance)
π§ Other people on your team may benefit from seeing how gift vouchers works during this stage.
βIf an error is flagged on the till, get in touch with Toggle and Syrve so we can help troubleshoot it.
Our other guide Using Toggle on Syrve POS may also be useful.
The Syrve set up
Note: This is usually done by your Syrve Account Manager. However, if you are self-managing your installation, this guide will help you configure your Syrve POS to work with Toggle.
There is also some setup required in Syrve. You will need to create the products / buttons for the Toggle options on the POS.
Please contact your Syrve account manager for information on setting these up.
Integration Setup
This setup will need to be complete in Syrve's system.
ToggleUsername = This is the API username created as per step 2 above
TogglePassword = This is the API password created as per step 2 above
ToggleMerchantId - This should be
41
ToggleReplenishProductNumber - Ask your Syrve contact to get these IDs
ToggleCreateProductNumber - Ask your Syrve contact to get these IDs
ToggleProduct - This should the exact product name from your Toggle dashboard
β
If you need help or have questions please contact our support team at success@usetoggle.com.
β