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 (video included).
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 > Comtrex
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 Comtrex.
Example below of creating the API username and password:
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 - Comtrex will use that info to complete their configuration later on.
Step 3: Send the API to Comtrex and ask for your site IDs
You'll need to send the API username and password you created on Step 2 to your Comtrex Account Manager.
Ask your Comtrex Account Manager for your site IDs during this stage too.
Please also remember to:
🔐 Password protect your file containing the API for extra security when sending it to Comtrex. Don't send the API username and password to Comtrex 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 Comtrex 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 Comtrex:
Step 4: Add store IDs to Toggle
Whilst your Comtrex 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 > Comtrex
Paste in each site ID to their respective site
Save
The site IDs allow the Comtrex 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 Comtrex 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 Comtrex so we can help troubleshoot it.
Our other guide Using Toggle on Comtrex POS may also be useful.