PX Shopping Cart Plugin Magento · gateway. This plugin has been tested with both Community &...
16
PX Shopping Cart Plugin Magento Version 1.3
Transcript of PX Shopping Cart Plugin Magento · gateway. This plugin has been tested with both Community &...
PX Shopping Cart Plugin
Magento
Version 1.3
Document Revision Information
Version Comments
0.1 Initial version.
0.2 Add user flow screenshots.
0.3 Document format update.
1.0 Release version.
1.1 Update to user flow screenshots.
1.2 Update to Refund description.
1.3 Complete (Capture) updated.
Copyright
© Copyright 2017, Payment Express Limited 33 Wilkinson Road, Ellerslie PO Box 8400 Auckland, 1150 New Zealand www.paymentexpress.com
All rights are reserved. No part of this work may be reproduced or copied in any form or by any means, electronic or mechanical, including photocopying, without the express written permission of Payment Express Limited.
Proprietary Notice
The information described in this document is proprietary and confidential to Payment Express Limited. Any unauthorised use of this material is expressly prohibited except as authorised by Payment Express Limited in writing.
Contents
1 Overview .............................................................................................................................................................. Page 1
1.1 Introduction ...................................................................................................................................................................... 1
1.2 Features Supported ........................................................................................................................................................ 1
1.3 PX Pay 2.0 vs PX Fusion ................................................................................................................................................ 1
2 Installation ........................................................................................................................................................... Page 2
2.1 Magento 1 Installation ................................................................................................................................................... 2
2.2 Magento 2 Installation ................................................................................................................................................... 3
3 Configuration ....................................................................................................................................................... Page 4
3.1 Magento 1 Configuration ............................................................................................................................................... 4
3.2 Magento 2 Configuration for PX Pay 2.0 .................................................................................................................... 5
3.3 Magento 2 Configuration for PX Fusion ..................................................................................................................... 6
4 User Experience ................................................................................................................................................... Page 7
5 Admin Functions ................................................................................................................................................. Page 8
5.1 Complete (Capture) Function ....................................................................................................................................... 8
5.1.1 Magento 1 Complete ............................................................................................................................................. 8
5.1.2 Magento 2 Complete ............................................................................................................................................. 9
5.2 Refund (Credit Memo) Function ................................................................................................................................ 10
5.2.1 Magento 1 Refund ............................................................................................................................................... 10
5.2.2 Magento 2 Refund ............................................................................................................................................... 11
6 Contact Us ......................................................................................................................................................... Page 12
1 of 12
1 Overview
1.1 Introduction
The Payment Express Magento Shopping Cart Plugin supports both Magento versions 1 & 2. The plugin package is
designed to get your Magento website setup to accept online payments securely via the Payment Express payment
gateway. This plugin has been tested with both Community & Enterprise Editions.
1.2 Key Features Supported
1.3 PX Pay 2.0 vs PX Fusion
The Magento plugin supports both PX Pay 2.0 and PX Fusion APIs. Please note that PX Fusion is only available for
Magento 2. Below are some key points for selecting one API over the other.
Please note: PX Pay 2.0 is widely accepted and recommended by banks however if you wish to deploy PX Fusion then
please ensure you check with your acquiring bank before proceeding.
Important: Moving forward Magento 1 will receive maintenance support only. Any new features will be added to
Magento 2. We would recommend using Magento 2 for any new deployments.
PX Pay 2.0 Key Advantages
Secure Hosted Payments Page hosted at Payment
Express. Reduced PCI Scope for merchant.
Enable alternative Payment Methods (e.g. A2A,
China Union Pay Online Payment).
Standard PX Pay 2.0 features (3D Secure, CVC,
Google reCAPTCHA etc) are supported.
PX Fusion Key Advantages
There is no re-direction visible to the card holder.
Payment process appears more seamless with
merchant website.
Complete Transactions(known as Capture in
Magento)
Refund Transactions(known as Credit Memo,
Refund on Order Invoice in Magento)
RequiresPX Post
Requires PX Pay 2.0 or PX Fusion
Purchase Transactions
Auth Transactions
Account2Account (A2A)
Token Creation & Token Storage
Token Rebilling
Requires PX Pay 2.0
2 of 12
2 Installation
2.1 Magento 1 Installation
If installing via Magento Marketplace, please follow standard Magento Marketplace plugin install procedure. The
following sections detail how to install manually via file provided by Payment Express.
1. Login to Magento Admin Panel.
2. Open Magento Connect Manager (System > Magento Connect > Magento Connect Manager).
3. Under Direct Package File Upload (Extension tab), select choose file.
4. Select the Payment Express Magento 1 tgz file from your computer.
5. Select Upload and then select Install.
3 of 12
2.2 Magento 2 Installation If installing via Magento Marketplace, please follow standard Magento Marketplace plugin install procedure. The
following sections detail how to install manually via file provided by Payment Express.
1. Copy the Magento 2 plugin folder
“PaymentExpress” to %magento2%/app/code. The
folder structure is shown on the right.
2. Enable the Payment Express Magento 2 plugin by
adding “‘PaymentExpress_PxPay2' => 1“ to "%
magento2%\app\etc\config.php".
3. Run following commands via command prompt.
cd %magento2%
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
4 of 12
3 Configuration
3.1 Magento 1 Configuration
1. Navigate to the Magento 1 Payment Methods page (System > Configuration > Payment Methods).
2. Find Payment Express PxPay2 payment method.
3. Fill in and complete all fields.
Set Enabled to Yes to enable the plugin.
Set Payment Type to desired Payment Type (e.g. Purchase).
Set Account2Account Only. This should be set to Yes only if your Payment Express account is setup for
A2A only and no credit card.
Enter your PX Pay User ID provided by Payment Express into the PxPay UserId field.
Enter your PX Pay Key provided by Payment Express into the PxPay Key field.
Enter the PX Pay URL into the PxPay Url field.
https://sec.paymentexpress.com/pxaccess/pxpay.aspx
https://uat.paymentexpress.com/pxaccess/pxpay.aspx (only use this if your test account is setup on UAT host).
If Token Billing is required, set Enable Rebill to Yes or No.
If Complete (Capture) & Refund (Credit Memo) transactions are required, the PX Post details must be filled
in.
Enter your PX Post User ID provided by Payment Express into the PxPost UserId field.
Enter your PX Post Password provided by Payment Express into the PxPost Password field.
Enter the PX Post URL into the PxPost Url field.
https://sec.paymentexpress.com/pxpost.aspx
https://uat.paymentexpress.com/pxpost.aspx (only use this if your test account is setup on UAT host).
5 of 12
3.2 Magento 2 Configuration for PX Pay 2.0
1. Navigate to the Magento 2 Payment Methods page (Stores > Configuration > Sales > Payment Methods).
2. Find Payment Express Checkout payment method.
3. Fill in and complete all fields.
Set Enabled to Yes to enable the plugin.
Set Payment Type to desired Payment Type (e.g. Purchase).
Set Account2Account Only. This should be set to Yes only if your Payment Express account is setup for
A2A only and no credit card.
Enter your PX Pay User ID provided by Payment Express into the PxPay UserId field.
Enter your PX Pay Key provided by Payment Express into the PxPay Key field.
Enter the PX Pay URL into the PxPay Url field.
https://sec.paymentexpress.com/pxaccess/pxpay.aspx
https://uat.paymentexpress.com/pxaccess/pxpay.aspx (only use this if your test account is setup on UAT host).
If Token Billing is required, set Enable Rebill to Yes or No.
If Complete (Capture) & Refund (Credit Memo) transactions are required, the PX Post details must be filled
in.
Enter your PX Post User ID provided by Payment Express into the PxPost UserId field.
Enter your PX Post Password provided by Payment Express into the PxPost Password field.
Enter the PX Post URL into the PxPost Url field.
https://sec.paymentexpress.com/pxpost.aspx
https://uat.paymentexpress.com/pxpost.aspx (only use this if your test account is setup on UAT host).
6 of 12
3.3 Magento 2 Configuration for PX Fusion
1. Navigate to the Magento 2 Payment Methods page (Stores > Configuration > Sales > Payment Methods).
2. Find Payment Express PxFusion payment method.
3. Fill in and complete all fields.
Set Enabled to Yes to enable the plugin
Set Payment Type to desired value (e.g. Purchase)
Enter your PxFusion user name provided by Payment Express into Username field
Enter your PxFusion password provided by Payment Express into Password field
Enter the PxFusion Post Url.
https://sec.paymentexpress.com/pxmi3/pxfusionauth
https://uat.paymentexpress.com/pxmi3/pxfusionauth (only use this if your test account is setup on UAT host)
Enter the PxFusion WSDL.
https://sec.paymentexpress.com/pxf/pxf.svc?wsdl
https://uat.paymentexpress.com/pxf/pxf.svc?wsdl (only use this if your test account is setup on UAT host)
If Complete (Capture) & Refund (Credit Memo) transactions are required, the PxPost details must be filled
in.
Enter your PX Post User ID provided by Payment Express into the PxPost Username field.
Enter your PX Post Password provided by Payment Express into the PxPost Password field.
Enter the PX Post URL into the PxPost Url field.
https://sec.paymentexpress.com/pxpost.aspx
https://uat.paymentexpress.com/pxpost.aspx (only use this if your test account is setup on UAT host)
7 of 12
4 User Experience
The diagram below shows the typical user experience when checking out as a Guest or Registered user. The key
difference is that a Registered User may already have shipping, billing and token data stored and just need to login to
access and select this information.
Sample from Merchant Website Confirmation Page:
Proceed to Checkout
Select Payment Method
(Payment Express Checkout)
Enter Shipping Info
Enter Billing Info
Review & Place Order
PX Pay 2.0 Hosted Payments Page
(Redirect)
User Login
Merchant Website Confirmation Page
Guest UserRegistered User
Select Billing Info
Select Shipping Info
Select Shipping Method
Checkout Method?
PX Fusion Payments Form(No Re-direct)
API?
Only CVC is required if
Token is used
8 of 12
5 Admin Functions
5.1 Complete (Capture) Function 5.1.1 Magento 1 Complete
A Complete (Capture) Transaction can be done via the Magento admin menu. The Complete Transaction requires a PX
Post Account.
1. Navigate to the Magento 1 Orders page (Sales > Orders).
2. Select and open the Order you wish to complete.
3. Click the Invoice button on the top right to create a new invoice for the Order.
4. Click the Submit Invoice button at the bottom right within the Items to Invoice section. Ensure ‘Capture Online’ is
used.
5. A confirmation message will be displayed once the Refund (credit memo) has been processed successfully.
9 of 12
5.1.2 Magento 2 Complete
A Complete (Capture) Transaction can be done via the Magento admin menu. The Complete Transaction requires a PX
Post Account.
1. Navigate to the Magento 2 Payment Orders page (Sales > Orders).
2. Select and open the Order you wish to complete.
3. Click the Invoice button on the top right to create a new invoice for the Order.
4. Click the Submit Invoice button at the bottom right within the Items to Invoice section.
5. A confirmation message will be displayed once the Refund (credit memo) has been processed successfully.
10 of 12
5.2 Refund (Credit Memo) Function
5.2.1 Magento 1 Refund
A Refund (Credit Memo) Transaction can be done via the Magento Admin Panel menu. The Refund Transaction
requires a PX Post Account.
1. Navigate to the Magento 2 Payment Orders page (Sales > Orders).
2. Select the Order you wish to create a credit memo for.
3. Go to the Invoices menu and open the invoice.
4. Click the ‘Credit Memo’ button at the top right of the invoice.
5. Click the ‘Refund’ button at the bottom right within the Refund Totals section. You may adjust the refund amount
as necessary before submitting the Refund.
6. A confirmation message will be displayed once the Refund (credit memo) has been processed successfully.
11 of 12
5.2.2 Magento 2 Refund
A Refund (Credit Memo) Transaction can be done via the Magento Admin Panel menu. The Refund Transaction
requires a PX Post Account.
1. Navigate to the Magento 2 Payment Orders page (Sales > Orders).
2. Select the Order you wish to create a credit memo for.
3. Go to the Invoices menu and open the invoice.
4. Click the ‘Credit Memo’ button at the top right of the invoice.
5. Click the ‘Refund’ button at the bottom right within the Refund Totals section. You may adjust the refund amount
as necessary before submitting the Refund.
6. A confirmation message will be displayed once the Refund (credit memo) has been processed successfully.
12 of 12
General Support Queries - email [email protected]
Technical/Integration Queries - email [email protected]
Sales Queries - email [email protected]
6 Contact Us
New Zealand
Auckland
Phone (landline)
0800 PAYMENT (729 6368)
Phone (mobile)
+64 9 309 4693
Fax
+64 9 309 4694
Address
33 Wilkinson Road, Ellerslie
Auckland
New Zealand
Australia
Sydney
Phone
1 800 006 254 or
+61 2 8268 7700
Fax
1 800 469 709
Address
Level 3, 503-505 Kent Street
Sydney, NSW 2000
Australia
United Kingdom
London
Phone
0800 088 6040 or
+44 (0) 2 037 523 340
Fax
+ 44 (0) 808 280 2432
Address
164 - 180 Union Street
LI. 313
Southwark, London
SE1 0LH
USA
Los Angeles
Phone
1 877 434 0003 or
+1 213 378 1190 or
+1 310 670 7299
Fax
+1 310 670 7298
Address
8939 South Sepulveda
Boulevard,
Suite 520
Los Angeles, CA 90045
USA
Canada
Phone
+1 844 221 2700 or
+1 778 807 5107
Singapore
Phone
+65 315 81353
Hong Kong
Phone (landline)
+85 258 033032
Republic of Ireland
Phone
1800 930 220
International
Phone
+64 9 309 4693
Address
Payment Express
P O Box 8400
Auckland 1150
New Zealand
Rest of the World
