1. Wymagania
a) hasło API dla firmy (api_password),
b) GUID firmy
Wszystkie ustawienia dotyczące API znajdują się w formularzu Ustawienia firmy w panelu EspagoLink.
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
Linki posiadają różne statusy, które ulegają zmianie gdy:
- klient dokona płatności;
- płatność zostanie zwrócona;
- klient podjął próbę płatności, ale jego płatność zakończyła się niepowodzeniem;
EspagoLink wysyła informację o zmianie statusów na adres podany w ustawieniach firmy.
Linki mogą posiadać statusy (atrybut “status” - prosty status):
- paid - w przypadku prawidłowego przebiegu transakcji, nawet jeśli później jeśli dokonano zwrotu częściowego;
- unpaid - gdy link nie został jeszcze opłacony lub płatność została anulowana (nastapił całościowy zwrot w dniu dokonania płatności)
Linki zawieraja również szczegółową informację na temat statusu płatności, mogące sugerować kontakt z klientem (np. w przypadku odrzucenia płatności), w kolejności alfabetycznej:
- cancelled - link został anulowany (nie ma możliwości dokonania płatności);
- cancelled with info - link został anulowany z powiadomieniem klienta mailem systemowym (nie ma możliwości dokonania płatności);
- executed - płatność dokonana prawidłowo, bez zwrotów;
- incorrect - link został dodany (np. przez API), ale zawiera błędy, nie może zostać wysłany do użytkownika;
- refunded - dokonano zwrotu (całościowego lub częściowego);
- rejected - klient otrzymał odmowę przy próbie płatności (w panelu EspagoLink jest dostępna informacja o błędzie jaki otrzymał z banku);
- reversed - dokonano zwrotu całościowego w dniu zakupu (anulowanie płatności, nie będzie widoczna na wyciągu klienta);
- sending - następuje próba wysłania linku pocztą do klienta, jeśli status ten utrzymuje się dłużej niż minutę, to znaczy, że występuje ciągły problem z połączeniem ze skrzynką pocztową nadawczą Twojej firmy (np. po zmianie hasła nie zostało zaktualizowane w panelu EspagoLink);
- waiting - link oczekuje na płatność (nie było nieudanych lub udanych płatności).
4. Konfiguracja
Należy ustawić parametr typu biblioteki (EspagoTypBiblioteki) na 1
Wymagana biblioteka pEspago.dll
oraz biblioteki SSL (libeay32.dll i ssleay32.dll).
a) należy skonfigurować profil używając danych z pkt 1
b) należy zdefiniować rodzaj i parametry biblioteki w modułach programu