API umożliwia dodawanie płatności, sprawdzanie i przesyłanie statusów po dokonaniu płatności przez klienta.
API jest oparte o architekturę REST. Zapytania i odpowiedzi mają format JSON.
1. Wymagane parametry
dane do GUI VPOS
a) Merchant Code (MID)
b) POS Identifier
c) login
2. Zasada działania
Za częstotliwość automatycznego sprawdzenia odpowiada parametr EspagoLinkAktualizacjaOnlineRodzajAkcji
0:ręcznie,1:po zamkn. doby,2:co godzinę
3. Możliwe odpowiedzi
- created- utworzony
- auto sent - wysłany automatycznie przez system przez mail
- pending - link dostarczony, płatność niedokonana
- link consumed - Płatność przebiegła prawidłowo
- link expired - przeterminowany
- cancelled - anulowany przez sprzedawcę
4. Konfiguracja w Plaza 2022
Należy ustawić parametr typu biblioteki (EspagoTypBiblioteki) na 2
Wymagana biblioteka pFireServ.dll
oraz biblioteki SSL (libeay32.dll i ssleay32.dll).
Parametr PayByLinkDomyslnySposobPlatnosci
wskazuje jaka będzie domyślna forma płatności podczas tworzenia linku. Po stworzeniu linku formy płatności nie można zmienić.
Dostępne:
0: karta kredytowa
1: szybki przelew
2: Masterpass (uwaga, nie wszystkie bramki mają do niego dostęp, najlepiej przetestować)
4: PSP (np. blik, Stripe)
-1: wszystkie powyższe.
Ekran płatności wtedy jest inny niz dla karty:
a) należy skonfigurować profil używając danych z pkt 1
b) należy zdefiniować rodzaj i parametry biblioteki w modułach programu
Uwaga:
Kod stanowiska POS (POS Identifier) musi być wypełniony w konfiguracji biblioteki, nie profilu. Jeden profil może obsługiwać wiele stanowisk POS.
Nazwa sprzedawcy tez jest określana w konfiguracji biblioteki.
W przypadku braku poprawnej definicji profilu importu, będzie on pobierany z ustawień biblioteki, tak samo jak hasło czy merchant code (MID).
Jednak należy unikać przechowywania hasła w konfiguracji. Hasła są szyfrowane, jednakże bezpieczniejszą metoda jest przechowywanie ich w bazie (profil)