Dokumentace pluginu Toret ČSOB

Nacházíte se na stránkách dokumentace pluginu Toret ČSOB, který který integruje platební bránu ČSOB.

Instalace pluginu

Po zakoupení pluginu obdržíte emailem licenční klíč a odkaz na stažení zip souboru s pluginem. Detailní návod, jak do WordPress nainstalovat plugin z počítače, najdete zde.

Aktivace pluginu

Po instalaci pluginu si otevřete plugin Toret ČSOB, do příslušného pole vložte licenční klíč a ověřte licenci.

Krok 1: Testovací proces

Před nastavením platební brány je nutné uzavřít s ČSOB smlouvu. Více informací k platební bráně a formulář pro registraci do platební brány najde zde. Po uzavření smlouvy pošle ČSOB přístupové údaje do aplikace Posman a e-mail s výzvou k provedení testovacích plateb. Na první pohled se instrukce v emailu budou zdát složité, ale opakem je pravda. Implementace je sice časově náročnější, ale složitá rozhodně není.

Nastavení platební metody ČSOB najdete ve WooCommerci → Pokladna → ČSOB Payment Gateway. 

Projdeme si jednitlivé kroky testovacího procesu.

  1. Po instalaci a aktivaci pluginu ČSOB bude potřeba vygenerovat testovací klíče. Ty se generují v integračním prostředí zde. Z testovacích klíčů je nutné veřejný klíč (PUB) vložit v integrační prostředí přes tlačítko „Upload veřejného klíče“ a soukromý klíč (KEY) se nahraje v nastavení pluginu a zároveň je nutné povolit testovací mód. V pluginu je ještě nutné vyplnit ID Brány (ID obchodníka), povolit platební metodu platby kartou. ID Brány najdete v aplikaci Posman pod kartou “Platební brány”.
  2. Nyní přicházejí na řadu testovací platby. ČSOB vyžaduje čtyři testovací platby (úspěšnou, uživatel zrušenou, expirovanou a reverzovanou). Pro testovací platby je připravena karta 4000007000010006, CVC 100 a expiraci je možné zvolit libovolnou, jen musí být v budoucnu.
    • U úspěšné platby se zadá testovací karta a po dokončení platby dojde k přesměrování zpět do e-shopu.
    • Pro uskutečnění uživatelem zrušené platby je nutné na platební bráně kliknout na odkaz „Zrušit platbu a návrat zpět do e-shopu“.
    • U expirované platby je nutné je vyčkat 30 minut na stránce platební brány. Po 30 minutách dojde k expiraci platby a dojde k přesměrování zpět na e-shop.
    • U reverzní testovací platby je nutné v nastavení platební metody ČSOB aktivovat funkci „Zakázat automatické zavírání“. Následně je nutné vytvořit objednávku s platbou. V detailu objednávky se nachází vpravo box „Toret ČSOB“, v tomto boxu stačí kliknout na tlačítko “Reverzní platba”.
  3. Po dokončení testovacích objednávek je nutné provést validaci v testovacím prostředí aplikace POS Merchant (https://iposman.iplatebnibrana.csob.cz/posmerchant/). Po přihlášení je nutné přejít na kartu “Platební brány” a poté přes ikonu lupy u platební brány se dostat ke schválení testovacích plateb. Kliknutím na tlačítko “Provést Validaci” dojde k ověření plateb a zobrazí se výsledek validace jednotlivých plateb. Pokud budou u všech testovacích plateb zelené fajfky, tak je ještě nutné kliknout na tlačítko “Odeslat požadavek”. Tím se testovací proces odešle ke schválení. Po splnění testovacích plateb zašle ČSOB informaci o aktivaci produkčního prostředí a přihodí dalších pokyny ke spuštění platební brány a může se přejít k ostré implementaci.

Testovací platby

Pokud jsou v pluginu vložené testovací implementační údaje a zapnutý testovací mód, tak při dokončení testovacích plateb použijte níže uvedenou kartu:

Testovací VISA karta – úspěšná platba:

4000007000010006 CVV: 100 Expirace karty: jakákoliv hodnota v budoucnu ve formátu MM/RR například 10/26

O více možnostech testovacích plateb se dovíte pod odkazem zde.

Před nastavením platební brány je nutné uzavřít s ČSOB smlouvu. Více informací k platební bráně a formulář pro registraci do platební brány najde zde. Po uzavření smlouvy pošle ČSOB přístupové údaje do aplikace Posman a e-mail s výzvou k provedení testovacích plateb. Na první pohled se instrukce v emailu budou zdát složité, ale opakem je pravda. Implementace je sice časově náročnější, ale složitá rozhodně není.

Nastavení platební metody ČSOB najdete ve WooCommerci → Pokladna → ČSOB Payment Gateway. 

Projdeme si jednitlivé kroky testovacího procesu.

  1. Po instalaci a aktivaci pluginu ČSOB bude potřeba vygenerovat testovací klíče. Ty se generují v integračním prostředí zde. Z testovacích klíčů je nutné veřejný klíč (PUB) vložit v integrační prostředí přes tlačítko „Upload veřejného klíče“ a soukromý klíč (KEY) se nahraje v nastavení pluginu a zároveň je nutné povolit testovací mód. V pluginu je ještě nutné vyplnit ID Brány (ID obchodníka), povolit platební metodu platby kartou. ID Brány najdete v aplikaci Posman pod kartou “Platební brány”.
  2. Nyní přicházejí na řadu testovací platby. ČSOB vyžaduje čtyři testovací platby (úspěšnou, uživatel zrušenou, expirovanou a reverzovanou). Pro testovací platby je připravena karta 4000007000010006, CVC 100 a expiraci je možné zvolit libovolnou, jen musí být v budoucnu.
    • U úspěšné platby se zadá testovací karta a po dokončení platby dojde k přesměrování zpět do e-shopu.
    • Pro uskutečnění uživatelem zrušené platby je nutné na platební bráně kliknout na odkaz „Zrušit platbu a návrat zpět do e-shopu“.
    • U expirované platby je nutné je vyčkat 30 minut na stránce platební brány. Po 30 minutách dojde k expiraci platby a dojde k přesměrování zpět na e-shop.
    • U reverzní testovací platby je nutné v nastavení platební metody ČSOB aktivovat funkci „Zakázat automatické zavírání“. Následně je nutné vytvořit objednávku s platbou. V detailu objednávky se nachází vpravo box „Toret ČSOB“, v tomto boxu stačí kliknout na tlačítko “Reverzní platba”.
  3. Po dokončení testovacích objednávek je nutné provést validaci v testovacím prostředí aplikace POS Merchant (https://iposman.iplatebnibrana.csob.cz/posmerchant/). Po přihlášení je nutné přejít na kartu “Platební brány” a poté přes ikonu lupy u platební brány se dostat ke schválení testovacích plateb. Kliknutím na tlačítko “Provést Validaci” dojde k ověření plateb a zobrazí se výsledek validace jednotlivých plateb. Pokud budou u všech testovacích plateb zelené fajfky, tak je ještě nutné kliknout na tlačítko “Odeslat požadavek”. Tím se testovací proces odešle ke schválení. Po splnění testovacích plateb zašle ČSOB informaci o aktivaci produkčního prostředí a přihodí dalších pokyny ke spuštění platební brány a může se přejít k ostré implementaci.

Testovací platby

Pokud jsou v pluginu vložené testovací implementační údaje a zapnutý testovací mód, tak při dokončení testovacích plateb použijte níže uvedenou kartu:

Testovací VISA karta – úspěšná platba:

4000007000010006 CVV: 100 Expirace karty: jakákoliv hodnota v budoucnu ve formátu MM/RR například 10/26

Krok 2: Ostrá implementace

Pokud ČSOB po Vás nevyžaduje provést testovací platby nebo jste již prošli testovacím procesem v předchozím kroku, tak si na stránkách platebnibrana.csob.cz/keygen/ vygenerujete ostré klíče, které použijete pro provozní prostředí.

  1. Na stránce platebnibrana.csob.cz/keygen/ zadáte Merchatn ID a registrovanou emailovou adresu
  2. Vygenerujete pár klíčů (public a private)
  3. Privátní klíč uložíte na FTP skrze nastavení platební metody ČSOB ve WooCommerci  → ČSOB Nahrát soukromý klíč → Nastavení pluginu uložíte.
  4. Veřejný klíč odešlete zabezpečeným kanálem na platební bránu . Zabezpečený kanál je na stejné stránce, jako je generování klíčů → Upload veřejného klíče.
  5. ČSOB Vám zašle na registrovanou adresu aktivační kód, kterým potvrdíte požadavek na zavedení klíče. Potvrzení probíhá v aplikaci posman.csob.cz → Platební brány → sloupec Akce → ikonka klíče.
  6. Vypnete testovací mód

Po uložený ostrých klíčů a nastavení pluginu je platební brána připravena přijímat ostré platby. Napojení můžete snadno otestovat. Vytvořte si testovací objednávku s výběrem platební metody ČSOB. Pokud po dokončení testovací objednávky budete přesměrování na platební bránu, provedli jste integraci správně. Případně můžete platbu dokončit a tím si budete 100% jisti s funkčností platební brány.

Automatické načítání stavu plateb

V případě dokončení platby je zákazník přesměrován na děkovnou stránku. Zároveň je předána notifikace o tom, že je objednávka uhrazena a dojde ke změně stavu objednávky na Zpracovává se (u fyzických produktů) nebo na Dokončeno (u virtuálních produktů).

Může se však stát, že zákazník z nějakého důvodu nebyl po uhrazení objednávky přesměrován na děkovnou stránku. V tom případě plugin nemá žádnou informaci od platební brány o tom, že je objednávka uhrazena. Aby nedošlo k tomu, že uhrazené objednávky bez notifikace budou funkcí WooCommerce zrušeny, je nutné nastavit funkci automatického načítání plateb.

Nastavení automatického načítání stavu platby najdete po kartou Toret Plugin → Toret ČSOB. 

Toret ČSOB – Automatické načítání stavu platby

1) Nastavíte počet dní pro zpětnou kontrolu stavů plateb u objednávek, tedy v jakém zpětném časovém horizontu se budou objednávky kontrolovat.

Toret ČSOB – nastavení počtu dní pro zpětnou kontrolu

2) Pokud nechcete kontrolovat stav platby u všech objednávek, je možné vybrat jednotlivé stavy objednávek, které se z kontroly vyřadí. Rozhodně nedoporučujeme vylučovat stav Čeká na platbu, Selhalo a Zrušeno.

Toret ČSOB – nastavení stavů objednávky, které se nebudou kontrolovat

3) Změna stavu objednávky podle stavu platby. V případě, že chcete po potvrzení úhrady objednávky změnit stav např. na „Zpracovává se“ nebo jiný preferovaný stav, tak u stavu platby „4 – Platba potvrzena“ si nastavte stav objednávky, na který se objednávka přepne. Ve stavu platby „4 – Platba potvrzena“ se bere objednávka jako uhrazená.

Toret ČSOB – změna stavu objednávky podle stavu platby

Funkci změny stavu objednávky na základě stavu platby je nutné povolit aktivací checkboxu.

Toret ČSOB – aktivace změny stavu objednávky na základě stavu platby

4) Aby se stav plateb aktualizoval podle nastavení z předchozích tří bodů, tak je nutné na hostingu nastavit URL CRONu, která je uvedená v nastavení u vás na webu. CRON doporučujeme pravidelně spouštět, minimálně 1x za hodinu.

Dále je nutné nastavit počet objednávek, které budou kontrolovány na jeden běh CRONu.

Toret ČSOB – nastavení CRONu

Pojmy v nastavení pluginu

Nastavení platební metody ČSOB najdete ve WooCommerci → Pokladna → ČSOB Payment Gateway. 

Zde si projdeme jednotlivé možnosti nastavení platební metody v pluginu ČSOB.

  1. Povolení platební brány ČSOB: Nastavenou platební bránu můžete aktivovat přes checkbox nebo přes posuvník v přehledu platebních metod.
  2. Název: Jedná se o název způsobu platební metody ČSOB, který se bude zobrazovat v pokladně.
  3. Popis: Nastavený popis se zobrazí v pokladně při výběru způsobu platby.
  4. Vlastní ikona: Plugin má výchozí ikonu nastavenou, ale je možné si nastavit vlastní ikonu pro platební metodu ČSOB. Ikonu je nutné vložit mezi média WordPressu a její URL vložit zde do pole.
  5. Vrácení platby: Zapnutím této funkce dojde k vrácení platby při změně stavu objednávky na „Vráceno“ (Cancelled). Také dojde ke zrušení platby, který ještě nebyla zaúčtována.
  6. Název obchodu: Název obchodu použitý v platebních údajích, který se předává pomocí API na platební bránu.
  7. Merchant ID: Jedná se o implementační údaj, který získáte od ČSOB. Případně jej najdete v posman.csob.cz → Platební brány → ID Brány
  8. Private key: Jedná se o soubor (.key) získaný od ČSOB, který pomocí tlačítka „Vybrat soubor“ vložíte na FTP do pluginu.
  9. Testovací platební brána: Zde je check box pro zapnutí testovacího prostředí platební brány. Pro její použití je nutné mít k dispozici testovací private key.
  10. Povolení dopravních metod: Zde je možné nastavit zobrazení platební brány jen pro vybrané dopravní metody. Pokud platební bránu chcete používat pro všechny dopravní metody, tak nechte pole prázdné.
  11. Povolené platební metody: Zde je nutné vybrat alespoň jednu platební metodu, kterou chcete v pokladně zobrazit. Počet metod k výběru je ovlivněný tím, kolik jich jich máte od ČSOB povolených.
  12. Povolení země: Zde si nastavit pro jaké země se bude platební metoda ČSOB zobrazovat v pokladně. Pokud platební bránu chcete používat pro všechny země, tak nechte pole prázdné.
Přejít nahoru