POS System Integration
Overview
Section titled “Overview”Transpeye integrates with point-of-sale (POS) systems to receive live transaction data. This transaction data is cross-referenced with the camera feeds assigned to each till, enabling the platform to detect anomalies such as no-sale events, refund irregularities, or discrepancies between observed behaviour and recorded transactions.
Transpeye currently supports three POS systems:
| POS System | Connection Method |
|---|---|
| Kounta | OAuth 2.0 authorisation flow |
| Vend | OAuth 2.0 authorisation flow |
| Lavu | Direct API credentials (key and secret) |
This guide explains how to connect each POS system to the active customer account. You must be operating in the relevant customer’s context before configuring POS integrations.
Step-by-Step Guide
Section titled “Step-by-Step Guide”Step 1: Confirm Till Records Exist
Section titled “Step 1: Confirm Till Records Exist”Before connecting a POS system, verify that till records have been created in Transpeye for the customer account. The integration links incoming transaction data to specific till records. If till records do not exist, transaction data will arrive but cannot be attributed to a physical location.
See Cameras, Tills, and Agents for instructions on creating till records.
Step 2: Connect Kounta via OAuth
Section titled “Step 2: Connect Kounta via OAuth”Kounta uses an OAuth 2.0 authorisation flow to grant Transpeye access to the customer’s Kounta account. You will need the customer’s Kounta login credentials, or access to the Kounta account with an admin user who can approve the authorisation.
- Navigate to the POS Integration settings for the active customer account.
- Select “Connect Kounta”. Transpeye redirects your browser to the Kounta authorisation page.
- Log in to the customer’s Kounta account if prompted.
- Review the permissions requested by Transpeye and select “Authorise” or “Allow Access”.
- Kounta redirects your browser back to Transpeye via the OAuth callback URL. Transpeye captures the authorisation token automatically and confirms the connection.
Note: The OAuth callback is handled automatically. Do not close the browser window or navigate away during the redirect. If the redirect does not complete within 30 seconds, check that the customer’s Kounta account has sufficient permissions to authorise third-party applications and try again.
Once connected, Kounta transaction data begins flowing into Transpeye. Allow up to 15 minutes for the first transactions to appear in the analytics views.
Step 3: Connect Vend via OAuth
Section titled “Step 3: Connect Vend via OAuth”The Vend connection process follows the same OAuth 2.0 flow as Kounta. Vend calls their connection interface “Retailer OAuth”.
- Navigate to the POS Integration settings for the active customer account.
- Select “Connect Vend”. Transpeye redirects your browser to the Vend authorisation page.
- Enter the customer’s Vend store domain when prompted (for example,
yourstore.vendhq.com). - Log in to the customer’s Vend account and approve the access request.
- Vend redirects back to Transpeye. The OAuth token is captured and the connection is confirmed automatically.
Note: Vend requires the store domain to be entered before the OAuth redirect. Obtain the exact Vend domain from the customer before starting this process. An incorrect domain results in a failed redirect.
Step 4: Connect Lavu via API Credentials
Section titled “Step 4: Connect Lavu via API Credentials”Lavu does not use OAuth. Instead, it provides an API key and API secret that you enter directly into Transpeye.
- Ask the customer or their Lavu administrator to provide the API Key and API Secret from their Lavu account settings. These are available in the Lavu back-office under API settings.
- In Transpeye, navigate to
/update_lavu_credentials. - Enter the API Key in the designated field.
- Enter the API Secret in the designated field.
- Select “Save” or “Update Credentials” to store the credentials.
Transpeye immediately attempts to validate the credentials against the Lavu API. A confirmation message indicates whether the connection was successful. If the validation fails, double-check that the API key and secret were copied exactly as provided — Lavu credentials are case-sensitive and must not contain leading or trailing spaces.
Note: Lavu API credentials are stored securely in Transpeye’s encrypted credential store. Do not share these credentials via email or chat. If credentials are compromised, request new credentials from Lavu and update them in Transpeye immediately.
Step 5: Verify Transaction Data is Flowing
Section titled “Step 5: Verify Transaction Data is Flowing”After connecting any POS system, verify that transactions are being received:
- Open the Transactions or Analytics view for the customer account.
- Allow up to 15–30 minutes after the initial connection for the first transactions to appear.
- Confirm that transaction records show the correct till assignments. If transactions are appearing as unassigned, review the till mapping configuration.
- Complete the OAuth flow in a single browser session. OAuth authorisations time out. Begin the flow only when you have uninterrupted access to the customer’s POS credentials and can complete the authorisation in one go.
- Use the customer’s primary admin account for OAuth. Some POS systems restrict OAuth authorisations to administrator-level users. Using a restricted staff account may result in an authorisation error.
- Test with a known transaction. After connecting a POS system, ask the customer to process a small test transaction (or identify a recent real transaction). Verify it appears in Transpeye within the expected timeframe to confirm the integration is working end-to-end.
- Lavu credentials should come directly from the customer’s IT contact. Do not attempt to generate or retrieve these from the Lavu portal yourself, as doing so may overwrite the customer’s existing credentials and disrupt their other integrations.
- Document which POS system is connected. Note the connection date in your account records. This is useful context when investigating data gaps or troubleshooting anomalies at a later date.
Troubleshooting
Section titled “Troubleshooting”The OAuth redirect did not return to Transpeye. This can occur if the redirect URI is blocked by the POS system’s settings, if the browser has a strict pop-up or redirect policy, or if the session timed out. Try the authorisation flow again in a standard browser window (not a private or incognito session). If the problem persists, contact Transpeye support to verify the OAuth callback URL is correctly registered with the POS provider.
Kounta or Vend shows as connected but no transactions are appearing. Confirm that the customer’s POS system is actively processing transactions. Check that the correct store or outlet is authorised — some POS systems require you to specify which outlets Transpeye can access during the OAuth flow. Review the POS integration settings and re-authorise if necessary.
Lavu credentials are not being accepted. Verify the API key and secret with the customer’s Lavu administrator. Ensure there are no extra spaces before or after either value. If the credentials were recently regenerated in Lavu, update them in Transpeye immediately, as old credentials are invalidated when new ones are issued.
Transactions are appearing but are not matching the expected tills. Review the till naming or identifier mapping between Transpeye and the POS system. In some configurations, Transpeye matches incoming transaction data to till records using a POS-side identifier. If the till names in Transpeye do not match the register names in the POS system, the attribution will fail. Edit the till records to align the naming conventions.
I need to disconnect or re-authorise a POS integration. Navigate to the POS Integration settings for the customer account and locate the option to revoke or refresh the connection. For OAuth systems, you may need to re-authorise rather than simply refresh. For Lavu, update the credentials with the new key and secret.