CardPay for PrestaShop (payment gateway)

CardPay service allows customers to place payment using VISA, VISA Electron, MasterCard, Maestro alebo Diners Club debit/credit cards for your purchases in your store for the benefit of your Tatra banka account. This module provides an encrypted communication between your PrestaShop store and the Tatra banka website - tatrabanka.sk.

Module features

• compatibility: PrestaShop 1.4.x - 1.7.x
• Multistore (Multiple shops) feature supported
• AES256 or DES (deprecated) data encryption
• data encryption algorithms available:
  • HMAC SHA256 (used since 05/2015)
  • AES256 (used since 02/2014)
  • DES (deprecated)
• fulfills the requirements of SEPA since 02/01/2014
• available payment currencies: Euro, US Dollar, Czech Koruna, British Pound, Hungarian Forint, Polish Zloty, Swiss Franc, Danish krone
• available payment interface languages: English, German, Spanish, French, Italian, Slovak, Czech, Polish and Hungarian
• Apple Pay supported
• Google Pay supported
• quick module installation
• easy module setup
• automatic payment icon implementation into Front Office
• payment icon position control via module administration (left / right column, product detail page)
• module languages available: English, Slovak and Czech

CardPay service implementation steps

1. Sign contract with Tatra banka, a.s. and get Merchant ID and Encryption Key for your e-commerce.
2. Install, setup and test the CardPay module in your PrestaShop (see "Module installation and testing").
3. After this action is module ready to work in live environment.
4. If any problem occurred, please contact module author.

CardPay service information

All current terms and conditions for CardPay service will give you Tatra banka.
Please, go to Tatra banka website tatrabanka.sk

Module installation and testing

1. Upload folder "cardpay" into /modules/ folder via FTP or use module upload tool in Back Office » Modules to upload module package.
2. Install module in: Back Office » Modules
3. Go into settings: Back Office » Payment » Payment modules list, and chceck the option "Shop default currency".
4. Go into module settings and fill data following way:
   1. open Tatra bank testing tool in first browser window: moja.tatrabanka.sk
   2. copy values fo Merchant ID (MID) and Key (KEY). Fill and save these values in module settings in the second browser window.
   3. set "Allow Testing mode" option to "yes"
   4. go into Front Office in the third browser window and put any product in the cart (like customer)
   5. chose "CardPay" payment method in the shopping cart
   6. in the next step you will see red colored data
   7. open first browser window again and setup Tatra bank Testing tool with data displayes in previous step
   8. click on "Verify signature" button
   9. all data in your eshop must match with data on testing tool, including signature
   10. if signatures not match, check all input data. Contact module author, when problem still persist.
   11. if signatures match, make the screenshot both browser windows together (you can send screenshot to bank employye as module testing result)
   12. go into module settings and:
       1. switch "Allow Testing mode" option to "no"
       2. fill "Merchan ID" and "Encryption Key" with data you received from Tatra banka
       3. setup rest of module options as you wish
5. Contact the bank employee and specify the date from which you want start using CardPay payments on your eshop. Send him screenshot with module testing result.
6. After this action will be module ready to work in live environment.
7. While module installation the payment icon has been placed into product detail page of your eshop Front Office.
8. If any problem occurred, check your settings data filled into module first. If problem still persist, contact module author.

Frequently asked questions (FAQ)

In the payment process I see blank page. Why and how to fix it?
Answer: Module using a function available in PHP 5.4+ in order to generate payment security sign. Your store running on PHP server 5.3 or less. Please update your PHP server on 5.4+ or ask your webhosting provider with this request.

Why after module testing on Tatra banka website still "Timeout" message appear?

Answer: After successful module testing, the bank house must allow the payments (on their side) for your eshop. Please wait awhile (hours or days). If "Timeout" message still appear, please contact bank employee again and urgent to allow payments for your eshop.

I'd like to hide left / right column in CardPay module pages for Front office. Where and how can I adjust it?
Answer: Go into Back Office > Preferences > Themes, and click "Edit" button for current theme. Now you allowed to change displaying the columns for various store pages. Find "module-cardpay-payment" and "module-cardpay-validation" records for CardPay module and adjust displaying columns for your wish.

TATRA BANKA CARDPAY MODULE - CHANGELOG

version 1.7.11 (05/25/2022)
    x added BO module tabs for better UX usability and experience

version 1.7.10 (05/09/2022)
    + added feature in order to add custom & multi-language name of the payment method in the checkout
    + added an option to choose value of the E2E parameter
    + added SQL table PREFIX_cardpay_log installation (for future features only)
    x extended payment private message for "place an order after the payment" order method
    x fixed bug when payment response not accepted VS = order reference
    x do not display module alerts when the module is no active
    x fixed missing nbProducts variable into notification page
    x normalized Hook names

version 1.7.9 (01/24/2022)
    + added an option to choose payment variable symbol type (Order ID or Order reference)
    + 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
    x fixed input variables (customer's shipping address) for signature
    x fixed missing SK & CZ translations

version 1.7.8 (10/19/2021)
    x added multi-currency support
    + 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
    + 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

    x fixed parameters in {guest_tracking_url} template email URL
    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 updated VISA and VISA Electron logo, 2021 version
    x improved module code
    x updated module documentation

version 1.7.7 (05/17/2021)
    + added an option to redirect customer back into checkout when the payment was not successful (for "place an order after the payment" order method)
    x fixed a special characters in the customer address

version 1.7.6 (03/09/2021)
    IMPORTANT UPDATE: 
    x updated release - Merchant Integration Manual; version: 2.0 used
    x fixed little typo in the function converting name of the customer
    x fixed calculating SIGN for testing environment
    + added an warning alert when friendly URLs are disabled
    + added a custom hook {hook h='displaycardpayicons'} in order to display module payment icons everywhere you want
    - removed module JS file that affected PrestaShop BO

version 1.7.5 (09/04/2020)
    - removed useless payment step for both types of payment methods
    + added Google Pay logo
    x updated module documentation

version 1.7.4 (01/03/2020)
    + added Back Office CSS and JavaScript file (displayBackOfficeHeader hook)
    + added Type goods selector
    - removed useless payment step - the customer is redirected on the payment gateway directly from the checkout page
    x payment icons redesign
    x added Apple Pay logo
    x fixed displaying "tax included" suffix (and his translation) for the price based on PrestaShop tax settings
    x updated module documentation

version 1.7.3 (11/12/2019)
    x updated release - Merchant Integration Manual; version: 1.8 used
    x fixed signature comparison in validation process by adding a new RC variable
    x fixed "tax incl." string translation
    + added selector for PrestaShop theme (on/off Material Design Icons)
    + added ECDSA verification
    + added private notes field

version 1.7.2 (11/21/2018)
    x added a price comparison on order to prevent change the order by customer while is payment processed

version 1.7.1 (12/03/2017)
    x fixed payment validation process for PrestaShop 1.7.2.x
    x fixed translation of the order private message created by the module

version 1.7.0 (13/02/2017)
    + initial release for PrestaShop 1.7.x (testing environment: PrestaShop 1.7.0.4)
    + front office redesign for PrestaShop 1.7 Classic theme
    + added Order payment status selectors
    + added editable source file for card payment logos
    x moved validation script into "response" folder
    x fixed TPAY parameter
    x improved testing mode
    x fixed currency check function
    x updated card payment logos
    x updated module documentation
    x updated "Terms and conditions of use" document

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

version 1.6.18 (05/09/2022)
    + added feature in order to add custom & multi-language name of the payment method in the checkout
    + added an option to choose value of the E2E parameter
    + added SQL table PREFIX_cardpay_log installation (for future features only)
    x extended payment private message for "place an order after the payment" order method
    x fixed bug when payment response not accepted VS = order reference
    x do not display module alerts when the module is no active
    x fixed missing nbProducts variable into notification page
    x normalized Hook names

version 1.6.17 (12/25/2021)
    + added an option to choose payment variable symbol type (Order ID or Order reference)
    + added multi-currency support
    + added displayAdminOrder hook
    + added displayOrderDetail hook
    + added order payment record if payment state has logable option allowed
    + 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 log file to recording payment transactions for debugging purposes
    + 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

    x fixed input variables (customer's shipping address) for signature
    x fixed parameters in {guest_tracking_url} template email URL
    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 updated VISA and VISA Electron logo, 2021 version
    x improved module code
    x updated module documentation

version 1.6.16 (04/26/2021)
    + 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.6.15 (03/09/2021)
    IMPORTANT UPDATE: 
    x fixed little typo in the function converting name of the customer
    x fixed calculating SIGN for testing environment
    + added a custom hook {hook h='displaycardpayicons'} in order to display module payment icons everywhere you want
    - removed module JS file that affected PrestaShop BO

version 1.6.14 (01/23/2021)
    x fixed card logo link in the cart
    - removed useless code

version 1.6.14 (12/27/2020)
    x IMPORTANT UPDATE: 
    x updated release - Merchant Integration Manual; version: 2.0 used
    + added Back Office CSS and JavaScript file (displayBackOfficeHeader hook)
    + added Type goods selector
    + added selector for PrestaShop theme (on/off Material Design Icons)
    + added an warning alert when friendly URLs are disabled
    x payment icons redesign
    x added Apple Pay and Google Pay logo
    x fixed displaying "tax included" suffix (and his translation) for the price based on PrestaShop tax settings
    x updated module documentation
    x fixed little typo in the function converting name of the customer

version 1.6.13 (11/12/2019)
    x updated release - Merchant Integration Manual; version: 1.8 used
    x fixed signature comparison in validation process by adding a new RC variable
    + added ECDSA verification
    + added private notes field

version 1.6.12 (11/21/2018)
    x added a price comparison on order to prevent change the order by customer while is payment processed

version 1.6.11 (12/05/2017)
    x revert Name clean function
    x updated module documentation
    x fixed translation of the order private message created by the module

version 1.6.10 (05/29/2017)
    x improved Name clean function

version 1.6.9 (03/16/2017)
    - removed CID parameter

version 1.6.8 (01/28/2017)
    + added dual payment method: Order method selector (creating an order before or after the payment)
    + added new payment statuses "Awaiting CardPay payment"
    + added Order payment status selectors to freedom in pairing module statuses with PrestaShop built-in order statuses
    x moved validation script into "response" folder
    x moved "img" and "css" folder into "views" folder
    x fixed currency check function
    x updated module documentation
    x updated "Terms and conditions of use" document
    x improved the module code

version 1.6.7 (12/30/2016)
    + added compatibility with "Advanced EU Compliance" module
    x changed CardPay logotype (requested by Tatra banka)
    x minor code changes

version 1.6.6 (11/02/2016)
    x fixed TPAY parameter
    + added responsive feature for image icons

version 1.6.5 (01/19/2016)
    x minor changes

version 1.6.4 (09/01/2015)
    x updated release - Merchant Integration Manual; version: 4.0 used
    x changed payment URL
    x fixed bug with processing of variables in validation process
    x fixed UTC timestamp
    x updated documentation
    + module now using HMAC SHA256 encoding type only
    + add TPAY, TIMESTAMP and CID parameter
    + added CMS page selector for icon destination link
    - removed fields: Mobile phone; Payment description

version 1.6.3 (05/25/2015)
    + added product detail icon position and set as default
    + added PHP version warning alert
    + added PHP comparator for different sign generator process
    x improved & unificated CSS to better working with 1.6.x themes
    x improved & fixed notification system
    x updated & unificated documentation

version 1.6.2 (09/14/2014)
    + added encoding type selector (AES256 and DES)
    + added module version info into module setting page
    + added automatic customer language detection
    + added more available interface languages: English, German, Spanish, French, Italian, Slovak, Czech, Polish and Hungarian
    + added more available payment currencies: US Dollar, Czech Koruna, British Pound, Hungarian Forint, Polish Zloty, Swiss Franc, Danish krone
    + added MOBILE_DEVICE variable
    x updated module Documentation
    - removed CS parameter
    
version 1.6.1 (04/19/2014)
    + module compatibility for PrestaShop 1.6.x
    + new module versioning containing a PrestaShop version
    x redesign module Back office for PrestaShop 1.6.x
    x updated and improved module Documentation
    - removed useless Working mode selector

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

version 1.5.4 (01/28/2017)
    + module now using HMAC SHA256 encoding type only
    + added dual payment method: Order method selector (creating an order before or after the payment)
    + added new payment statuses "Awaiting CardPay payment"
    + added Order payment status selectors to freedom in pairing module statuses with PrestaShop built-in order statuses
    + add TPAY, TIMESTAMP and CID parameter
    + added CMS page selector for icon destination link
    + added compatibility with "Advanced EU Compliance" module
    + added product detail icon position and set as default
    + added PHP version warning alert
    + added PHP comparator for different sign generator process
    + added responsive feature for image icons
    + added module version info into module setting page
    + added automatic customer language detection
    + added more available interface languages: English, German, Spanish, French, Italian, Slovak, Czech, Polish and Hungarian
    + added more available payment currencies: US Dollar, Czech Koruna, British Pound, Hungarian Forint, Polish Zloty, Swiss Franc, Danish krone
    + added MOBILE_DEVICE variable
    - removed fields: Mobile phone; Payment description
    - removed CS parameter
    - removed useless Working mode selector
    x moved validation script into "response" folder
    x moved "img" and "css" folder into "views" folder
    x fixed currency check function
    x updated "Terms and conditions of use" document
    x improved the module code
    x changed CardPay logotype (requested by Tatra banka)
    x minor code changes
    x fixed TPAY parameter
    x minor changes
    x updated release - Merchant Integration Manual; version: 4.0 used
    x changed payment URL
    x fixed bug with processing of variables in validation process
    x fixed UTC timestamp
    x improved & unificated CSS to better working with 1.6.x themes
    x improved & fixed notification system
    x updated and improved module Documentation

version 1.5.3 (18/01/2016)
    x fixed UTC timestamp
    x fixed bug with processing of variables in validation process

version 1.5.2 (08/22/2015)
    x fixed UTC timestamp

version 1.5.2 (08/13/2015)
    x updated release - Merchant Integration Manual; version: 4.0 used
    x changed payment URL
    + add TPAY, TIMESTAMP and CID parameter
    + added HMAC encoding type
    - removed fields: Mobile phone; Payment description

version 1.5.1 (09/14/2014)
    + new module versioning containing a PrestaShop version
    + added encoding type selector (AES256 and DES)
    + added module version info into module setting page
    + added automatic customer language detection
    + added more available interface languages: English, German, Spanish, French, Italian, Slovak, Czech, Polish and Hungarian
    + added more available payment currencies: US Dollar, Czech Koruna, British Pound, Hungarian Forint, Polish Zloty, Swiss Franc, Danish krone
    + added MOBILE_DEVICE variable
    x added SS parameter into return process
    x changed payment return process
    x updated module Documentation
    - removed CS parameter

version 1.3.0 (02/12/2014)
    x updated MID parameter from 8 bit to 32 bit due SEPA instructions
    x replaced DES signature encoding to AES256 encoding

version 1.2.0 (07/26/2013)
    + added full English and Slovak documentation

version 1.1.0 (06/17/2013)
    + added cardpay.css to design front-end pages
    x payment icon fix
    x small design improvements

version 1.0.0 (09/23/2012)
    + initial release for PrestaShop 1.5.x

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

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