Voor developers

Boekingen afrekenen vanuit een ander kassasysteem

Laat een extern kassasysteem lezen wat een boeking kost en de verkoop terugsturen, zodat de boeking wordt afgerond.

Wat het is

De checkout-overdracht is één adres met twee aanroepen: GET en POST /api/v1/{slug}/appointments/{id}/checkout. GET geeft terug wat de boeking kost: elke dienst en extra met de lineId en wie hem deed, de prijs, kortingen, belastingregels, de aanbetaling die al betaald is, en dueCents, precies het bedrag dat je moet innen. POST legt de verkoop vast die je kassasysteem deed, rondt de boeking af en koppelt de verkoop eraan, en draait daarvoor dezelfde afrekencode als de eigen kassa van Bookatu.

Waarom het helpt

Niemand slaat een bezoek twee keer aan, en de boeking, de verkoop, wat medewerkers op hun naam krijgen en het geld kloppen in Bookatu alsof de eigen kassa het had afgerekend. Posten is idempotent op je externalSaleId, dus een nieuwe poging na een verbroken verbinding geeft replayed: true terug en schrijft niets.

Zo gebruik je het

  1. 1Eigenaren en admins maken de sleutel in Settings, daarna API & monitoring, onder API keys. Vink in What this key may do beide vakjes aan op de rij Checkout at another point of sale: See what a booking comes to at checkout (checkout:read) en Check bookings out from another point of sale (checkout:write). Ze staan uit tot je ze aanvinkt, en een sleutel van vóór de scopes heeft ze nooit. Wie de sleutel maakt, moet ieders agenda kunnen zien (voor checkout:read) en de agenda kunnen bewerken (voor checkout:write). Voeg See bookings (bookings:read) toe om de boekingen van de dag op te halen met GET /appointments, en See clients (customers:read) als je kassasysteem de naam, het e-mailadres en het telefoonnummer van de klant nodig heeft. Zonder dat komt de klant alleen met een id.
  2. 2Stuur de sleutel bij elke aanroep mee als Authorization: Bearer. Roep GET /api/v1/{slug}/appointments/{id}/checkout aan en sla de regels aan. checkout.allowed zegt of de boeking nu kan worden afgerekend, en checkout.blocked geeft de reden: not_live, deposit_pending, already_checked_out of invoiced. invoiced betekent dat de boeking op een factuur staat en daar betaald wordt, dus neem er aan je kassa geen geld voor aan.
  3. 3Neem het geld aan en POST daarna naar hetzelfde adres met { externalSaleId, source, amountCents, currency, tender, tipCents, tipSplit, lines }. externalSaleId is de eigen verkoop-id van je kassasysteem. source noemt je kassasysteem, zoals front_desk_pos (standaard is het external en het kan nooit bookatu zijn). amountCents moet gelijk zijn aan dueCents. currency is optioneel, maar moet die van het bedrijf zijn. tender is card, cash of other. lines, als [{ lineId, staffId }], zet een regel op naam van iemand anders.
  4. 4Post je dezelfde externalSaleId opnieuw vanuit hetzelfde kassasysteem, dan krijg je de oorspronkelijke verkoop terug met replayed: true. Weigeringen schrijven niets en geven een reden: 400 card_number (externalSaleId of source lijkt op een kaartnummer, en dat wordt nooit geaccepteerd); 409 amount_mismatch (met expectedCents), already_checked_out, external_sale_used, lines_changed (lees de checkout opnieuw), not_live, deposit_pending of invoiced (de boeking wordt betaald op haar factuur); 422 currency of tip_split; 503 zolang de overdracht voor het bedrijf nog wordt aangezet.
  5. 5Wil je van elke checkout horen, voeg dan een webhook toe in de kaart Webhooks op dezelfde pagina en vink booking.checked_out aan onder Only if you tick it. Hij wordt nooit gestuurd naar een endpoint dat alle events ontvangt. Hij gaat ook af bij checkouts aan de eigen kassa van Bookatu (sale.source bookatu), met dezelfde payload als GET en de klant alleen met een id.
  6. 6De volledige referentie, met elk veld en voorbeelden, staat in de documentatie voor ontwikkelaars op /developers#checkout-handoff, en als markdown op /developers.md.

Was this helpful?

Niet gevonden wat je zocht?

Contact met support of bekijk de FAQ.