Ta betalt för bokningar i ett annat kassasystem
Låt ett externt kassasystem läsa vad en bokning kostar och skicka tillbaka försäljningen så att bokningen slutförs.
Vad det är
Kassaöverlämningen är en adress med två anrop: GET och POST /api/v1/{slug}/appointments/{id}/checkout. GET returnerar vad bokningen kostar: varje tjänst och tillval med dess lineId och vem som utförde det, priset, rabatter, skatterader, handpenningen som redan är betald, och dueCents, som är exakt det belopp som ska tas betalt. POST registrerar försäljningen som ditt kassasystem gjorde, slutför bokningen och kopplar försäljningen till den, med samma kod för kassan som Bookatus egen kassa använder.
Varför det hjälper
Ingen slår in ett besök två gånger, och bokningen, försäljningen, vem som får försäljningen räknad på sig och pengarna stämmer överens i Bookatu, som om Bookatus egen kassa hade tagit betalt. Att posta är idempotent på ditt externalSaleId, så ett nytt försök efter en bruten anslutning returnerar replayed: true och skriver ingenting.
Så använder du det
- 1Ägare och administratörer skapar nyckeln i Settings, sedan API & monitoring, under API keys. I What this key may do kryssar du i båda rutorna på raden Checkout at another point of sale: See what a booking comes to at checkout (checkout:read) och Check bookings out from another point of sale (checkout:write). De är av tills du kryssar i dem, och en nyckel som skapades innan behörighetsområden fanns har dem aldrig. Den som skapar nyckeln måste kunna se allas kalendrar (för checkout:read) och redigera kalendern (för checkout:write). Lägg till See bookings (bookings:read) för att lista dagens bokningar med GET /appointments, och See clients (customers:read) om ditt kassasystem behöver kundens namn, e-post och telefonnummer. Utan den kommer kunden bara som ett id.
- 2Skicka nyckeln som Authorization: Bearer i varje anrop. Anropa GET /api/v1/{slug}/appointments/{id}/checkout och slå in dess rader. checkout.allowed anger om det går att ta betalt för bokningen nu, och checkout.blocked ger skälet: not_live, deposit_pending, already_checked_out eller invoiced. invoiced betyder att bokningen finns på en faktura och betalas där, så ta inte betalt för den i ditt kassasystem.
- 3Ta betalt, och POSTa sedan till samma adress med { externalSaleId, source, amountCents, currency, tender, tipCents, tipSplit, lines }. externalSaleId är ditt kassasystems eget id för försäljningen. source namnger ditt kassasystem, till exempel front_desk_pos (standard är external, och det kan aldrig vara bookatu). amountCents måste vara lika med dueCents. currency är valfritt men måste vara företagets. tender är card, cash eller other. lines, som [{ lineId, staffId }], krediterar en rad till någon annan.
- 4Att posta samma externalSaleId från samma kassasystem igen returnerar den ursprungliga försäljningen med replayed: true. Nekade anrop skriver ingenting och ger ett skäl: 400 card_number (externalSaleId eller source ser ut som ett kortnummer, vilket aldrig godtas); 409 amount_mismatch (med expectedCents), already_checked_out, external_sale_used, lines_changed (läs kassaunderlaget igen), not_live, deposit_pending eller invoiced (bokningen betalas på sin faktura); 422 currency eller tip_split; 503 medan överlämningen fortfarande håller på att slås på för företaget.
- 5För att få veta om varje betalning lägger du till en webhook i kortet Webhooks på samma sida och kryssar i booking.checked_out under Only if you tick it. Den skickas aldrig till en endpoint som tar emot alla händelser. Den skickas också för betalningar i Bookatus egen kassa (sale.source bookatu), med samma data som GET och kunden bara som ett id.
- 6Hela referensen, med varje fält och exempel, finns i dokumentationen för utvecklare på /developers#checkout-handoff, och som markdown på /developers.md.
Relaterade guider
Was this helpful?
Hittade du inte det du behövde?
Kontakta supporten eller gå till vanliga frågor.