Linkowanie odbiorcy napiwku
Przepływ linkowania odbiorcy napiwku pozwala pracownikowi połączyć swoje konto OpenApp z tipRecipientId po stronie POS. Po linkowaniu i potwierdzeniu KYC napiwki przypisane do tego tipRecipientId są kierowane bezpośrednio do portfela OpenApp pracownika zamiast trafiać do rozliczenia merchanta.
POS jest odpowiedzialny za zebranie numeru telefonu, który pracownik chce powiązać. Sposób, w jaki POS prezentuje to użytkownikowi, leży w jego gestii.
Endpointy używane w tym przepływie:
| Endpoint | Kierunek | Cel |
|---|---|---|
GET /tip-recipients | POS -> OpenApp | Pobierz pełną listę rekordów odbiorców napiwku dla lokalizacji. |
GET /tip-recipients/:id | POS -> OpenApp | Pobierz pojedynczy rekord odbiorcy napiwku wraz z aktualnym status. |
PUT /tip-recipients/:id | POS -> OpenApp | Wykonaj upsert rekordu odbiorcy napiwku i zainicjuj linkowanie konta. Treść żądania: PutTipRecipientRequest. Odpowiedź: LinkTipRecipientResponse. |
Odczyt listy odbiorców
POS może pobrać aktualną listę odbiorców w dowolnym momencie, aby wypełnić interfejs wyboru pracownika albo zweryfikować rekordy.
GET /tip-recipients — odpowiedź: tablica rekordów TipRecipient.
GET /tip-recipients/:id — odpowiedź: pojedynczy rekord TipRecipient albo HTTP 404, jeśli dla podanego identyfikatora nie istnieje żaden rekord.
Zgłoszenie linkowania
POS wysyła PUT /tip-recipients/:id z numerem telefonu i nazwą wyświetlaną pracownika. Jest to upsert: jeśli rekord odbiorcy napiwku jeszcze nie istnieje, OpenApp go tworzy; jeśli istnieje, nazwa wyświetlana jest aktualizowana. OpenApp zapisuje następnie powiązanie w stanie PENDING i obsługuje resztę przepływu.
Zobacz PutTipRecipientRequest po pełną referencję treści żądania.
Sprawdzanie statusu linkowania
POS może wyświetlać status pracownikowi — na przykład pokazując odznakę Oczekujące, która zmienia się na Połączone po potwierdzeniu przez pracownika.
Gdy status to PENDING, TipRecipient.expiresAt zawiera termin, do którego pracownik musi ukończyć proces. Jeśli nie potwierdzi przed tym czasem, oczekujące zgłoszenie jest cicho odrzucane. POS musi wysłać nowe PUT /tip-recipients/:id, aby rozpocząć od nowa.
Zobacz Link status po pełny słownik statusów.
Odlinkowanie tipRecipientId od konta OpenApp jest wykonywane bezpośrednio przez pracownika w aplikacji OpenApp. Po stronie POS nie ma endpointu do odlinkowania.