Obsah stránky

Platební brána ČSOB

Uživatelský manuál

Zde se dozvíte, jak pracovat s nainstalovaným rozšířením Platební brána ČSOB pro Magento 2 od GetReady.

Popis

Modul Platební brána ČSOB pro Magento 2 od GetReady (dále jen 'Platební brána ČSOB') přidává do e-shopu Magento užitečnou funkcionalitu: umožnit návštěvníkům obchodu platit platebními kartami.

Jako provozovatel obchodu tento modul můžete vyzkoušet již předtím, než podepíšete smlouvu s bankou o provovozování platební brány.

Platební akce

Modul 'Platební brána ČSOB' umožňuje vybrat jednu ze dvou akcí. Každá má odlišné flow - pořadí transakcí.

akce brány anglicky popis
Schválit Authorize Prostředky jsou pouze blokovány po pozdější zachycení. Platba není uzavřena.
Zachytit a Schválit Capture and Authorize Prostředky jsou zachyceny - převedeny obchodníkovi. Platba je uzavřena.

Tento návod

V tomto návodu si ukážeme, jak modul nastavit a testovat jeho chování.

Co je třeba, než začneme

Instalace modulu není předmětem tohoto návodu - předpokládáme, že máte funkční e-shop na platformě Magento2 a modul 'Platební brána ČSOB' nainstalován a aktivní. Pokud ne, kontaktujte vašeho administrátora.

Dále budeme potřebovat údaje pro propojení našeho systému s bránou.

Jak získat testovací údaje

Testovací údaje můžete získat zdarma na této adrese:

https://iplatebnibrana.csob.cz/keygen/

csob_sandbox.png

Klíče a údaje na následujících obrázcích jsou pouze demonstrativní, pro potřeby tohoto návodu.
Pro testování modulu 'Platební brána ČSOB' si podle tohoto postupu vygenerujte klíče vlastní.

  1. klikněte na 'Create Sandbox ID'
  2. v modálním okně potvrďte 'OK'
  3. po chvíli uvidíte obrazovku s informacemi o vygenerování
    Uložte si oba klíče (klikněte na 'Save public key' a 'Save private key'),
    a hned můžete také veřejný klíč zaregistrovat: klikněte na 'Submit public key to ČSOB'.
  4. objeví se obrazovka s potvrzením o zaregistrování vašeho veřejného klíče.

  5. Měli byste mít stažené dva soubory:
    csob_keys_screenshot.png
    Tyto soubory a ID obchodníka budete potřebovat pro nastavení modulu 'Platební brána ČSOB'.

    V tomto případě je ID obchodníka A632si56Eq.
    (Vidíte, že ID obchodníka najdete ve jméně souborů, mezi znaky _ a .)

Nastavení modulu 'Platební brána ČSOB'

1) přihlašte se do administrace

2) proklikejte se do místa nastavení modulu:

Dále uvádíme českou i anglickou podobu administrace.
Nastavované ukázkové hodnoty budou pro obě verze stejné.

česky anglicky
OBCHODY > Nastavení/Nastavení > PRODEJ > Způsoby platby > Platební brána ČSOB STORES > Setings/Configuration > SALES > Payment methods > ČSOB Payment Gateway
csob_settings_all_CZ.png csob_settings_all_EN.png

3) zapněte modul 'Platební brána ČSOB'

česky anglicky
Zapnuto: 'Ano' Enabled: 'Yes'
csob_enabled_CZ.png csob_enabled_EN.png

4) zvolte si název platební metody (bude viditelný v obchodě pro zákazníky),
např. 'Platební karta'

česky anglicky
Název: 'Platební karta' Title: 'Platební karta'
csob_settings_title_CZ.png csob_settings_title_EN.png

5) Vyplňte ID obchodníka přidělené bránou

česky anglicky
Id obchodníka Merchant Id
csob_settings_ID_CZ.png csob_settings_ID_EN.png

6) Nahrajte soubor soukromého klíče (přípona '.key')

česky anglicky
Soukromý klíč obchodníka Merchant Private Key
csob_settings_key-key_CZ.png csob_settings_key-key_EN.png

7) Nahrajte soubor veřejného klíče (přípona '.pub')

česky anglicky
Veřejný klíč obchodníka Merchant Public Key
csob_settings_key-pub_CZ.png csob_settings_key-pub_EN.png

8) Než budete nastavovat další hodnoty, konfiguraci raději uložte kliknutím na Uložit nastavení (anglicky Save Config).
Nyní by vaše nastavení ID a klíčů mělo vypadat takto:

česky anglicky
csob_settings_id-and-keys_CZ.png csob_settings_id-and-keys_EN.png

9) Nastavte akci brány: (vyberte jednu ze dvou, např. 'Schválit = Authorize')

česky anglicky
Platební akce: 'Schválit' Payment Action: 'Authorize'
csob_settings_action_CZ.png csob_settings_action_EN.png

10) Nastavete režim brány na Testování

česky anglicky
Režim brány: 'Testování' Gatewax Mode: 'Test'
csob_settings_gateway-mode_CZ.png csob_settings_gateway-mode_EN.png

11) Dále můžete nastavit ještě omezení podle zemí a pořadí zobrazení metody na pokladně.

Testování

Pro vyzkoušení, zda je platební metoda 'Platební brána ČSOB' správně nastavena, jsme připravili nejčastější scénáře.

V každém kroku každého scénáře:

  • provedete určenou akci
  • budete sledovat, zda se objeví očekávaný výsledek.
    Výsledkem může být: změna obsahu stránky na frontendu, email, vytvoření dokumentu v backendu, vznik transakce v backendu...
  • Zda budou odesílány e-maily záleží na nastavení obchodních e-mailů.
  • Máme-li k tomu v testovaném prostředí přístup, sledujeme také status platby pomocí CLI ... payment/status

Na platební bráně budete potřebovat ve většině scénářů platební kartu. Použijte jednu z testovacích karet.

Testovací karty

Číslo karty Expirace CVC/CVV Popis
4125010001000208 12/22 222 3DS VISA karta. Simulace úspěšné autentizace uživatele. Pokračuje se do autorizace (odpovědnost za případný fraud je na straně vydavatelské banky).
4125010001000208 12/22 300 totéž, ale nedostatek prostředků na kartě
4125010001000208 12/22 200 totéž, ale 'obecné zamítnutí'
4140920001000209 12/22 222 3DS VISA karta. Simulace neúspěšné autentizace uživatele. Uživatel má možnost zadat jinou kartu nebo zaplatit jiným způsobem.
4154610001000225 12/22 222 3DS VISA karta. Simulace neúplné autentizace uživatele. Pokračuje se do autorizace (odpovědnost za případný fraud je na straně platební brány).

Další testovací karty a informace k jejich použití najdete zde: https://github.com/csob/paymentgateway/wiki/Testovac%C3%AD-karty

Testovací scénáře

Testovací scénáře jsou ve dvou skupinách (podle nastavení Platební akce):

  • 'Schválit' (Authorize)
  • 'Zachytit a Schválit' (Capture and Authorize)

Všechny scénáře počítají s touto výchozí situací:

  • nastavení Platební akce (Payment Action) je buď Schválit (Authorize) nebo Zachytit a schválit (Capture and Authorize)
  • nastavení Režim brány (Gateway Mode) je pro testování vždy Testování (Test)
  • přihlášený zákazník má v košíku alespoň jednu položku,
  • přejde na pokladnu,
  • zvolí jako platební metodu Platební brána ČSOB, klikne na Objednat a je přesměrován na platební bránu.

scénáře pro akci 'Schválit' (Authorize)

Scénář č.1

V bráně nepoužiji kartu a klikám na "Zrušit platbu a vrátit se do obchodu"

Scénář č.1
1. krok ze 2 celkem

česky (anglicky)
Akce: (frontend) tlačítko Objednat Place Order
Výsledek:
frontend Platební brána
objednávka vytvořena
objednávka - status ČSOB Payment Redirected ČSOB Payment Redirected
objednávka - nové komentáře Platební transakce založena na ČSOB bráně Payment transaction initiated at the ČSOB gateway
Zákazník je přesměrován na ČSOB bránu The customer is redirected to ČSOB gateway.
transakce Objednávka Order
payment-status kód 1
payment-status význam Platba založena

Scénář č.1
2. krok ze 2 celkem

česky (anglicky)
Akce: (brána) Zrušit platbu a vrátit se do obchodu
Výsledek:
frontend Nákupní košík
objednávka - status Canceled Canceled
objednávka - nové komentáře csob_payment_failed - neplatná platba - stav: (3, Platba zrušena) csob_payment_failed - invalid payment status: (3, Platba zrušena)
Chyba v toku platby. Zpráva: neplatná platba - stav: (3, Platba zrušena) Failure in payment flow. Message: invalid payment status: (3, Platba zrušena)
payment-status kód 3
payment-status význam Platba zrušena

Scénář č.2

  • v bráně použiji platnou kartu
  • v backendu volím Invoice,
  • v backendu tvořím zásilku

Scénář č.2
1. krok ze 4 celkem

česky (anglicky)
Akce: (frontend) tlačítko Objednat Place Order
Výsledek:
frontend Platební brána
objednávka vytvořena
objednávka - status ČSOB Payment Redirected ČSOB Payment Redirected
objednávka - nové komentáře Platební transakce založena na ČSOB bráně Payment transaction initiated at the ČSOB gateway
Zákazník je přesměrován na ČSOB bránu The customer is redirected to ČSOB gateway.
transakce Objednávka Order
payment-status kód 1
payment-status význam Platba založena

Scénář č.2
2. krok ze 4 celkem

česky (anglicky)
Akce: (brána) Na bráně dávám platnou kartu
Výsledek:
frontend Děkujeme vám za objednávku Thank you for your purchase!
objednávka - status ČSOB Payment Completed ČSOB Payment Completed
objednávka - nové komentáře ČSOB platba je dokončena. The ČSOB payment is completed.
Autorizovaná částka z XXX. ID transakce: "YYY" Authorized amount of XXX. Transaction ID: "YYY"
Přesměrování zákazníka na stránku úspěchu pokladny Redirecting the customer to checkout success page.
transakce Autorizace Authorization
příchozí e-mail Nová objednávka
payment-status kód 4
payment-status význam Platba potvrzena

Scénář č.2
3. krok ze 4 celkem

česky (anglicky)
Akce: (backend) Faktura (Zachytit online) -> Vystavit fakturu Invoice (Capture Online) -> Submit Invoice
Výsledek:
objednávka - status Processing Processing
objednávka - nové komentáře ČSOB platba je dokončena. The ČSOB payment is completed.
Zachycená částka z XXX online. ID transakce: "YYY" Captured amount of XXX online. Transaction ID: "YYY"
faktura Vytvořena
transakce Zachytit Capture
příchozí e-mail Faktura
payment-status kód 7
payment-status význam Čekání na zúčtování

Scénář č.2
4. krok ze 4 celkem

česky (anglicky)
Akce: (backend) Zaslat -> Odeslat zásilku Ship -> Submit Shipment
Výsledek:
objednávka - status Complete Complete
zásilka Vytvořena
payment-status kód 7
payment-status význam Čekání na zúčtování

Scénář č.3

  • v bráně použiji platnou kartu
  • v backendu volím Invoice
  • v backendu zvolím fakturu, vytvořím dobropis (REFUND = refund online)

Scénář č.3
1. krok ze 4 celkem

česky (anglicky)
Akce: (frontend) tlačítko Objednat Place Order
Výsledek:
frontend Platební brána
objednávka vytvořena
objednávka - status ČSOB Payment Redirected ČSOB Payment Redirected
objednávka - nové komentáře Platební transakce založena na ČSOB bráně Payment transaction initiated at the ČSOB gateway
Zákazník je přesměrován na ČSOB bránu The customer is redirected to ČSOB gateway.
transakce Objednávka Order
payment-status kód 1
payment-status význam Platba založena

Scénář č.3
2. krok ze 4 celkem

česky (anglicky)
Akce: (brána) Na bráně dávám platnou kartu
Výsledek:
frontend Děkujeme vám za objednávku Thank you for your purchase!
objednávka - status ČSOB Payment Completed ČSOB Payment Completed
objednávka - nové komentáře ČSOB platba je dokončena. The ČSOB payment is completed.
Autorizovaná částka z XXX. ID transakce: "YYY" Authorized amount of XXX. Transaction ID: "YYY"
Přesměrování zákazníka na stránku úspěchu pokladny Redirecting the customer to checkout success page.
transakce Autorizace Authorization
příchozí e-mail Nová objednávka
payment-status kód 4
payment-status význam Platba potvrzena

Scénář č.3
3. krok ze 4 celkem

česky (anglicky)
Akce: (backend) Faktura (Zachytit online) -> Vystavit fakturu Invoice (Capture Online) -> Submit Invoice
Výsledek:
objednávka - status Processing Processing
objednávka - nové komentáře ČSOB platba je dokončena. The ČSOB payment is completed.
Zachycená částka z XXX online. ID transakce: "YYY" Captured amount of XXX online. Transaction ID: "YYY"
faktura Vytvořena
transakce Zachytit Capture
příchozí e-mail Faktura
payment-status kód 7
payment-status význam Čekání na zúčtování

Scénář č.3
4. krok ze 4 celkem

česky (anglicky)
Akce: (backend) Faktury (kliknout na konkrétní katuru) -> Dobropis -> Vrátit Invoice -> Credit Memo -> Refund
Výsledek:
objednávka - status Closed Closed
objednávka - nové komentáře Online vráceno XXX. ID transakce: "YYY" We refunded XXX online. Transaction ID: "YYY"
dobropis Vytvořen
transakce Vrátit Refund
payment-status kód 5
payment-status význam Platba odvolána

Scénář č.4

  • v bráně použiji platnou kartu
  • v backendu volím Void (ruším platbu)
  • s objednávkou se dá dále pracovat jiným způsobem (bez použití brány)

Scénář č.4
1. krok ze 3 celkem

česky (anglicky)
Akce: (frontend) tlačítko Objednat Place Order
Výsledek:
frontend Platební brána
objednávka vytvořena
objednávka - status ČSOB Payment Redirected ČSOB Payment Redirected
objednávka - nové komentáře Platební transakce založena na ČSOB bráně Payment transaction initiated at the ČSOB gateway
Zákazník je přesměrován na ČSOB bránu The customer is redirected to ČSOB gateway.
transakce Objednávka Order
payment-status kód 1
payment-status význam Platba založena

Scénář č.4
2. krok ze 3 celkem

česky (anglicky)
Akce: (brána) Na bráně dávám platnou kartu
Výsledek:
frontend Děkujeme vám za objednávku Thank you for your purchase!
objednávka - status ČSOB Payment Completed ČSOB Payment Completed
objednávka - nové komentáře ČSOB platba je dokončena. The ČSOB payment is completed.
Autorizovaná částka z XXX. ID transakce: "YYY" Authorized amount of XXX. Transaction ID: "YYY"
Přesměrování zákazníka na stránku úspěchu pokladny Redirecting the customer to checkout success page.
transakce Autorizace Authorization
příchozí e-mail Nová objednávka
payment-status kód 4
payment-status význam Platba potvrzena

Scénář č.4
3. krok ze 3 celkem

česky (anglicky)
Akce: (backend) u Objednávky volím Anulovat u Objednávky volím Void
Výsledek:
objednávka - status Processing Processing
objednávka - nové komentáře Schválení anulováno. Částka: XXX. ID transakce: "YYY" Voided authorization. Amount: XXX. Transaction ID: "YYY"
transakce Anulovat Void
payment-status kód 5
payment-status význam Platba odvolána

Scénář č.5

  • v bráně použiji platnou kartu
  • v backendu volím Cancel (ruším platbu i objednávku)

Scénář č.5
1. krok ze 3 celkem

česky (anglicky)
Akce: (frontend) tlačítko Objednat Place Order
Výsledek:
frontend Platební brána
objednávka vytvořena
objednávka - status ČSOB Payment Redirected ČSOB Payment Redirected
objednávka - nové komentáře Platební transakce založena na ČSOB bráně Payment transaction initiated at the ČSOB gateway
Zákazník je přesměrován na ČSOB bránu The customer is redirected to ČSOB gateway.
transakce Objednávka Order
payment-status kód 1
payment-status význam Platba založena

Scénář č.5
2. krok ze 3 celkem

česky (anglicky)
Akce: (brána) Na bráně dávám platnou kartu
Výsledek:
frontend Děkujeme vám za objednávku Thank you for your purchase!
objednávka - status ČSOB Payment Completed ČSOB Payment Completed
objednávka - nové komentáře ČSOB platba je dokončena. The ČSOB payment is completed.
Autorizovaná částka z XXX. ID transakce: "YYY" Authorized amount of XXX. Transaction ID: "YYY"
Přesměrování zákazníka na stránku úspěchu pokladny Redirecting the customer to checkout success page.
transakce Autorizace Authorization
příchozí e-mail Nová objednávka
payment-status kód 4
payment-status význam Platba potvrzena

Scénář č.5
3. krok ze 3 celkem

česky (anglicky)
Akce: (backend) u Objednávky volím Zrušit u Objednávky volím Cancel
Výsledek:
objednávka - status Canceled Canceled
objednávka - nové komentáře Online zrušená objednávka Částka: XXX. ID transakce: "YYY" Canceled order online Amount: XXX. Transaction ID: "YYY"
transakce Anulovat Void
payment-status kód 5
payment-status význam Platba odvolána

scénáře pro akci 'Zachytit a Schválit' (Capture and Authorize)

Scénář č.6

V bráně nepoužiji kartu a klikám na "Zrušit platbu a vrátit se do obchodu"

Scénář č.6
1. krok ze 2 celkem

česky (anglicky)
Akce: (frontend) tlačítko Objednat Place Order
Výsledek:
frontend Platební brána
objednávka vytvořena
objednávka - status ČSOB Payment Redirected ČSOB Payment Redirected
objednávka - nové komentáře Platební transakce založena na ČSOB bráně Payment transaction initiated at the ČSOB gateway
Zákazník je přesměrován na ČSOB bránu The customer is redirected to ČSOB gateway.
transakce Objednávka Order
payment-status kód 1
payment-status význam Platba založena

Scénář č.6
2. krok ze 2 celkem

česky (anglicky)
Akce: (brána) Zrušit platbu a vrátit se do obchodu
Výsledek:
frontend Nákupní košík
objednávka - status Canceled Canceled
objednávka - nové komentáře csob_payment_failed - neplatná platba - stav: (3, Platba zrušena) csob_payment_failed - invalid payment status: (3, Platba zrušena)
Chyba v toku platby. Zpráva: neplatná platba - stav: (3, Platba zrušena) Failure in payment flow. Message: invalid payment status: (3, Platba zrušena)
payment-status kód 3
payment-status význam Platba zrušena

Scénář č.7

  • v bráně použiji platnou kartu
  • v backendu tvořím zásilku

Scénář č.7
1. krok ze 3 celkem

česky (anglicky)
Akce: (frontend) tlačítko Objednat Place Order
Výsledek:
frontend Platební brána
objednávka vytvořena
objednávka - status ČSOB Payment Redirected ČSOB Payment Redirected
objednávka - nové komentáře Platební transakce založena na ČSOB bráně ID transakce: "YYY" Payment transaction initiated at the ČSOB gateway Transaction ID: "YYY"
Zákazník je přesměrován na ČSOB bránu The customer is redirected to ČSOB gateway.
transakce Objednávka Order
payment-status kód 1
payment-status význam Platba založena

Scénář č.7
2. krok ze 3 celkem

česky (anglicky)
Akce: (brána) Na bráně dávám platnou kartu
Výsledek:
frontend Děkujeme vám za objednávku Thank you for your purchase!
objednávka - status ČSOB Payment Completed ČSOB Payment Completed
objednávka - nové komentáře ČSOB platba je dokončena. The ČSOB payment is completed.
Zachycená částka XXX online. ID transakce: "YYY" Captured amount of XXX online. Transaction ID: "YYY"
Přesměrování zákazníka na stránku úspěchu pokladny Redirecting the customer to checkout success page.
faktura Vytvořena
transakce Zachytit Capture
příchozí e-mail Nová objednávka
payment-status kód 7
payment-status význam Čekání na zúčtování

Scénář č.7
3. krok ze 3 celkem

česky (anglicky)
Akce: (backend) Zaslat -> Odeslat zásilku Ship -> Submit Shipment
Výsledek:
objednávka - status Complete Complete
zásilka Vytvořena
payment-status kód 7
payment-status význam Čekání na zúčtování

Scénář č.8

-v bráně použiji platnou kartu
-v backendu u faktury tvořím Dobropis (REFUND = refund online)

Scénář č.8 1. krok ze 3 celkem

česky (anglicky)
Akce: (frontend) tlačítko Objednat Place Order
Výsledek:
frontend Platební brána
objednávka vytvořena
objednávka - status ČSOB Payment Redirected ČSOB Payment Redirected
objednávka - nové komentáře Platební transakce založena na ČSOB bráně ID transakce: "YYY" Payment transaction initiated at the ČSOB gateway Transaction ID: "YYY"
Zákazník je přesměrován na ČSOB bránu The customer is redirected to ČSOB gateway.
transakce Objednávka Order
payment-status kód 1
payment-status význam Platba založena

Scénář č.8
2. krok ze 3 celkem

česky (anglicky)
Akce: (brána) Na bráně dávám platnou kartu
Výsledek:
frontend Děkujeme vám za objednávku Thank you for your purchase!
objednávka - status ČSOB Payment Completed ČSOB Payment Completed
objednávka - nové komentáře ČSOB platba je dokončena. The ČSOB payment is completed.
Zachycená částka XXX online. ID transakce: "YYY" Captured amount of XXX online. Transaction ID: "YYY"
Přesměrování zákazníka na stránku úspěchu pokladny Redirecting the customer to checkout success page.
faktura Vytvořena
transakce Zachytit Capture
příchozí e-mail Nová objednávka
payment-status kód 7
payment-status význam Čekání na zúčtování

Scénář č.8
3. krok ze 3 celkem

česky (anglicky)
Akce: (backend) Faktury (kliknout na konkrétní katuru) -> Dobropis -> Vrátit Invoice -> Credit Memo -> Refund
Výsledek:
objednávka - status Closed Closed
objednávka - nové komentáře Online vráceno XXX. ID transakce: "YYY" We refunded XXX online. Transaction ID: "YYY"
dobropis Vytvořen
transakce Vrátit Refund
payment-status kód 5
payment-status význam Platba odvolána