Converge Elavon. User and Installation Guide

Transcription

1 Converge Elavon for Magento 2 User and Installation Guide Version 1.0 Support: support@pronkoconsulting.com

2 1 Table of Contents Introduction About Converge Elavon For Merchants For Customers Converge Elavon Functionality 1. Installation of Converge Elavon Module System Requirements 1.1. Installation via Component Manager 1.2. Installation via Composer 2. Uninstalling of Converge Elavon Module 3. How to Use 3.1. Configuration General Configuration System Settings Payment Account Developer Settings 4. Support Support Report

3 2 Introduction Congratulations on your purchase of Converge Elavon, this User Guide helps you to set up the new extension for Magento 2. If you need a support, let us take care of Converge Elavon installation by contacting us via support@pronkoconsulting.com About Converge Elavon Accept payments online via Converge Elavon for Magento 2 website. This is one of the best in its class payment integration that is carefully implemented and tested by Developers specializing in Magento 2 and experts in building online payment solutions. Converge Elavon module allows your customers to pay without leaving a checkout user journey of a website. We are releasing new features and improvements regularly to ensure the best possible set of payment functionality. For Merchants Converge Elavon module allows Merchants to fully manage the order life-cycle from the Magento Admin. Module enables a mobile checkout payment experience with Merchant Form and PCI Compliant (PCI SAQ A-EP) website. Sensitive customer data is never stored and passed to Magento Application. All successful payments transactions are available from Magento Admin. For Customers Converge Elavon module provides a seamless shopping experience. It allows a customer to pay using his/her favorite credit card securely once he/she decided to purchase a product on a website. Converge Elavon Functionality 1. Supports the following Credit Cards: Visa, Visa Debit, American Express, MasterCard, Discover, Dinners, Maestro International and JCB. 2. Supports multi-currency and multi-accounts.

4 3 3. Provides a transaction management from Magento Admin Choose between Authorize and Capture payments (customer's payment will be immediately captured) or Authorize Only online payments (in case additional stock or payment verifications should be performed.) 4. Provides Authorization Transaction information at Order View Page. Additional validation allows store owner to see quickly the result of Address, CVN and Postcode data entered by a customer. 5. Allows to manage and report all transactions in a single page, and to export the reports into a CSV or an Excel file with just a few clicks. 6. Provides a comprehensive error validation which allows the system to notify a Merchant of any data errors or payment amount issues while sending a payment transaction. 1. Installation of Converge Elavon Module It is recommended to install the module in a test Magento environment that is a copy of your live store. After you have verified the module works correctly in your test store, you can safely install the module on your live website. System Requirements PHP 5.6+, PHP 7.0.2, PHP 7.0.4, PHP , PHP 7.1.x Magento Community Edition x Magento Enterprise Edition x 1.1. Installation via Component Manager Here are steps required in order to install Converge Elavon extension via Component Manager. 1. From your Magento Admin access System -> Web Setup Wizard page. 2. Enter Marketplace authentication keys. For more information about authentication keys generation please visit Magento DevDocs Get your authentication keys page. 3. Navigate to Component Manager page.

5 4 4. On the Component Manager page click a Sync button to update your new purchased extensions. 5. Click Install in the Action column for Converge Elavon component. 6. Follow the Web Setup Wizard instructions Installation via Composer In case you received a ZIP archive with Converge Elavon module for Magento 2, this section will show you how to install the module via Composer package manager. Make sure you use right package with a name which usually looks like pronko_magento-2-converge zip, where is a module version. Please note that the module version will be changed with future releases. Place the pronko_magento-2-converge zip package into the Magento 2 root directory. Usually Magento 2 Application absolute path is /var/www/magento/. Please consult with a system administrator of the hosting provider that you use for guidance. Open the composer.json file located in the Magento 2 root directory and add a new repository and require directives as follow: repositories : [ { type : artifact, url :./ } ] require : [ pronko/magento-2-converge : ] From the command line execute the following command:

6 5 $ composer update As a result of an execution the pronko/magento-2-converge package will appear in vendor directory. Verify that the new Pronko_ConvergeMagento module has been appeared in the list of disabled modules: $ bin/magento module:status Enable and install the module by running the following commands: $ bin/magento module:enable Pronko_ConvergeMagento $ bin/magento setup:upgrade Please also recompile code and static files: $ bin/magento setup:static-content:deploy $ bin/magento setup:di:compile Congratulations, you have successfully installed Converge Elavon module. Now it is time to proceed to configuration section of the documentation. 2. Uninstalling of Converge Elavon Module In order to uninstall Converge Elavon module the following command should be executed: $ bin/magento uninstall:module Pronko_ConvergeMagento The uninstall:module command removes previously installed pronko/magento-2-converge package from your Magento 2 Application.

7 6 3. How to Use This section explains how to setup and use Converge Elavon extension. Before reading this section the extension should already be installed. Read Installing of Converge Elavon Module section of the original document for the instructions Configuration Converge Elavon module can be easily configured to meet business expectations of your web store. This section will show you how to configure the extension via Magento 2 Admin. Navigate to Store -> Configuration -> Sales -> Payment Methods section. On the Payments Methods page the Converge Elavon payment method should be listed together with other installed payment methods in the system. The Configure button allows to easily show all configuration settings for Converge Elavon. Once you have finished with the configuration simply click Close button for your convenience. Click Save Config button to store all changes.

8 7 The Converge Elavon configuration is divided by 4 sections. These 4 sections are: General Configuration System Settings Payment Account Developer Settings Please ensure to check all configuration settings prior to using Converge Elavon payment method. Pay attention to the Payment Account section, namely Merchant ID, User ID and PIN fields. General Configuration The General Configuration section holds primary settings for the integration.

9 8 The following table highlights General Configuration settings. Field If you select... The result will be... Module Version - Shows currently installed version of the extension. The Release Notes link will open popup window with all changes for current and previous versions Enable this solution Yes Converge Elavon method becomes available for use as a payment method during Checkout. Operating Mode Production Allows to accept payment LIVE transactions. Please pay attention to Payment Account Production Settings. Demo Allows to accept payment DEMO transactions and test integration. Please pay attention to Payment Account Demo Settings. Title Converge Elavon Payment method title for Converge Elavon integration. Form Type Merchant Form Allows to select type of integration. Available modes:

10 9 Merchant Form. Payment Action Authorize Only Initial order payment transaction authorizes payment amount. Authorize and Capture Initial order payment transaction transfers payment amount to a Merchant bank account. Receipt Link Text Continue Button label on the Receipt Converge Page. The Release Notes link next to Module Version number opens Converge Elavon Release Notes popup with all release versions and changes included. You may always come back to this screen to verify changes and new versions installed in your Magento 2 web store. System Settings The System Settings section allows to configure additional validation rules for Converge Elavon payment method such as payment from applicable countries and accepted currency.

11 10 The following table highlights General Configuration settings. Field If you select... The result will be... Payment from Applicable Country Canada Allows to filter Converge Elavon payment method based on shipping and billing country selected during checkout. E.g. Converge Elavon will be available for Canada in case only Canada country is selected. Accepted Currency USD Allows to select list of accepted currencies for Converge Elavon integration. Default: USD. Payment Account The Payment Account section stores all Converge Elavon related settings provided by the Converge Elavon payment provider. Please contact for further assistance in creating your web store Converge Elavon Account.

12 11 The following table highlights Elavon Credentials section settings. Field Merchant ID User ID PIN Gateway URL Description Merchant ID provided by the Converge Elavon support. User ID provided by the Converge Elavon support. PIN by the Converge Elavon support. API URL used for communications between Converge production server and Converge Elavon payment module. Developer Settings The Developer Settings section holds additional settings for Converge Elavon extension. The following table highlights Developer Settings section settings. Field If you select... The result will be... Debug Yes Enables storing request and

13 12 response information between Converge Elavon server and Magento 2. Note: Converge Elavon module sends Amount without using Base Store Currency during communications with Converge Elavon provider. This assumes Converge Merchant account has same currency as Magento 2 website. If you wish to have Dynamic Currency Conversion support enabled for your website please contact support support@pronkoconsulting.com. 4. Support The Converge Elavon module for Magento 2 comes with support period. All support requests are going to be reviewed within 24 hours period. All future module updates and bug fixes are included. Additional features requests are reviewed and discussed. Support Report The support report is generated during Converge Elavon lifecycle. All communications with Converge Elavon provider are stored in a converge_debug.log file. The file is used for validation, testing of a module installed. The converge_debug.log file usually located under var/log/ directory in the Magento application. Please send all support or customization requests to the support@pronkoconsulting.com.