Toggle Developers
HomeAcademy
  • Welcome
  • GraphQL
    • Getting started
    • Exploring our API
    • Authentication
    • API playground
    • Error handling
  • Key concepts
    • Overview
      • Orders, Transactions & Line Items
      • Card number formats
  • Basics
    • Create a card
    • Check a card balance
    • Redeem a card
  • Webhooks
    • Overview
      • Getting started
      • Authentication & responses
    • Events
      • Card.balance_adjusted
      • Card.card_reference_updated
      • Card.expiry_reminder
      • Card.registered
      • Card.send_recipient_email
      • Card.resend_recipient_email
      • Order.created
      • Order.cancelled
      • Order.send_receipt_email
      • Order.send_cancellation_email
      • Payment.failed
      • Payment.review_opened
      • Fulfilment.dispatched
  • Partner Guides
    • EPOS & Ordering
      • Overview
      • Accreditation
      • Configuration variables
      • Playground examples
      • Physical card orders
      • Custom validity rules
      • Balance check
      • Redemptions & top-ups
      • Reversals
    • Guest gratuity
      • Overview
      • Accreditation
      • Configuration variables
      • Playground examples
      • Creating a card
      • Cancelling a card
      • Register a card
    • CRM
      • Overview
      • Historic data via GraphQL
      • Real time data via webhooks
Powered by GitBook
On this page
  1. Partner Guides
  2. EPOS & Ordering

Configuration variables

PreviousAccreditationNextPlayground examples

Last updated 3 years ago

Your application will need to keep a configuration of variables to use for each distinct Toggle account (e.g. for each of our mutual shared customers/clients).

These are summarised below.

Variable

Description

sales_channel_id

For POS integrations, use 3 as the sales_channel_id when creating orders – this is a permanent ID used across all accounts for in-store transactions.

fulfilment_method_id

Used when creating orders, for in-venue physical card orders, this can always be configured as 3 (In-venue)

If you issue digital cards from your application, this would be 1 (Email)

currency_id

Default to 1 (£ sterling), but leave this as something that can be configured as well, this will ensure the integration is future-proofed to handle other currency IDs in future.

account_id

account_id will be manually configured, and will be provided during onboarding of a new mutual customer. Email to request an account_id.

merchant_id

This identifies you as an an approved merchant on our platform. Email to request this.

unit_epos_reference

This refers to the unique till ID, passed to Toggle so it knows the location where the transaction was made. This needs to be matched with the configured EPOS references in each Toggle customer's account. See .

merchant_transaction_reference

This refers to the unique reference created by the till when the transaction is made. You will generate and pass this to our API when handling transactions.

support@usetoggle.com
support@usetoggle.com
here for more information