Modul: GP WebPay pre PrestaShop (platba kartou)

Modul spĺňa požiadavku na prítomnosť parametra ADDINFO k 30.9.2021

Článok o povinnej aktualizácii modulu GP WebPay

Účel modulu: Platobný modul pre PrestaShop zabezpečujúci príjem platieb kreditnými a debetnými kartami MasterCard, VISA, Diners Club International a American Express vo Vašom e-shope. GP WebPay podporuje platby cez Apple Pay a Google Pay.

Pre prevádzkovanie GP WebPay, nemusí mať obchodník konkrétnu banku - zmluvu môžete uzavrieť priamo s GP WebPay a peniaze prijímané z kartových operácií v e-shope zasielať na účet v ľubovolnej banke.

GP WebPay je multi-menová internetová platobná brána pre rýchle a bezpečné platby, ktorá umožňuje platby domácimi aj zahraničnými kartami asociáciou MasterCard, VISA, Diners Club International a American Express. Podporuje tiež platby digitálnou peňaženkou MasterPass a MasterCard Mobile, ktoré prebiehajú cez mobilný telefón pomocou QR kódu.

GP WebPay zodpovedá celosvetovým štandardom a spĺňa najprísnejšie bezpečnostné požiadavky MasterCard SecureCode a Verified by VISA a SafeKey, definovanej kartovými asociáciami MasterCard, VISA a American Express. Tieto štandardy sú označované ako 3D Secure a zaručujú maximálnu bezpečnosť platieb.

Vlastnosti platobnej brány

Zoznam vlastností nižšie je len orientačný. Všetky aktuálne obchodné podmienky o prevádzkovaní platobnej brány GP WebPay a rozsah ponúkaných služieb nájdete na webe www.gpwebpay.cz

• obchodník nemusí mať konkrétnu banku - zmluvu vie uzavrieť priamo s GP WebPay a peniaze prijímané z kartových operácií v e-shope si nechať zasielať na účet v ľubovolnej banke - formulár pre podanie žiadosti
• banky, v ktorých viete uzavrieť zmluvu na pobočke:
  • Slovenská sporiteľňa (Slovensko)
  • Československá obchodná banka (ČSOB) (Slovensko)
  • UniCredit Bank (Slovensko)
  • Česká spořitelna (ČR)
  • Komerční Banka (ČR)
  • UniCredit Bank (ČR)
  • Raiffeisen Bank (ČR)
  • Latvijas pasta banka (Lotyšsko)
• podporované karty:
  • MasterCard
  • VISA
  • Diners Club International
  • American Express
  • MasterPass (digitálna peňaženka)
  • MasterCard Mobile (digitálna peňaženka)
• podpora platieb cez Apple Pay
• podpora platieb cez Google Pay
• dostupné platobné meny:
  • Euro
  • Česká koruna
  • Anglická libra
  • Americký Dolár
  • Maďarský forint
  • Poľský złoty
  • Ruský rubeľ

Vlastnosti modulu

• kompatibilita: PrestaShop 1.5.x - 1.7.x
  kompatibilita: thirty bees 1.0.x - 1.3.x
• podpora funkcie Multistore (viac obchodov)
• nešifrovaný a otvorený kód modulu
• možnosť určiť spôsob objednávania
  • vytvorenie objednávky pred platbou (identifikátorom platby je číslo objednávky)
  • vytvorenie objednávky po zaplatení (identifikátorom platby je číslo nákupného košíka)
• podpora platby vo viacerých platobných menách - ak máte uzavretú zmluvu pre platby kartou vo viacerých menách
• možnosť určiť a párovať stavy objednávok, ktoré modul priraďuje objednávkam v závislosti od stavu platby priamo v administrácii modulu
• možnosť dokončiť platbu neskôr a/alebo zrušiť nedokončenú platbu - v histórii objednávok nájde zákazník výzvu na opakovanie platby, ak je objednávka stále v stave čakania na platbu
• možnosť zaslania odkazu na dokončenie či opakovanie platby kartou zákazníkovi v notifikačnom e-maile
• možnosť vložiť marketingové a affiliate kódy do posledného kroku platby
• možnosť zobraziť logá platobných kariet z modulu kdekoľvek v e-shope, formou jednoduchého vloženia ukotvenia do TPL šablóny
• všetky logá podporovaných platobných kariet sú v bezstratovom formáte SVG a tvarované ako dlaždice CSS kódom
• "classic" aj "modern" šablóny notifikačných e-mailov modulu + TWIG šablóna pre generovanie HTML šablón
• záznam transakcií do .LOG súboru v koreňovom priečinku modulu a prístupné z administrácie modulu
• automatická implementácia ikony platobného systému a lôg akceptovaných bankových kariet vo verejnej časti Vášho obchodu
• automatická implementácia príslušných nových stavov objednávok a notifikačných e-mailových šablón do PrestaShop-u
• možnosť meniť pozíciu platobnej ikony z administrácie modulu (ľavý / pravý stĺpec, stránka detailu produktu)
• možnosť nastaviť odkaz cieľovej statickej (CMS) stránky z ikony GP WebPay
• možnosť vypnúť/zapnúť Material Design Icons
• dostupné preklady modulu: slovenský, český a anglický
• rýchla inštalácia
• jednoduché nastavenie

Kroky implementácie služby GP WebPay

1. Uzavrite s GP WebPay zmluvu o prevádzkovaní služby pre už existujúci internetový obchod. Nezabudnite, kartová spoločnosť e-shop skontroluje, či v ňom máte uvedené plné kontaktné údaje, obchodné podmienky apod.
2. Od GP WebPay obdržíte osobné číslo obchodníka a údaje pre testovanie.
3. Zakúpte, nainštalujte a nastavte modul do Vášho PrestaShopu podľa priloženého manuálu (pozrite si "Inštalácia, nastavenie a testovanie modulu").
4. Vykonajte testovanie funkčnosti platobného modulu.
5. Ak bolo testovanie úspešné, modul je pripravený k prevádzke.
6. Ak bolo testovanie neúspešné, skontrolujte najskôr nastavenie modulu podľa manuálu a až potom kontaktujte autora modulu.

Vloženie štatistických a marketingových meracích kódov

Ak potrebujete vložiť štatistické a marketingové / affiliate meracie kódy, môžete tak urobiť v šablóne modulu /modules/gpwebpay/views/templates/front/tracking_codes.tpl. Následujte premennú $payment_status, ktorá nadobúda stav"success" pre úspešnú platbu, alebo "fail" pre neúspešnú, alebo neuskutočnenú platbu. Tento spôsob vloženia kódov je potrebný iba vtedy, ak je v nastaveniach modulu vybratá voľba pre spôsob objednávania "vytvoriť objednávku pred zaplatením".

Dostupné sú nasledujúce premenné - nezabudnite použiť tagy {literal} {/literal}:

• {$total} - celková cena objednávky
• {$order_reference} - kód objednávky
• {$order_id} - číslo objednávky
• {$currency_iso} - platobná mena objednávky - ISO kód (napr.: 987 pre Euro, 203 pre Českú korunu)
• {$currency_sign} - platobná mena objednávky - kód (napr.: EUR pre Euro, CZK pre Českú korunu)

Pre vloženie kódov odporúčame osloviť PHP & SMARTY programátora.

Vygenerovanie súkromných kľúčov (certifikátov)

Upozornenie: Proces vytvorenia súkromných kľúčov sa skladá z generovania testovacieho a potom produkčného kľúča!

1. Prejdite na portál: test.portal.gpwebpay.com
2. Prihláste sa prostredníctvom údajov, ktoré Vám poskytla GP WebPay:
   • Číslo obchodníka
   • Meno
   • Heslo
3. Po úspešnom prihlásení prejdite prosím do časti "Správa kľúčov".
4. Vygenerujte si Váš testovací súkromný kľúč nasledujúcim spôsobom - pozrite si video:
   1. Pri generovaní si zvoľte heslo.
   2. Vygenerovaný kľúč s názvom "gpwebpay-pvk.key" si potom ako súbor uložte do Vášho počítača.
   3. Portál Vás vyzve opäť k jeho nahratiu spolu s vložením hesla, ktoré ste si zvolili v kroku 4.I.
5. Prejdite do nastavenia modulu, vložte a uložte údaje:
   • číslo obchodníka
   • heslo privátneho kľúča použité v kroku 4.I.
6. Otvorte súbor "gpwebpay-pvk.key" v jednoduchom textovom editore (Notepad apod.).
7. Skopírujte (CTRL+C, ⌘C) obsah celého súboru do schránky Vášho počítača a v nastaveniach modulu ho vložte (CTRL+V, ⌘V) do poľa "Súkromný kľúč (testovací)".
8. Otestujte modul vykonaním testovacej platby. Postupujte podľa časti "Inštalácia, nastavenie a testovanie modulu". Číslo testovacej karty a heslo Vám poskytne GP WebPay.
9. Celý proces opakujte aj pre vygenerovanie Produkčného súkromného kľúča s tým rozdielom, že sa prihlásite na portál portal.gpwebpay.com a vygenerovaný produkčný súkromný kľúč vložíte do poľa modulu "Súkromný kľúč (produkčný)".

Inštalácia, nastavenie a testovanie modulu

1. Overte, že konfigurácia Vášho servera má zapnuté rozšírenia: openssl_get_privatekey, openssl_sign, base64_encode, openssl_free_key, openssl_get_publickey a openssl_verify. V opačnom prípade nebude modul fungovať.
2. Nahrajte priečinok "gpwebpay" manuálne do priečinku /modules/ prostredníctvom FTP, alebo použite nástroj pre nahrávanie modulov v časti Ovládací panel » Moduly » Správca modulov » Nahrať modul.
3. Ak ste modul nahrali cez FTP, vykonajte jeho inštaláciu v časti: Ovládací panel » Moduly » Knižnica modulov
4. Ak ste modul nahrali cez rozhranie ovládacieho panela, modul sa súčasne aj nainštaloval.Prejdite k nastaveniam: Ovládací panel » Platby » Predvoľby » Obmedzenia na základe meny, a zaškrtnite všetky platobné meny, pre ktoré máte s GP WebPay podpísanú zmluvu.
5. Prejdite do nastavení modulu a zadajte všetky potrebné údaje:
   • Číslo obchodníka
   • Heslo privátneho kľúča
   • Zmluvná banka
   • vložte testovací súkromný kľúč podľa časti "Vygenerovanie súkromných kľúčov (certifikátov)"
6. Režim prevádzky nastavte do stavu "testovací".
7. Vykonajte otestovanie funkčnosti modulu a overenie jeho správnej činnosti vytvorením testovacej objednávky a platby (GP WebPay Vám poskytne číslo testovacej karty a heslo).
8. Po úspešnom otestovaní funkčnosti Vám GP WebPay zašle údaje pre vygenerovanie produkčného súkromného kľúča.
9. Implementujte produkčný súkromný kľúč podľa časti "Vygenerovanie súkromných kľúčov (certifikátov)".
10. Nastavte Režim prevádzky modulu do stavu "produkčný". Týmto krokom je platobná brána GP WebPay pripravená pre prácu v ostrej prevádzke.
11. Pri inštalácii modulu došlo k automatickému umiestneniu ikony platobného systému a platobných kariet v detaile produktu vo verejnej časti e-shopu.
12. V súvislosti s ochranou osobných údajov podľa smernice GDPR doplňte do prehlásenia o GDPR vo Vašom e-shope informácie o platobnej bráne GP WebPay so zoznamom nižšie uvedených údajov zákazníka, ktoré do platobnej brány odosielate.:
    • Meno a priezvisko (Name)
    • E-mailová adresa (Email address)
    • Domáce telefónne číslo (Home phone number)
    • Číslo mobilného telefónu (Mobile phone number)
    • Fakturačná adresa (Billing address)
    • Dodacia adresa (Shipping address)
13. Pokiaľ by sa vyskytol problém, skontrolujte najskôr správnosť údajov vložených do nastavení modulu. Ak problém naďalej pretrváva, 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