Kehittäjille

Ota maksu varauksista toisessa kassajärjestelmässä

Anna ulkoisen kassajärjestelmän lukea, paljonko varaus maksaa, ja lähettää myynti takaisin, jotta varaus merkitään valmiiksi.

Mikä se on

Kassaluovutus on yksi osoite ja kaksi kutsua: GET ja POST /api/v1/{slug}/appointments/{id}/checkout. GET palauttaa, mitä varaus maksaa: jokaisen palvelun ja lisäpalvelun lineId-tunnisteineen ja tekijöineen, hinnan, alennukset, verorivit, jo maksetun ennakkomaksun sekä dueCents, joka on täsmälleen otettava summa. POST kirjaa kassajärjestelmäsi ottaman myynnin, merkitsee varauksen valmiiksi ja liittää myynnin siihen käyttäen samaa ohjelmakoodia kuin Bookatun oma kassa.

Miksi siitä on hyötyä

Kenenkään ei tarvitse kirjata käyntiä kassaan kahdesti, ja varaus, myynti, työntekijöiden osuudet ja rahat täsmäävät Bookatussa kuin sen oma kassa olisi ottanut maksun. Lähetys on idempotentti externalSaleId-tunnisteesi suhteen, joten uusintayritys katkenneen yhteyden jälkeen palauttaa replayed: true eikä kirjoita mitään.

Näin käytät sitä

  1. 1Omistajat ja ylläpitäjät tekevät avaimen kohdassa Settings, sitten API & monitoring, osiossa API keys. Rastita kohdassa What this key may do molemmat ruudut rivillä Checkout at another point of sale: See what a booking comes to at checkout (checkout:read) ja Check bookings out from another point of sale (checkout:write). Ne pitää valita erikseen, eikä ennen oikeusalueita tehdyssä avaimessa ole koskaan niitä. Avaimen tekijän on voitava nähdä kaikkien kalenterit (checkout:read) ja muokata kalenteria (checkout:write). Lisää See bookings (bookings:read), jos haluat listata päivän varaukset kutsulla GET /appointments, ja See clients (customers:read), jos kassajärjestelmäsi tarvitsee asiakkaan nimen, sähköpostin ja puhelinnumeron. Ilman sitä asiakas tulee pelkällä id:llä.
  2. 2Lähetä avain muodossa Authorization: Bearer jokaisessa kutsussa. Kutsu GET /api/v1/{slug}/appointments/{id}/checkout ja kirjaa sen rivit kassaan. checkout.allowed kertoo, voiko varauksesta ottaa maksun nyt, ja checkout.blocked antaa syyn: not_live, deposit_pending, already_checked_out tai invoiced. invoiced tarkoittaa, että varaus on laskulla ja maksetaan siellä, joten älä ota siitä rahaa kassajärjestelmässäsi.
  3. 3Ota rahat vastaan ja tee sitten POST samaan osoitteeseen sisällöllä { externalSaleId, source, amountCents, currency, tender, tipCents, tipSplit, lines }. externalSaleId on kassajärjestelmäsi oma myyntitunniste. source nimeää kassajärjestelmäsi, esimerkiksi front_desk_pos (oletus on external, eikä se voi koskaan olla bookatu). amountCents on oltava sama kuin dueCents. currency on valinnainen, mutta sen on oltava yrityksen valuutta. tender on card, cash tai other. lines, muodossa [{ lineId, staffId }], kirjaa rivin jollekulle toiselle.
  4. 4Jos lähetät saman externalSaleId:n samasta kassajärjestelmästä uudelleen, saat alkuperäisen myynnin ja replayed: true. Hylkäykset eivät kirjoita mitään ja antavat syyn: 400 card_number (externalSaleId tai source näyttää kortinnumerolta, mitä ei koskaan hyväksytä); 409 amount_mismatch (ja expectedCents), already_checked_out, external_sale_used, lines_changed (lue maksutiedot uudelleen), not_live, deposit_pending tai invoiced (varaus maksetaan laskullaan); 422 currency tai tip_split; 503, kun luovutusta ollaan vasta ottamassa käyttöön yritykselle.
  5. 5Jos haluat tiedon jokaisesta maksusta, lisää webhook saman sivun Webhooks-kortissa ja rastita booking.checked_out kohdassa Only if you tick it. Sitä ei koskaan lähetetä päätepisteeseen, joka ottaa vastaan kaikki tapahtumat. Se laukeaa myös Bookatun omalla kassalla otetuista maksuista (sale.source bookatu), samalla sisällöllä kuin GET ja asiakas pelkällä id:llä.
  6. 6Koko viiteopas, jossa on jokainen kenttä ja esimerkki, on kehittäjien dokumentaatiossa osoitteessa /developers#checkout-handoff ja markdownina osoitteessa /developers.md.

Was this helpful?

Etkö löytänyt etsimääsi?

Ota yhteyttä tukeen tai selaa usein kysyttyjä.