Skip to main content

Integrate a New POS

This guide walks through integrating a new point-of-sale or self-checkout (SCO) terminal type with My-Scan, so a shopper can finish scanning on their device and pay at your till. For the conceptual model, see Business Flows: POS Handover; for the full operation set, see APIs: POS API.

This guide describes the Cloud host environment — see Architecture for how OnPrem differs (e.g. monitoring events and SSA forwarding are Cloud-only).

Prerequisites​

  • A bearer token and Tenant-Id, as described in Quick Start: Prerequisites.
  • A way to resolve which basket belongs to the shopper at your terminal — by basket ID, by customer, or by a POS/workstation mapping your integration establishes.

1. Download the finalized ticket​

When the shopper hands off to your POS/SCO for payment, call the download endpoint for their basket. This returns the finalized ticket — items, prices, any applied promotions, and the total amount to pay — and removes the basket from My-Scan's active state.

A basket cannot be downloaded while a payment is already in progress (e.g. the shopper is paying directly on their device via Softpay) — My-Scan rejects the download to prevent the same basket being paid twice. Your integration should treat this as an expected, retryable condition rather than a hard failure: surface it to the operator and let them retry once the in-progress payment resolves.

2. Process the payment​

Process the payment using your own POS/SCO payment flow — My-Scan has no involvement at this stage.

3. Upload the transaction result​

After payment completes, upload the transaction result back to My-Scan. This single call:

  • Publishes a basket monitoring event, so staff-facing tools reflect the finished trip — see Operations: Attendant.
  • Forwards the transaction to Self-Service Analytics for reporting — see Operations: Dashboards (SSA).
  • Cleans up any remaining POS/customer index mappings your integration relied on to resolve the basket in step 1.

Reference​