Přehled eAPI metod - csob/platebnibrana GitHub Wiki

Iniciální integrace na eAPI, ověření podpisu

Pro napojení e-shopu na eAPI proveďte nejprve provolání operace echo. Otestujete si tak podepsání požadavku i ověření podpisu v odpovědi od platební brány. Provolání je možné naimplementovat jak přes GET, tak přes POST HTTP method.

Metoda	Popis
echo	Operace pro ověření dostupnosti platební brány, případně pro ověření podpisu zprávy pro snazší integraci.

Základní integrace e-shopu na platební bránu

Pro základní integraci e-shopu na platební bránu slouží operace payment/init a payment/process:

Metoda	Popis
payment/init	Založení platby na platební bráně.
payment/process	Přesměrování na platební bránu po předchozí inicializaci platby.

Dále je nutné naimplementovat volání následujících operací, pomocí kterých je možné řídit životní cyklus platby:

Metoda	Popis
payment/status	Zjištění stavu platby.
payment/reverse	Operace reverzuje (zruší před odesláním do zúčtování) již autorizovanou platbu.
payment/close	Operace zařadí autorizovanou nezaúčtovanou platbu do zúčtování.
payment/refund	Operace zažádá o plný nebo částečný návrat prostředků nazpět plátci.

Integrace metod pro OneClick platbu (oneclick@shop)

Pokud obchodník bude využívat OneClick platbu, musí naimplementovat následující operace oneclick/init a oneclick/process. Pomocí operace oneclick/echo si obchodník může ověřit stav OneClick šablony, například v případě, kdy uživateli zobrazuje stav jeho "registrovaných karet".

Metoda	Popis
oneclick/echo	Ověření stavu OneClick šablony.
oneclick/init	Založení OneClick platby na platební bráně.
oneclick/process	Spuštění zpracování OneClick platby.

Integrace metod pro Apple Pay platbu (applepay@shop)

Pro platební metodu Apple Pay je potřeba, aby obchodník implementoval následující operace:

Metoda	Popis
applepay/echo	Získání parametrů pro inicializaci Apple Pay.
applepay/init	Založení Apple Pay platby pro applepay@shop.
applepay/process	Spuštění zpracování Apple Pay platby.

Integrace metod pro Google Pay platbu (googlepay@shop)

Pro platební metodu Google Pay je potřeba, aby obchodník implementoval následující operace:

Metoda	Popis
googlepay/echo	Získání parametrů pro inicializaci Google Pay.
googlepay/init	Založení Google Pay platby pro googlepay@shop.
googlepay/process	Spuštění zpracování Google Pay platby.

Integrace platebního tlačítka ČSOB (pt@shop)

Pro integraci platebního tlačítka pro platbu převodem z účtů ČSOB je nutné, aby obchodník naimplementoval metodu button/init:

Metoda	Popis
button/init	Založení platby pro platební tlačítko (pt@shop).

Integrace metod pro mallpay platbu (mallpay@shop)

Platební metoda mallpay se od předchozích způsobů platby poněkud liší: obchodník sice nejprve založí platbu pomocí mallpay/init a zjišťuje její stav pomocí payment/status, další průběh zpracování je ale odlišný - obchodník může platbu zrušit (mallpay/cancel). Dále poté, co doručil nebo odeslal zboží zákazníkovi, předává na platební bránu logistický stav (mallpay/logistics) a odlišně se provádí i vrácení (mallpay/refund).

Metoda	Popis
mallpay/init	Založení Odložené platby na platební bráně pro mallpay@shop.
mallpay/logistics	Pomocí této operace obchodník předá údaje o doručení nebo odeslání zboží zákazníkovi, případně údaje o zrušených položkách objednávky.
mallpay/cancel	Pomocí této operace může obchodník zrušit Odloženou platbu.
mallpay/refund	Provedení vratky u mallpay platby.

Pomocné metody

Následující operace jsou volitelné:

Metoda	Popis
echo/customer	Operace pro zjištění informace o uloženém zákazníkovi.