Before we get started with the integration stuff, if you'd like to find out more about how things work between your EPOS and Toggle please read our EPOS FAQs guide.
If you'd like to go straight to the relevant EPOS you're using for more details about that integration, you should be able to find it on our integrations guide page.
📋Summary of how to integrate Toggle with your EPOS
To get your Toggle account(s) connected to your EPOS you need to do the following:
Add your sites to your Toggle account
Create an API on your Toggle account
Send the API details securely to your EPOS Account Manager
Add the relevant site IDs to your Toggle account
Test out a Toggle gift card on your EPOS to check it works as expected
👉Step 1: Add your sites to your Toggle account
Add in the site names and references where you'll be redeeming your gift cards into your Toggle account. There's a few reasons why adding your sites in is important - why set up sites in Toggle?.
To do this:
Go to Settings > Site settings.
Click Add site
Enter Site name and Site reference
Click Add
What should the site name be? Usually this can be the town or city the venue is located, and the street name as well if it makes identification easier in your reporting. Some EPOS providers have specific names you can use, however.
What should the site reference be? Use your own internal site ID (if you have them) or just enter in any number or letters/ words (you can always go back and edit this later).
With exception of Access POS, what numbers or words you use on this section are arbitrary and for your own internal reference.
👉Step 2: Create an API on your Toggle account
The connection between your Toggle account and your EPOS is done using an ‘API’. This essentially creates a bridge between them both so that when a Toggle gift card number is processed on your EPOS, it knows if that gift card number is legitimate and how much balance it has.
To do this:
Go to Settings > Integrations > (click the relevant partner tile)
Click on Create new user (blue button)
Click Copy (blue button) to copy the Username, and paste this in a document
Click the Copy (blue button) to copy the Password, and paste this in a document
Tick the ‘I’ve taken a note of this password and this user will have full access to my Toggle account’ prompt and press Create.
⚠️It’s important that you do copy/ paste and then save the API username and password into a separate document because these details can’t be retrieved again after you click ‘create’. If you do lose the username and password, you’ll need to repeat the above steps and create a new API.
💡We recommend you also use a password manager to save these details on, and share them with any relevant people within your organisation so they can also access them in the future if needed. (The only likely time you might need to see these details again is if your EPOS Account Manager requests them for troubleshooting purposes).
If you have multiple Toggle accounts set up for each site or brand you may have, this process needs to be done on each account.
👉Step 3: Send the API details securely to your EPOS Account Manager
Once the API username and password are saved, email them to your EPOS Account Manager.
We recommend you send the API details to your EPOS Account Manager securely (i.e. in a password protected file or email) where possible, just for some layer of security due to the API password that’s included.
***Depending on the EPOS provider you use, there might be other details they need from you besides the API username and password. To make step 3 easier for you we have created a downloadable Excel file with the additional information your EPOS Account Manager might need for their integration. Please refer to the relevant EPOS support articles here***
👉Step 4: Add the relevant site IDs to your Toggle account
In the same email you're sending the API details to your EPOS Account Manager, ask the for the site IDs so you can add them to your Toggle account. (Without these the integration won't be fully completed).
To add the site IDs:
Go to Settings > Integrations > (click the relevant partner tile)
Click on the Epos site reference field
Type in EPOS reference and press Save
👉Step 5: Test a Toggle gift card on your EPOS to check it works as expected
Once your EPOS Account Manager has confirmed they have done the integration set up on their side, and you've followed the above steps, it's good practice to check if Toggle gift cards work at the EPOS. This means we can troubleshoot any errors that are flagged before you have any real customers visiting you with their gift card!
A good way to do this is to:
Create a free of charge digital gift card on your Toggle account
Use the unique code from the digital gift card email and test it on your EPOS
If an error is flagged when entering the code (or scanning the QR code if you have them enabled on the digital card), let your EPOS Account Manager know and loop in Toggle support as well (success@usetoggle.com).
Another good thing about doing step 5 is it gives your staff a chance to:
a. practice a redemption, balance check, reversal etc so they're clued up on how gift cards work
b. see how your Toggle digital gift cards look as well so staff are familiar with them