Note: Only Store Owner users can create the API on Step 2.
Summary
Add your site(s) to Toggle
Create an API on Toggle
Send the API details to Syrve
Add Syrve's site IDs to Toggle
Test if a gift voucher works at your site(s)
Step 1: Add your site(s) on Toggle
If needed here's more info on how to add sites (video included).
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
Add the site name, its address, and any number or reference for it
Click add
Repeat this step for however many sites you need to add
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 username and password onto a separate document and press create
Once you click create you can't retrieve the API password again so that's why we recommend saving it in a separate document.
Step 3: Send the API to Syrve and ask for your site IDs
You'll need to send the API username and password you created on Step 2 along with the info below to your Syrve Account Manager.
Copy the table below into something like a Word document
Add the API username and password to it
Password protect the file for security
Send the file to your Syrve Account Manager asking them to configure your tills
Ask your Syrve Account Manager for your site IDs
API endpoint: | |
Username: | (add the username you create here) |
Password: | (add the password you create here) |
Merchant ref: | 41 |
Product name: | See info below! |
Product Name - the exact name of the product from Toggle you wish to associate gift cards to should be provided to Syrve. This could be the default 'in-store gift' or the product name of a digital gift card you've created on the dashboard.
Step 4: Add site IDs to Toggle
Whilst your Syrve Account Manager does the relevant configuration using your API details, add the site IDs they sent you to Toggle.
Log in to Toggle
On the sidebar click Settings > Integrations > Syrve
Paste in each ID to their respective site
Save
The site 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.
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 it, check balance)
Other people on your team may benefit from seeing how gift vouchers works durng 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
41ToggleReplenishProductNumber - 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.