realex payments · admin panel. we are releasing new features and improvements regularly to ensure...
TRANSCRIPT
www.pronkoconsulting.com
Realex Payments for Magento® 2
User Guide Version 1.2.0
Support: [email protected]
Table of Contents Introduction
About Realex Payments Realex Payments Functionality
1. Installing Realex Payments Module 1.1. Install via Component Manager
2. How to Use 2.1. Configuration
General Configuration Realex Credentials Advanced Settings
2.2 Reports Settlement Report Support Report
3. Support
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 1
Introduction
Congratulations on your purchase of Realex Payments, this User Guide helps you to
set up the new extension for Magento® 2. If you need support, let us take care of
installing Realex Payments.
About Realex Payments
Accept payments online via Realex Payments for Magento 2 web store. This is one
of the best in its class payment integration carefully implemented and tested by
Developers specializing in Magento 2 (experts in payment integrations). The Realex
Payments extension allows your customers to pay without leaving checkout user
journey of a website. It also supports MOTO orders placed directly from Magento
Admin panel. We are releasing new features and improvements regularly to ensure
the best possible set of payment functionality.
The Realex Payments module connects your eCommerce website with the Realex
Payment gateway - a leading provider of eCommerce payment solutions in Europe.
This integration uses the Realex gateway API (PCI SAQ A-EP) which gives you, the
merchant, full control of customer's payment experience.
Realex Payments Functionality
1. Supports the following credit and debit cards: Visa, Visa Debit, American
Express, MasterCard, Discover, 3V Visa, Dinners, Maestro International,
Switch/Solo Multi-store,
2. multi-currency and multi-accounts support
3. Provides 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)
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 2
4. Supports partial Invoices (also known as Multi Settlement) and partial Credit
Memos (Refunds)
5. Supports creation of orders and capturing payments from Magento Admin
using Realex Payments, also known as Mail Orders/Telephone Orders
(MOTO)
6. Provides Authorization Transaction information at Order View Page.
Additional validation allows store owner quickly see result of Address, CVN
and Postcode data entered by a customer
7. Manage and report all transactions in a single page, export reports into CSV
and Excel with just few clicks.
8. Comprehensive error validation allows system to notify merchant of any data
errors or payment amount issues while sending payment transaction.
1. Installing Realex Payments Module
It is recommended you first 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 in your live website.
1.1. Install via Component Manager
Here are steps required to install Realex Payments 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
http://devdocs.magento.com/guides/v2.0/install-gde/prereq/connect-auth.html.
3. Navigate to Component Manager page.
4. On the Component Manager page click “Sync” button to update your new
purchased extensions.
5. Click Install in the Action column for Realex Payments component.
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 3
6. Follow Web Setup Wizard instructions.
2. How to Use
This section will show how to setup and use Realex Payments extension. Before
reading this section the extension should already be installed. Read Installing Realex
Payment section of the original document for instructions.
2.1. Configuration
The Realex Payment extension can be easily configured to meet business expectations of
your web store. This section will show you how to configure the extension via Magento®
Admin.
Navigate to Store -> Configuration -> Sales -> Payment Methods section. On the
Payments Methods page the Realex Payments method should be listed together with other
installed payment methods in a system.
The “Configure” button allows to easily show all configuration settings for Realex Payments.
Once you have finished with the configuration simply click “Close” button for your
convenience.
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 4
Realex Payments configuration is divided by 3 sections. It help to quickly find required
setting.
These 3 sections are:
● General Configuration
● Realex Credentials
● Advanced Settings
Please ensure you check all configuration settings prior to using Realex Payment. Pay
attention to the Realex Credentials section, namely Merchant ID , Account , Secret , Refund
Password fields.
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 5
General Configuration
The General Configuration section holds primary settings for the integration.
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 changelog of all versions.
Enable this solution Yes Realex Payments method becomes available for use as a payment method during Checkout.
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 6
Environment Production / Sandbox Changes state of the extension from staging to production. It is recommended to use Production setting once website is live.
Debug Yes All communication queries are stored in the debug_realex.log file.
Title Credit or Debit Card (Realex)
Defines payment method title for Realex Payments option at Checkout.
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.
Credit Card Types American Express Visa MasterCard Diners Switch/Solo Maestro International
Enables available credit cards.
Minimum Order Total Example: 500 Shows payment method only if minimum order total reaches amount set.
Maximum Order Total Example: 1000 Shows payment method only if maximum order total less than amount set.
Sort Order Example: 1 Shows Realex Payment method according to sort order set.
The “Release Notes” link next to Module Version number opens “Realex Payments 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.
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 7
Realex Credentials
The Realex Credentials section stores all Realex-related settings provided by the Realex
Payments provider. Please contact https://www.realexpayments.ie for further assistance in
creating your web store Realex Account.
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 8
The following table highlights Realex Credentials section settings.
Field The result will be ...
Merchant ID Merchant ID provided by the Realex Payments.
Account Account provided by the Realex Payments.
Default Sub Account Sub Account provided by the Realex Payments.
Sub Accounts List of additional sub-accounts configured by the Realex Payments. It allows to assign an alternative sub-account to a card type e.g. American Express and send all sales transactions using American Express credit card to this sub-account.
Secret Secret provided by the Realex Payments.
Refund Password Refund Password provided by the Realex Payments.
Sub Accounts
Realex Payments module allows to create unlimited number of additional sub-accounts
under main Account. In order to add new Sub Account simply click “Add” button and fill
Name of a sub-account and select Card Type you want to map with.
If you wish to remove a Sub Account the “Delete” icon right to a Sub Account will remove it.
Make sure to click “Save Config” to save any changes made.
Advanced Settings
The Advanced Settings section holds additional settings for Realex Payment extension.
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 9
The following table highlights Advanced Settings section settings.
Field If you select ... The result will be ...
Multiple Settle/Refund Enabled
Yes Enables multiple Invoices and multiple Credit Memos creation per order.
Payment from Applicable Countries
All Allowed Countries Verifies whether payment method should be shown if shipping/billing country is selected.
CVV Verification Yes Enables additional CVV field during checkout.
Switch/Solo Issue Number Enabled
Yes Enables Switch/Solo additional fields during checkout. Make sure to also select Maestro International
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 10
Credit Type to enable full Switch/Solo support.
New Order Status Processing Changes order status in case of existing order status assigned to an order was removed/unassigned as part of Stores -> Order Statuses configuration.
Accepted Currency Verifies whether payment method should be shown if currency is used for given a store.
Gateway URL https://epage.payandshop.com/epage-remote.cgi
Gateway URL for communication with Realex Payments.
Note: Realex Payment module sends Base Store Currency during communications with
Realex Payments provider. If you wish to have Dynamic Currency Conversion support
enabled for your website please contact support [email protected].
2.2 Reports
Realex Payments module comes different types of reports which allows to control sales transactions.
Settlement Report Transaction Management gives full control to a merchant over the status of payment
transactions allowing them to send for settle, refund and void quickly and easily from
Magento Admin.
The Realex Settlement Report is located under Reports -> Realex Settlement menu.
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 11
The Realex Settlement Report page provides all necessary functionality to analyze
and make important actions around Settlement transactions. It allows to to verify
status and view important information for every transaction.
Realex Settlement Report has been built using latest Magento 2 UI component
which allows to have all features available e.g. Search, Filter, Grid Views, Custom
columns, Export, Paging etc.
Support Report The support report is generated during Realex Payments lifecycle. All
communications with Realex Payments provider are stored in a debug_realex.log
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 12
file. The file is used for validation, testing of a module installed. The
debug_realex.log file usually located under var/log/ directory inside magento
application.
3. Support Realex Payments 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.
Please send all support requests to [email protected].
Realex Payments v1.1 User Guide © www.pronkoconsulting.com 13