Poniższa dokumentacja techniczna (Merchant API) umożliwia wdrożenie wszystkich dostępnych metod płatności oraz funkcjonalności oferowanych przez bramkę płatniczą Planet Pay.

Słownik pojęć:

Secret - poufny klucz przyznawany Merchantowi przez Planet Pay

Merchant - właściciel punktu sprzedaży zarejestrowany w systemie operatora płatności

Agent - podmiot pośredniczący w transakcji (np. operator aplikacji mobilnej)

Klient - klient końcowy (wykonujący i opłacający zamówienie)

MID - merchant identification number - numer merchanta/agenta nadawany przez operatora płatności

SCA - silne uwierzytelnienie klienta; środek wprowadzony przez dyrektywę PSD2 w celu zwiększenia bezpieczeństwa płatności internetowych

Statusy Płatności:

Flow statusów płatności przedstawia się nastepująco NEW - PENDING - COMPLETED/REJECTED - CANCELLED/ERROR/SETTLED

Wywołanie metody payment powoduje zarejestrowanie w systemie płatności ze statusem NEW.

Płatność utrzymuje się w statusie NEW do momentu określenia metody płatności i instrumentu płatniczego.

Płatność zmienia status na PENDING w momencie rozpoczęcia procesowania transakcji (np. inicjalizacja 3DS w przypadku płatności kartą lub komunikacja z systemami PSP w przypadku transakcji BLIK).

Płatność, która zakończyła się powodzeniem, otrzymuje status COMPLETED.

Płatność po rozliczeniu ostatecznie otrzymuje status SETTLED.

Płatność w statusie NEW i PENDING może zostać anulowana. Płatność otrzymuje wtedy status CANCELLED.

Dopuszczalne jest anulowanie płatności w statusie COMPLETED w przypadku braku możliwości zrealizowania zlecenia przez merchanta.

Anulowanie płatności w statusie COMPLETED nie jest możliwe, jeżeli istnieje choć jedno dopełnienie (capture) lub wykonany został zwrot (refund).

Błąd systemowy może spowodować oznaczenie transakcji statusem ERROR.

Notyfikacje

Notyfikacje dotyczące płatności powinny być przyjmowane na dedykowany endpoint /payment niezależnie od typu płatności.