Stavy platebních požadavků

Každý platební požadavek v MailPay má pole status, které odráží jeho aktuální stav v životním cyklu platby. Stav se mění automaticky při přijetí platby, nebo ho můžete změnit ručně přes dashboard či API.

Přehled stavů

StavPopis
PENDINGVýchozí stav po vytvoření požadavku. Platba dosud nebyla přijata. QR kód je aktivní a zákazník může zaplatit.
AWAITINGZákazník na QR terminálu klikl „Už jsem zaplatil/a". MailPay čeká na potvrzení z banky. QR kód zůstává dostupný.
PAIDPříchozí platba byla přijata a spárována s požadavkem. Konečný stav — k dalším automatickým přechodům nedochází.
CANCELEDPožadavek byl zrušen. Konečný stav — lze ručně obnovit zpět na PENDING.

Přechody stavů

PENDINGAWAITINGzákazník klikl „Už jsem zaplatil/a" na QR terminálu
PENDINGPAIDpříchozí platba automaticky spárována
AWAITINGPAIDpříchozí platba automaticky spárována
PENDINGCANCELEDmanuálně (dashboard nebo API)
AWAITINGCANCELEDmanuálně (dashboard nebo API)
PAIDPENDINGmanuální reset (dashboard nebo API)
CANCELEDPENDINGmanuální reset (dashboard nebo API)

Ruční změna stavu přes API

Stav požadavku lze kdykoliv změnit přes PATCH endpoint. Každá změna spustí odpovídající webhook událost.

PATCH /api-pub/v1/payment-requests/:id/status
PoleTypHodnoty
statusstringPENDING, AWAITING, PAID, CANCELED

Webhook události odpovídající stavům: payment_request.paid, payment_request.awaiting, payment_request.canceled, payment_request.pending. Více o webhookách najdete v API dokumentaci.