GP WebPay pro PrestaShop (platební modul)

Modul splňuje požadavek na přítomnost parametru ADDINFO k datu 30.9.2021

Článek o povinné aktualizaci modulu GP WebPay

Účel modulu: Platební modul pro PrestaShop zajišťující příjem plateb kreditními a debetními kartami MasterCard, VISA, Diners Club International a American Express ve vašem e-shopu. GP WebPay podporuje platby přes Apple Pay a Google Pay.

Pro provozování GP WebPay, nemusí mít obchodník konkrétní banku - smlouvu můžete uzavřít přímo s GP WebPay a peníze přijímané z karetních operací v e-shopu zasílat na účet v libovolné bance.

GP WebPay je multi-měnová internetová platební brána pro rychlé a bezpečné platby, která umožňuje platby tuzemskými i zahraničními kartami asociací MasterCard, VISA, Diners Club International a American Express. Podporuje také platby digitální peněženkou MasterPass a MasterCard Mobile, které probíhají přes mobilní telefon pomocí QR kódu.

GP WebPay odpovídá celosvětovým standardům a splňuje nejpřísnější bezpečnostní požadavky MasterCard SecureCode a Verified by VISA a SafeKey, definované karetními asociacemi MasterCard, VISA a American Express. Tyto standardy jsou označovány jako 3D Secure a zaručují maximální bezpečnost plateb.

Vlastnosti platební brány

Seznam vlastností níže je pouze orientační. Všechny aktuální obchodní podmínky o provozování platební brány GP WebPay a rozsah nabízených služeb naleznete na webu www.gpwebpay.cz

• obchodník nemusí mít konkrétní banku - smlouvu umí uzavřít přímo s GP WebPay a peníze přijímané z karetních operací v e-shopu si nechat zasílat na účet v libovolné bance - formulář pro podání žádosti
• banky, ve kterých víte uzavřít smlouvu na pobočce:
  • Česká spořitelna (ČR)
  • Komerční Banka (ČR)
  • UniCredit Bank (ČR)
  • Raiffeisen Bank (ČR)
  • Slovenská sporiteľňa (Slovensko)
  • Československá obchodná banka (ČSOB) (Slovensko)
  • UniCredit Bank (Slovensko)
  • Latvijas pasta banka (Lotyšsko)
• podporované karty:
  • MasterCard
  • VISA
  • Diners Club International
  • American Express
  • MasterPass (digitální peněženka)
  • MasterCard Mobile (digitální peněženka)
• podpora plateb přes Apple Pay
• podpora plateb přes Google Pay
• podporované platební měny:
  • Česká koruna
  • Euro
  • Anglická libra
  • Americký Dolar
  • Maďarský forint
  • Polský złoty
  • Ruský rubl

Vlastnosti modulu

• kompatibilita: PrestaShop 1.5.x - 1.7.x
• kompatibilita: thirty bees 1.0.x - 1.2.x
• podpora funkce Multistore (více obchodů)
• nešifrovaný a otevřený kód modulu
• možnost určit způsob objednávání
  • vytvoření objednávky před platbou (identifikátorem platby je číslo objednávky)
  • vytvoření objednávky po zaplacení (identifikátorem platby je číslo nákupního košíku)
• podpora platby ve více platebních měnách - pokud máte uzavřenou smlouvu pro platby kartou ve více měnách
• možnost určit a párovat stavy objednávek, které modul přiřazuje objednávkám v závislosti na stavu platby přímo v administraci modulu
• možnost dokončit platbu později a / nebo zrušit nedokončenou platbu - v historii objednávek najde zákazník výzvu k opakování platby, pokud je objednávka stále ve stavu čekání na platbu
• možnosť zaslania odkazu na dokončenie či opakovanie platby kartou zákazníkovi v notifikačnom e-maile
• možnost vložit marketingové a affiliate kódy do posledního kroku platby
• možnost zobrazit loga platebních karet z modulu kdekoliv v e-shopu, formou jednoduchého vložení ukotvení do TPL šablony
• všechny loga podporovaných platebních karet jsou v bezztrátovém formátu SVG a tvarované jako dlaždice CSS kódem
• "classic" i "moderní" šablony notifikačních e-mailů modulu + TWIG šablona pro generování HTML šablon
• záznam transakcí do .LOG souboru v kořenové složce modulu a přístupné z administrace modulu
• automatická implementace ikony platebního systému a log akceptovaných bankovních karet ve veřejné části Vašeho obchodu
• automatická implementace příslušných nových stavů objednávek a oznamovacích e-mailových šablon do PrestaShop-u
• možnost měnit pozici platební ikony z administrace modulu (levý / pravý sloupec, stránka detailu produktu)
• možnost nastavit odkaz cílové statické (CMS) stránky z ikony GP WebPay
• možnost vypnout/zapnout Material Design Icons
• dostupné překlady modulu: český, slovenský a anglický
• rychlá instalace
• snadné nastavení

Kroky implementace služby GP WebPay

1. Uzavřete s GP WebPay smlouvu o provozování služby pro již existující internetový obchod. Nezapomeňte, karetní společnost e-shop zkontroluje, zda v něm máte uvedeny plné kontaktní údaje, obchodní podmínky apod.
2. Od GP WebPay obdržíte osobní číslo obchodníka a údaje pro testování.
3. Zakupte, nainstalujte a nastavte modul do Vašeho PrestaShop-u podle přiloženého manuálu (viz "Instalace, nastavení a testování modulu").
4. Proveďte testování funkčnosti platebního modulu.
5. Pokud bylo testování úspěšné, modul je připraven k provozu.
6. Pokud bylo testování neúspěšné, zkontrolujte nejprve nastavení modulu podle manuálu a až pak kontaktujte autora modulu.

Vložení statistických a marketingových měřících kódů

Pokud potřebujete vložit statistické a marketingové / affiliate měřicí kódy, můžete tak učinit v šabloně modulu /modules/gpwebpay/views/templates/front/tracking_codes.tpl. následujte proměnnou $payment_status, která nabývá stav"success" pro úspěšnou platbu, nebo "fail" pro neúspěšnou nebo neuskutečněnou platbu. Tento způsob vložení kódů je nutný pouze tehdy, pokud je v nastavení modulu vybrána volba pro způsob objednávání "vytvořit objednávku před zaplacením".

Dostupné jsou následující proměnné - nezapomeňte použít tagy {literal} {/literal}:

• {$total} - celková cena objednávky
• {$order_reference} - kód objednávky
• {$order_id} - číslo objednávky
• {$currency_iso} - platební měna objednávky - ISO kód (např.: 987 pro Euro, 203 pro Českou korunu)
• {$currency_sign} - platební měna objednávky - kód (např.: EUR pre Euro, CZK pro Českou korunu)

Pro vložení kódů doporučujeme oslovit PHP & SMARTY programátora.

Vygenerování soukromým klíčů (certifikátů)

Upozornění: Proces vytvoření soukromých klíčů se skládá z generování testovacího a potom produkčního klíče!

1. Přejděte na portál: test.portal.gpwebpay.com
2. Přihlaste se prostřednictvím údajů, které Vám poskytlo GP WebPay:
   • Číslo obchodníka
   • Jméno
   • Heslo
3. Po úspěšném přihlášení přejděte prosím do části "Zpráva klíčů".
4. Vygenerujte si Váš testovací soukromý klíč následovně - podívejte se na video:
   1. Při generování si zvolte heslo.
   2. Vygenerovaný klíč s názvem "gpwebpay-pvk.key" si pak jako soubor uložte do Vašeho počítače.
   3. Portál Vás vyzve opět k jeho nahrání spolu s vložením hesla, které jste si zvolili v kroku 4.I.
5. Přejděte do nastavení modulu a vložte údaje:
   • číslo obchodníka
   • heslo privátního klíče použité v kroku 4.I.
6. Otevřete soubor "gpwebpay-pvk.key" v jednoduchém textovém editoru (Notepad apod.).
7. Zkopírujte (CTRL+C, ⌘C) obsah celého souboru do schránky Vašeho počítače a v nastaveních modulu ho vložte (CTRL+V, ⌘V) do pole "Soukromý klíč (testovací)".
8. Otestujte modul provedením testovací platby. Postupujte podle části "Instalace, nastavení a testování modulu". Číslo testovací karty a heslo Vám poskytne GP WebPay.
9. Celý proces opakujte i pro vygenerování Produkčního soukromého klíče s tím rozdílem, že se přihlásíte na portál portal.gpwebpay.com a vygenerovaný produkční soukromný klíč vložíte do pole modulu "Soukromý klíč (produkční)".

Instalace, nastavení a testování modulu

1. Ověřte, že konfigurace Vašeho serveru má zapnuté rozšíření: openssl_get_privatekey, openssl_sign, base64_encode, openssl_free_key, openssl_get_publickey a openssl_verify. V opačném případě nebude modul fungovat.
2. Nahrajte složku "gpwebpay" manuálně do složky /modules/ prostřednictvím FTP, nebo použijte nástroj pro nahrávání modulů v části Kontrolní panel » Moduly » Správce modulů » Nahrát modul.
3. Pokud jste modul nahráli přes FTP, proveďte jeho instalaci v části: Kontrolní panel » Moduly » Knihovna modulů
4. Pokud jste modul nahráli přes rozhraní kontrolního panelu, modul se současně i nainstaloval.
5. Přejděte k nastavením: Kontrolní panel » Platby » Předvolby » Omezení na základě měny, a zaškrtněte všechny platební měny, pro které máte s GP WebPay podepsanou smlouvu.
6. Přejděte do nastavení modulu a zadejte všechny potřebné údaje:
   • Číslo obchodníka
   • Heslo privátního klíče
   • Smluvní banka
   • vložte testovací soukromý klíč podle části "Vygenerování privátních klíčů (certifikátů)"
7. Režim provozu nastavte do stavu "testovací".
8. Proveďte otestování funkčnosti modulu a ověření jeho správné činnosti vytvořením testovací objednávky a platby (GP WebPay Vám poskytne číslo testovací karty a heslo).
9. Po úspěšném otestování funkčnosti Vám GP WebPay zašle údaje pro vygenerování produkčního soukromého klíče.
10. Implementujte produkční soukromý klíč podle části "Vygenerování privátních klíčů (certifikátů)".
11. Nastavte Režim provozu modulu do stavu "produkční". Tímto krokem je platební brána GP WebPay připravená pro práci v ostrém provozu.
12. Při instalaci modulu došlo k automatickému umístění ikony platebního systému a platebních karet v detailu produktu ve veřejné části e-shopu.
13. V souvislosti s ochranou osobních údajů podle směrnice GDPR doplňte do prohlášení o GDPR ve Vašem e-shopu informace o platební bráně GP WebPay se seznamem níže uvedených údajů zákazníka, které do platební brány odesíláte:
    • Jméno a příjmení (Name)
    • E-mailová adresa (Email address)
    • Domácí telefonní číslo (Home phone number)
    • Číslo mobilního telefonu (Mobile phone number)
    • Fakturační adresa (Billing address)
    • Dodací adresa (Shipping address)
14. Pokud by se vyskytl problém, zkontrolujte nejdříve správnost údajů vložených do nastavení modulu. Pokud problém přetrvává, kontaktujte prosím autora modulu.

GP WEBPAY PAYMENT GATEWAY MODULE - CHANGELOG

----------------- PrestaShop 1.7.x -----------------

version 1.7.10 (12/25/2021)
    + added displayAdminOrderMainBottom hook
    + added information & action panel about card transaction in the back-office order detail 
    + added order payment record if payment state has logable option allowed
    + added an option to choose payment variable symbol type (Order ID or Order reference)
    + added link to list of Payment return codes
    x fixed bug of validating payment in the testing mode (Live Merchant Number was provided instead Testing Merchant Number)

version 1.7.9 (12/01/2021)
    + added an alert about Phone / Mobile number field requirement in customers addresses
    + added phone and mobile phone into ADDINFO parameter
    + added online module documentation
    x fixed variables for inserting a tracking code
    x fixed bug in association of including tracking_codes.tpl template
    x fixed width of URL in debugging mode

version 1.7.8 (09/20/2021)
    MANDATORY UPDATE RELEASE - Merchant Integration Manual HTTP API; version: 1.13 used
    + added ADDINFO parameter (mandatory from 09/30/2021 - the older module versions stop working)

    + added displayOrderDetail hook
    + added "Finish payment" button - the customer is now allowed to pay later from an Order detail / Guest tracking page
    + added "Cancel payment & order" button - the customer is now allowed to cancel the payment and order
    + added an option to redirect customer when the payment was not successful: 
       + for "place an order before the payment" order method - redirect into order detial page with "Finish payment" button
       + for "place an order after the payment" order method - redirect back into checkout
    + added variables for adding a marketing & affiliate codes
    + added an warning alert when friendly URLs are disabled and SSL is not available
    + added changing order state when customer cancel the payment (for "place an order before the payment" order method)
    + added Extra email variables
    + added "modern" e-mail templates + TWIG template for generate HTML templates
    + added log file to recording payment transactions for debugging purposes

    - removed useless payment step - the customer is redirected on payment gateway directly from the checkout page

    x modified multi-currency support
    x fixed parameters in {guest_tracking_url} template email URL
    x improved return URL when guest/customer cancel the order by his choice
    x fixed an issue when friendly URLs were disabled 
    x revamped whole payment and redirection process
    x improved payment intro page in the checkout - added information about payment process
    x improved module code
    x updated module documentation
    x simplified of the payment execution template
    x updated notification email templates - added "Finish Payment" button
    x updated VISA logo, 2021 version

version 1.7.7 (04/26/2021)
    x updated release - Merchant Integration Manual HTTP API; version: 1.11 used
    + added Apple Pay & Google Pay logos
    + added explanation instruction for customers on the Checkout
    + added fields for testing Merchant ID and Private key password - allow switch between Live & Testing environment without changing module setting
    + added an PHP warning alert
    + added a custom hook {hook h='displaygpwebpayicons'} in order to display module payment icons everywhere you want
    + added Back Office CSS file (displayBackOfficeHeader hook)
    x various code improvements
    x updated module documentation
    - removed module JS file that may affected PrestaShop BO
    + added an option to redirect customer back into checkout when the payment was not successful (for "place an order after the payment" order method)

version 1.7.6 (09/16/2020)
    + added UniCredit Bank (Slovakia)
    x updated module documentation
    + added an alert when Friendly URLs are disabled

version 1.7.5 (05/03/2020)
    + added private notes field
    + added selector for PrestaShop theme (on/off Material Design Icons)
    x payment icons redesign
    x improved module back office - added an icons and buttons
    x fixed return link when the cardholder canceled the payment (PRCODE = 50)

version 1.7.4 (06/28/2019)
    + added "REFERENCENUMBER" parameter for pairing the payments

version 1.7.3 (06/13/2018)
    x changed payment description
    x removed CSOB Cz

version 1.7.2 (03/19/2018)
    x fixed currency ID in the payment process 
    x fixed an order of the variables in the URL

version 1.7.1 (02/22/2018)
    x fixed bug in validation process
    x removed max. length parameter for Private key password

version 1.7.0 (12/31/2017)
    + initial release for PrestaShop 1.7.x (testing environment: PrestaShop 1.7.2.4)
    + front office redesign for PrestaShop 1.7 Classic theme

----------------- PrestaShop 1.6.x only -----------------

version 1.6.7 (12/25/2021)
    + added an alert about Phone / Mobile number field requirement in customers addresses
    + added phone and mobile phone into ADDINFO parameter
    + added online module documentation
    + added order payment record if payment state has logable option allowed
    + added link to list of Payment return codes
    + added an option to choose payment variable symbol type (Order ID or Order reference)
    x fixed variables for inserting a tracking code
    x fixed bug in association of including tracking_codes.tpl template
    x fixed width of URL in debugging mode
    x fixed bug of validating payment in the testing mode (Live Merchant Number was provided instead Testing Merchant Number)

version 1.6.6 (09/29/2021)
    MANDATORY UPDATE RELEASE - Merchant Integration Manual HTTP API; version: 1.13 used
    + added ADDINFO parameter (mandatory from 09/30/2021 - the older module versions stop working)

    + added displayOrderDetail hook
    + added "Finish payment" button - the customer is now allowed to pay later from an Order detail / Guest tracking page
    + added "Cancel payment & order" button - the customer is now allowed to cancel the payment and order
    + added an option to redirect customer when the payment was not successful: 
       + for "place an order before the payment" order method - redirect into order detial page with "Finish payment" button
       + for "place an order after the payment" order method - redirect back into checkout
    + added variables for adding a marketing & affiliate codes
    + added an warning alert when friendly URLs are disabled and SSL is not available
    + added changing order state when customer cancel the payment (for "place an order before the payment" order method)
    + added Extra email variables
    + added Apple Pay & Google Pay logos
    + added explanation instruction for customers on the Checkout
    + added fields for testing Merchant ID and Private key password - allow switch between Live & Testing environment without changing module setting
    + added an PHP warning alert
    + added a custom hook {hook h='displaygpwebpayicons'} in order to display module payment icons everywhere you want
    + added Back Office CSS file (displayBackOfficeHeader hook)
    + added an option to redirect customer back into checkout when the payment was not successful (for "place an order after the payment" order method)
    + added log file for debugging purposes to recording: request payment info/URL, return payment info/URL, transaction notification
    + added "repeat" controller in order to fix conflict with "payment" controller and PS_PURCHASE_MINIMUM value when calling repeat the payment

    - removed useless payment step - the customer is redirected on payment gateway directly from the checkout page
    - removed module JS file that may affected PrestaShop BO

    x fixed Repeat payment bug with redirection when minimal purchase is no zero - thanks Mr. Jiri Virt (virt@volny.cz)
    x modified multi-currency support
    x fixed parameters in {guest_tracking_url} template email URL
    x improved return URL when guest/customer cancel the order by his choice
    x fixed an issue when friendly URLs were disabled 
    x revamped whole payment and redirection process
    x improved payment intro page in the checkout - added information about payment process
    x simplified of the payment execution template
    x updated notification email templates - added "Finish Payment" button
    x fixed order data in notification controller
    x fixed payment return referral URL for log
    x updated VISA and VISA Electron logo, 2021 version
    x various code improvements
    x updated module documentation

version 1.6.5 (09/16/2020)
    + added UniCredit Bank (Slovakia)
    x updated module documentation

version 1.6.4 (05/03/2020)
    + added "REFERENCENUMBER" parameter for pairing the payments
    x fixed displaying the card logos on the checkout page
    x fixed return link when the cardholder canceled the payment (PRCODE = 50)

version 1.6.3 (06/13/2018)
    x changed payment description
    x removed CSOB Cz

version 1.6.2 (04/10/2018)
    x fixed currency ID in the payment process
    x fixed an order of the variables in the URL

version 1.6.1 (02/22/2018)
    x fixed bug in validation process
    x removed max. length parameter for Private key password

version 1.6.0 (12/31/2017)
    x completely rewrited module code
    + added dual payment method: Order method selector (creating an order before or after the payment)
    + added new payment statuse "Awaiting GP WebPay payment"
    + added Order payment status selectors to freedom in pairing module statuses with PrestaShop built-in order statuses
    + added CMS page selector for icon destination link
    x fixed compatibility with "Advanced EU Compliance" module
    x changed the way to store private keys
    x improved testing mode
    x updated card payment logos
    x updated editable source file for card payment logos
    x updated module documentation
    x updated "Terms and conditions of use" document
    x improved the module code

----------------- PrestaShop 1.5.x + 1.6.x -----------------

version 1.3.0 (05/04/2017)
    + added payment URL for Ceska sporitelna
    + added compatibility with "Advanced EU Compliance" module
    x important: fix of RESULTTEXT and MD return parameters (parameters are not mandatory).
    x "img" and "css" folders moved into "views" folder
    x updated module documentation
    x moved validation script into "response" folder

version 1.2.1 (04/14/2017)
    + added correct payment URL for Slovenska sporitelna
    x fixed deprecated methods & class names for PHP 7
    x fixed URL's for SSL
    x minor code changes
    x updated module documentation
    x updated "Terms and conditions of use" document

version 1.2.0 (10/14/2016)
    + added new supported bank - Slovenska sporitelna a.s.
    x updated module documentation - added new way private key generation
    x moved validation.php into "response" folder
    x fixed private message (removed HTML elements) saved in the order
    x correction of Czech translation
    x fixed transaction record table & limited on 50 rows
    - removed application for generating kyes by old way

version 1.1.1 (08/01/2016)
    x changed length of Private key password field

version 1.1.0 (01/16/2016)
    + module compatibility for PrestaShop 1.6.x and 1.5.x
    + added Multi-store feature support
    + added payment icons and position control in module control panel
    + added selector for initial payment status
    + added payment records listing
    x updated available Bank and Currency list
    x redesign module Back office for PrestaShop 1.6.x
    x updated and improved module Documentation

----------------- PrestaShop 1.4.x -----------------

version 1.0.0 (12/25/2012)
    + initial release for PrestaShop 1.4.x

---------------------

Legend:
    + added a new feature
    x fixed issue, updated feature
    - removed feature