Skip to content

Planet Pay Merchant API (2.1.15)

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
Status 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.

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Sandbox
https://api.sandbox.planetpay.pl
Produkcja
https://api.planetpay.pl

Uwierzytelnienie

Wysłanie metody uwierzytelniającej i pobranie tokenu JWT jest wymagane do poprawnego procesowania płatności przez bramkę PlanetPay

Operations

Płatności

API wspólne dla wszystkich metod płatności. Poszczególne metody i kanały płatności mogą się różnić zakresem pól obowiązkowych. Operator płatności nadaje każdemu zleceniu płatności unikatowy numer paymentId, który może zostać wykorzystany przez merchanta np. do pobrania aktualnego statusu płatności. Status płatności może być również wysłany do merchanta kanałem notyfikacji (powiadomienia asynchroniczne). Wszystkie wywołania API wymagają podania tokenu autoryzacyjnego w nagłówku żądania.

Operations

Aktualizacja danych instrumentu płatniczego oraz urządzenia

Request

Metoda pozwala uzupełnić dane instrumentu płatniczego lub urządzenia bazując na wygenerowanym wcześniej paymentId. Umożliwia rozbicie flow płatności na kilka etapów (np. rejestracja płatności przez merchanta, uzupełnienie danych instrumentu płatniczego, uzupełnienie danych urządzenia).

Security
bearerAuth
Path
paymentIdstringrequired

Identyfikator płatności w systemie operatora płatności

Body
required
instrumentobject(InstrumentInfo)

Szczegółowe dane requestu

deviceobject or null(DeviceInfo)

Dane urządzenia z którego wykonywana jest operacja (przeglądarka www lub urządzenie mobilne) (wymagane dla channel = PAYWALL/WEBAPI)

customerobject(CustomerInfo)

Dane właściciela karty

consentsstring

Zgody marketingowe

languagestring or null

Preferowana wersja jezykowa (kod ISO np. pl)

curl -i -X PATCH \
  'https://api.sandbox.planetpay.pl/v1/ecommerce/payment/{paymentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/jose' \
  -d '[object Object]'

Responses

OK

Body
paymentIdstring

Identyfikator płatności w systemie operatora płatności

subpaymentsArray of objects(SubpaymentResponse)

Lista subtransakcji przy płatnościach z MARKETPLACE

statusstring

Aktualny status płatności

dataRequeststring

Zadanie dodatkowych danych

acsDataobject(AcsData)

Dane potrzebne do wykonania ACS challenge

redirectURLstring

Adres URL dla kontynuacji flow webowego

rejectCodestring

Powód odrzucenia (w przypadku niepowodzenia)

rejectInfostring

Dodatkowe informacje o powodzie odrzucenia Płatności

tokenizerIdstring

Identyfikator systemowy tokenu (służy m.in. do pobrania tokenu)

blikObjectobject(BlikTransactionDto)

Struktura zapytania BLIK

optionsobject(PaymentOptionsInfoResponse)

Inne parametry sterujace

channelstring

Kanal płatności

Enum"PAYWALL""MOBILE""WEBAPI""EBOK""CSS"
methodstring

Metoda płatności

Enum"CARD""PBL""BLIK""GPAY""APAY""UNKNOWN""C2P"
apaySessionstring

Obiekt sesji APAY do inicjalizacji płatności

reattemptstring

Informacja o ograniczeniach w wykonywaniu płatności. Dopuszczalne wartości: NEVER - nie wysyłaj wiecej komunikatów na ten numer karty; NEVER_RECURRING - nie wysyłaj wiecej komunikatów dla płatności powtarzalnej; LATER - spróbuj poźniej

Enum"NEVER""NEVER_RECURRING""LATER"
Response
No response example

Lista transakcji w ramach płatności

Request

Security
bearerAuth
Path
paymentIdstringrequired
curl -i -X GET \
  'https://api.sandbox.planetpay.pl/v1/ecommerce/payment/{paymentId}/transactions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body*/*
paymentIdstring

Identyfikator płatności w systemie operatora płatności

transactionsArray of objects(PaymentTransaction)

Lista transakcji

Pobieranie tokenu kartowego

Request

Pobranie danych tokenu na podstawie identyfikatora procesu tokenizacji. Merchant powinien zapisać nr tokenu i posługiwać się nim w dalszej komunikacji z API.

Security
bearerAuth
Path
paymentIdstringrequired

Identyfikator płatności w systemie operatora płatności

curl -i -X GET \
  'https://api.sandbox.planetpay.pl/v1/ecommerce/payment/{paymentId}/tokenizer' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body*/*
tokenizerIdstring

Identyfikator systemowy tokenu (służy m.in. do pobrania tokenu)

typestring

Typ tokenu (aktualnie wyłącznie COF)

Enum"COF""SCOF""VTS"
instrumentNostring

Token wygenerowany dla klienta

instrumentRefstring

Identyfikator tokenizowanej karty w zewnetrznym systemie

statusstring

Status tokenizacji

redirectURLstring

Adres URL dla kontunuacji flow webowego

expDatestring

Data ważności tokenu (Format: YYYYMM)

Example: "202101"
cardMaskstring

Maskowany nr karty (na potrzeby wyświetlenia)

cardGroupstring

Organizacja płatnicza (VISA/MC)

Enum"VISA""MC""AMEX"
rejectCodestring

Powód odrzucenia (w przypadku niepowodzenia)

rejectInfostring

Dodatkowe informacje o powodzie odrzucenia

customerIdstring

Identyfikator klienta użyty w procesie tokenizacji

merchantIdstring

Identyfikator merchanta użyty w procesie tokenizacji

dataRequeststring

Zadanie dodatkowych danych

Enum"INSTRUMENT""CARD_CVV""CARD_3DS""CARD_OTP""CAPTURE""BLIK_APP""DEVICE""CUSTOMER""EMAIL""BLIK_CODE"
visualURLstring

URL do grafiki z wizerunkiem karty

visualIdstring

Identyfikator wizerunku karty (guid w przypadku VTS)

recipientobject(RecipientVerificationInfo)

Informacje o weryfikacji odbiorcy (w przypadku transferu srodkow P2P)

Tokenizacja

Dostępna jest tokenizacja kart klienta w oparciu o wewnętrzne mechanizmy bramki ecommmerce (COF) lub tokenizacja w oparciu o usługi organizacji płatniczej Visa VTS/Mastercard SCOF (NETWORK). Proces może być kilkuetapowy, w związku z czym cały flow tokenizacji spina identyfikator o nazwie tokenizerId. Do operacji na tokenie (usunięcie/modyfikacja) należy wykorzystywać identyfikator tokenu (nie tokenizacji).

Operations

Notyfikacje

System wysyła do merchanta notyfikacje w reakcji na określone zdarzenia systemowe. Notyfikacje wysyłane są jeżeli w parametryzacji merchanta podany został URL API implementującego poniższą specyfikację. System generuje żądania metodą POST. Oczekujemy, że odbiorca zwróci kod HTTP 200 po przyjęciu komunikatu. Wysyłka notyfikacji jest ponawiana w przypadku błędów sieciowych (HTTP 50X). Notyfikacje nie będą ponawiane w przypadku, gdy system nie przyjął komunikatu (HTTP 40X). Notyfikacje zawierają cyfrowy podpis, który wysyłany jest w nagłówku Signature jako wartość hex. Podpis wyliczany jest algorytmem HMAC-SHA256 z wartości wszystkich pól komunikatu (konkatenacja). Do wyliczenia podpisu obowiązuje kolejność pól prezentowana w niniejszej specyfikacji. Tajny klucz dla algorytmu ustawiany jest w parametryzacji merchanta.

Operations