All Collections
Integrations, API & POS Mode
EPOS
How to connect Orbis with Toggle
How to connect Orbis with Toggle
Stephen Evans avatar
Written by Stephen Evans
Updated over a week ago

Note: Only Store Owner users can create the API on Step 2.

Summary

  1. Add your site(s) to Toggle

  2. Create an API on Toggle

  3. Send the API details to Orbis

  4. Add Orbis's site IDs to Toggle

  5. 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.

  1. Log in to Toggle

  2. On the sidebar click Settings > Site Settings

  3. Add the site name, its address, and any number or reference for it

  4. Click add

  5. 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).

  1. Log in to Toggle

  2. On the sidebar click Settings > Integrations > Orbis

  3. Click create new user

  4. 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 Orbis 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 Orbis Account Manager.

  1. Copy the table below into something like a Word document

  2. Add the API username and password to it

  3. Password protect the file for security

  4. Send the file to your Orbis Account Manager asking them to configure your tills

  5. Ask your Orbis Account Manager for your site IDs

API endpoint:

Username:

(add the username you create here)

Password:

(add the password you create here)

Merchant ref:

3

Card range:

63011900

Card length:

19

Step 4: Add site IDs to Toggle

Whilst your Orbis Account Manager does the relevant configuration using your API details, add the site IDs they sent you to Toggle.

  1. Log in to Toggle

  2. On the sidebar click Settings > Integrations > Orbis

  3. Paste in each ID to their respective site

  4. Save

The site IDs allow the Orbis 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 Orbis Account Manager has confirmed they've configured your tills it's good to check vouchers do work.

We recommend you:

  1. 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 Orbis so we can help troubleshoot it.


If you need help or have questions please contact our support team at success@usetoggle.com.

Did this answer your question?