Developer
Test ModeTest Mode Sign In Get started
DeveloperDeveloper / Scan & Go APIScan & Go API

Scan & Go APIScan & Go API

Scan & Go ermöglicht Kunden, Produkte mit dem Smartphone zu scannen und per App zu bezahlen. Diese Endpoints steuern den gesamten Checkout-Flow.

Scan & Go lets customers scan products with their smartphone and pay in the app. These endpoints control the entire checkout flow.

⚠️
Scan & Go Endpoints erfordern mindestens das GROW-Paket. Test-Key-Aufrufe funktionieren immer (Sandbox-Daten).

POST /api/v1/checkIn

Startet eine Scan & Go Session. In der BEEP!-App scannt der Kunde den QR-Code im Store.

Starts a Scan & Go session. In the BEEP! app the customer scans the store QR code.

Request Body

ParameterTypPflichtBeschreibung
storeIdstringJaID des Stores
userIdstringJaID des Kunden (Consumer-App)
200 OK
{ "success": true, "sessionId": "sess_sandbox_1740650400000", "storeId": "sandbox_store_001", "checkedInAt": "2026-02-27T09:40:00.000Z" }

POST /api/v1/startCheckout

Startet den Checkout-Prozess. Erstellt eine Stripe-Payment-Session und gibt die Checkout-URL zurück.

Starts the checkout process. Creates a Stripe payment session and returns the checkout URL.

Request Body

ParameterTypPflichtBeschreibung
userIdstringJaKunden-ID
storeIdstringJaStore-ID
sessionIdstringJaSession-ID aus checkIn
currencystringJa"EUR"
destinationstringNeinPSP-Account-ID (Stripe Connect)
itemsarrayJaProdukt-Array mit name, priceUnit (Cent!), quantity, vat
📌
priceUnit ist immer in Cent (Integer). vat ist 7 oder 19 (Prozent). In der Sandbox wird kein echter Stripe-Checkout erstellt.

POST /api/v1/fetchPurchase

Ruft Details eines einzelnen Einkaufs ab, inklusive Items, Kassenbondaten und TSE-Signatur.

Fetches details for a single purchase, including items, receipt data and TSE signature.

ParameterTypPflichtBeschreibung
purchaseIdstringJaID des Einkaufs

POST /api/v1/fetchPurchaseHistory

Gibt eine Liste der letzten Einkäufe für einen Store oder User zurück. Ideal für Statistiken und Beleg-Übersichten.

Returns a list of recent purchases for a store or user. Ideal for statistics and receipt overviews.

ParameterTypPflichtBeschreibung
storeIdstringNeinFiltert nach Store
userIdstringNeinFiltert nach User
limitnumberNeinMax. Anzahl (Default: 20)

AblaufFlow

  1. Check-in: Kunde scannt QR-Code → checkIn → Session-ID
  2. Scanning: Kunde scannt Produkte (läuft in der App, kein API-Call nötig)
  3. Checkout: startCheckout → Stripe Payment Link
  4. Zahlung: Kunde bezahlt über Stripe → Webhook checkout.completed
  5. Beleg: fetchPurchase → TSE-signierter Kassenbon