shift4 plugin for magento 2x magento payment module user gui… · shift4 plugin for magento 2x ......

Join us for treats Thursday, Month Day, at 3:00 p.m. in the kitchen.

Shift4 Plugin for Magento 2x

Shift4 Secure Payment Processing | Creators of Tokenization. Copyright © 1994-2017 Shift4 Corporation. All rights reserved.

Magento ®


© 2017 Shift4 Corporation. All rights reserved. Version 1.1 of 22

Copyright Notice Shift4 Corporation 1491 Center Crossing Road Las Vegas, NV 89144 702.597.2480 www.shift4.com [email protected]

Document Title: Shift4 Plugin for Magento 2x

Publication Date: September 26, 2017

Copyright © 2017 Shift4 Corporation. All rights reserved worldwide. *Universal Transaction Gateway® (UTG®), DOLLARS ON THE NET®, 4Go®, i4Go®, and 4Word® are covered by one or more of the following U.S. Pat. Nos.: 7770789; 7841523; 7891563; 8328095; 8688589; 8690056; 9082120; 9256874; 9495680. All trademarks, service marks, product names, and logos are the property of their respective owners. Shift4 Corporation may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. The furnishing of this document does not give any license to these patents, trademarks, copyrights, or other intellectual property except as expressly provided in any written license agreement from Shift4 Corporation. All graphics are property of Shift4 Corporation. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means without prior written permission of Shift4 Corporation. The contents of this publication are the property of Shift4 Corporation. Shift4 Corporation reserves the right to revise this document and to periodically make changes to the content thereof without any obligation or notification to any organization of such revisions or changes unless required to do so by prior written agreement. Notice of Confidentiality By using this document, the recipient is hereby informed that this document may contain information that is proprietary to and/or a trade secret of Shift4 Corporation. It carries the Shift4 classification “Public.” As such it may be used by anyone with the stipulation that it is provided for the sole purpose of specifying instructions for the Shift4 Corporation products contemplated herein. The recipient agrees to maintain this information in confidence, not reproduce or otherwise disclose this information, and only use this document for none other than its intended purpose. Notice to Governmental End Users If any Shift4 product is acquired under the terms of a Department of Defense contract: use, duplication, or disclosure by the US Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of 252.227.7013. Civilian agency contract: use, reproduction, or disclosure is subject to 52.227-19 (a) through (d) and restrictions set forth in the accompanying end user agreement. Unpublished rights reserved under the copyright laws of the United States.



Shift4 Plugin for Magento 2.1.9 Thank you for using Shift4 with Magento, a payment method that leverages proprietary Shift4 technologies. i4Go®, DOLLARS ON THE NET®, and the Universal Transaction Gateway® (UTG®), give you the security and PCI scope-reduction benefits of a tokenization solution while maintaining all the benefits of keeping the checkout process on your website.

Using Shift4 with Magento provides a number of useful features, including the following:

• Customizable setup options • The ability for customers to store and edit payment cards • Partial authorization • Reporting • DOLLARS ON THE NET pre- and post-settlement auditing capabilities

In addition, we’ve highlighted a few of the many features and benefits of DOLLARS ON THE NET, i4Go, and the UTG in the following sections. As you begin to use these products in conjunction with Magento, we are confident you will be pleased with the results.

Introduction to DOLLARS ON THE NET For just pennies per transaction, DOLLARS ON THE NET offers unbeatable cost savings and security in one flexible method.

Thousands of merchants rely on Shift4’s DOLLARS ON THE NET for fast, accurate, and secure transactions. An enterprise-wide solution, DOLLARS ON THE NET features the most advanced fraud controls, auditing tools, and true bank- and processor-neutrality. Get the best rates available, maintain operational integrity with multiple point-of-sale (POS) or property management system (PMS) solutions, and achieve the lowest breach profile possible with DOLLARS ON THE NET.

Introduction to i4Go i4Go was designed to secure cardholder data (CHD) in e-commerce business environments with Internet browser-based applications that integrate online (website) and onsite (kiosk, Software as a Service) technologies. i4Go accomplishes this by intercepting CHD at the point of entry—before it ever enters the merchant’s Web server or hosting provider’s system. i4Go works with Shift4’s PA-DSS validated Universal Transaction Gateway (UTG) or API Web service and PCI DSS-compliant DOLLARS ON THE NET payment gateway to replace the CHD with a TrueToken®, a unique ID to reference the actual data. This will drastically reduce e-commerce merchants’ PCI DSS scope and may qualify them to use the SAQ-A (EP).



Introduction to the Universal Transaction Gateway (UTG) The UTG encrypts and securely transmits transaction data from an interfaced merchant’s e-commerce shopping cart directly to DOLLARS ON THE NET using Shift4’s proprietary Derived Unique Key Per Transaction with Moving Target Encryption (DUKPT w/MTE). The UTG is a small application that is installed on the merchant’s computer network that facilitates connectivity to Shift4’s data centers. It is proprietary Virtual Private Network (VPN) software that protects the transport of sensitive financial data from interfaced systems to the DOLLARS ON THE NET system. It performs assured delivery, and controls the most favorable route for transactions.

Requirements for Using Shift4 with Magento

Note: For Magento based system requirements, see http://www.magentocommerce.com/system-requirements.

• A working installation of Magento v2.1.0 or higher with secure (https) checkout enabled • A Magento account with store administration access privileges • To process live transactions, a DOLLARS ON THE NET account with Account Administrator

privileges is required. However, this is not required for Demo mode.

WARNING! Changing the Shift4 Plugin code will void the certification. Shift4 cannot be held responsible and is not liable for any cost or lack of productivity incurred should unauthorized changes be made.

WARNING! Receipts generated by the Shift4 Magento module are coded to be compliant with card brand recommended standards, including EMV required content and formatting standards. However, changes to Magento core code or third party receipt plugins may override Shift4’s receipt settings and thereby render the formatting non-compliant with the aforementioned standards. The content however, will still be compliant.

Implementation Steps The basic steps for implementing Shift4 with Magento include the following:

• Downloading and installing the Shift4 Payment method. • Configuring the Shift4 Payment method

http://www.magentocommerce.com/system-requirements



• Testing your configuration

Downloading the S4PM_Magento File Package To download and extract the S4PM_Magento2x_2.1.4.zip file package, complete the following steps:

1. Download http://www.shift4.com/downloads/S4PM_Magento2x_2.1.4.zip and save the file. 2. Create a backup of the Magento files. We suggest creating a backup of the entire Magento folder by

doing a full copy and paste to a different folder location and name (e.g., C:\Magento Backup).

WARNING! Make sure a backup of the Magento files has been created before you proceed. The installation of the S4PM_Magento payment method will add files to the existing Magento files. The rest of the Magento files and folders will remain in their current state and location.

Installing the Shift4 Payment Method To install the Shift4 module into Magento, complete the following steps:

1. Extract all files from the Shift4 download into [root directory] > app > code.

• Your directory structure should now be [root directory] > app > code > Shift4.

Note: This document assumes you have a working knowledge of Magento.

2. To upgrade the module, using the command prompt, enter the following command from the magento2 root directory:

• Php bin/magento setup:upgrade

3. Press the Enter key to execute the command.

Configuring the Shift4 Payment Method To configure the Shift4 Payment method, complete the following steps:

1. Log in to Magento as the administrator.

http://www.shift4.com/downloads/S4PM_Magento2x_2.1.4.zip



2. From the Magento Admin Panel menu, click .

3. From the Stores menu, click Configuration.



4. On the Configuration page, scroll down to Sales and click Payment Methods.

5. In the Merchant Location section, select the desired option in the Merchant Country list.

Tip: For information about each field, click next to the field.

6. Scroll down to the Shift4 Secure Payments section and click .

7. Click next to Credit, Debit, or Gift Card (Shift4).

8. To configure Shift4 Secure Payments, complete the following steps:

• In the Enabled list, select Yes.



Note: the Shift4 option will not be displayed at checkout unless Enabled is set to Yes.

• In the Title field, enter a new title or leave the default. (If Yes is selected in the Enabled field, the text in the Title field will be displayed to your customers to denote the payment option.)

• In the Processing Mode list, select the desired option:

o For testing, select Demo.

Note: If you select Demo and want to simulate an approved transaction, enter the following:

• Test Card Number: 4321000000001119 • Expiration: any future date • CVV: 333 • Amount: $100 or less

If you want to simulate a decline, use the same information above, but with an amount larger than $1,000.

o If you are ready to process real transactions, select Live.

Note: If you select Live, all fields on this page must be configured in order to process real transactions, which will be available in DOLLARS ON THE NET.

• In the Server Addresses field, complete one of the following steps:

o If you are using a UTG, enter the list of UTG IP addresses and port numbers, separated by commas.

o If you are not using a UTG, leave the pre-populated address. The default address is https://dotn.shift4api.net.

Requirement: Setting up a UTG for Magento will require an HTTP SSL Interface.

https://dotn.shift4api.net/



Important: The UTG provides features like Offline mode. Offline mode provides additional functionality and security when the UTG cannot connect to the Shift4 data center. In Offline mode, the UTG closely mimics Online mode by generating a TrueToken® on all authorization and sale requests. For additional information on Offline mode and other UTG features, see the UTG Quick Installation Guide located in DOLLARS ON THE NET Help and MyPortal Documentation Corner.

• In the Auth Token field, paste or enter the Auth Token generated in DOLLARS ON THE NET and click Exchange. This will exchange the Auth Token for an Access Token, which will be displayed masked and allow you to process transactions through DOLLARS ON THE NET.

Note: For additional information on generating an Auth Token, see the Account Administrator Guide located in DOLLARS ON THE NET Help.

• In the Enable Logging list, select the desired option:

o If you do not want to log any communications with DOLLARS ON THE NET, select Off. o If you want to log only the problem communications with DOLLARS ON THE NET, select Log

Problems Only. o If you want to log all communications with DOLLARS ON THE NET, select Log All

Communications.

Note: Log files are generally located within your root Magento installation in {{base_dir}}/var/log. It is recommended that you select Log All Communications, as logs are valuable in troubleshooting problems.

Requirement: Logging must be enabled on the Developer page for the selected option to take effect. However, this does not apply if Off is selected.

• In the Allow Partial Authorization list, select the desired option:



o If you would like to allow a partial authorization on a payment card, select Yes. This will automatically prompt for a different, additional payment card when an approval for a lesser amount is obtained on the submitted payment card.

o If you do not want to allow a partial authorization on a payment card, select No. If No is selected, an authorization for a lesser amount will be voided and a new payment card will be required.

Important: Partial authorization as described above is only available when shipping to a single address. Also, while Shift4’s payment method supports partial authorizations, some third-party one-page checkout extensions do not. If you are using this type of extension and support for partial authorizations is desired, you will need to verify it works with the Shift4 payment method.

• In the Transaction Mode list, select the desired option:

o If you want to authorize and finalize transactions at the same time, select Immediate Charge.

o If you want to authorize transactions and manually finalize the transactions at a later time, select Book and Ship.

Requirement: If you select Book and Ship, you must Submit Invoice before you Submit Shipment.

• In the Enforce Address Validation list, select the desired option:

o If you want to enforce address validation for transactions, select Yes. o If you do not want to enforce address validation for transactions, select No.

Note: Address validation is preferred, as it generally provides a better discount rate.

• In the Only Support Encrypted MSRs list, select the desired option:

o If Shift4 is enabled as a payment option and you would like to only support encrypted magnetic swipe readers (MSRs), select Yes. This will only allow encrypted MSRs to be used when swiping cardholder data.

o If you want to support unencrypted and encrypted MSRs, select No.



Note: The next bullet refers to Health Savings Account/Flexible Spending Account (HSA/FSA).

• In the Support HSA/FSA list, select the desired option:

o If you want to allow HSA/FSA payment cards, select Yes. o If you do not want to allow HSA/FSA payment cards, select No.

Requirement: If you select Yes to allow HSA/FSA payment cards, you must add and configure an attribute in Magento. For more information on attributes, see the Magento help documentation. There is also Appendix A – Creating a Magento Attribute for HSA/FSA Payment Cards section in this document with the basic steps.

• In the Gift Card Disables Expiration Date list, select the desired option:

o If Shift4 is enabled as a payment option and you would like to process gift cards (including It’s Your Card® gift cards) without requiring the customer to enter the card’s expiration date, select Yes.

o If not, select no to require the customer to enter the expiration date when using a gift card.



• In the Gift Card Disables Card Security Code list, select the desired option:

o If Shift4 is enabled as a payment option and you would like to process gift cards (including It’s Your Card® gift cards) without requiring the customer to enter the card’s security code (the three-or-four digit code on the front or back of the card), when using a gift card select Yes.

o If not, select no to require the customer to enter the card’s security code (the three-or-four digit code on the front or back of the card) when using a gift card.



9. Click next to My Save Cards and complete the following steps:

10. In the Enable Card on File list, select the desired option:

• If you would like your customers to be able to select their saved cardholder data during checkout, select Yes.

• If you prefer your customers reenter their cardholder data during checkout, select No.

Note: All cardholder data is tokenized so no real cardholder data is stored in your system.

11. In the Title field, enter a new title or leave the default. (If Yes is selected in the Enable Card on File field, the text in the Title field will be displayed to your customers to denote the payment option.)

12. When you have completed making your selections, click Save Config.

Tip: To restore the Server Addresses field to the default state, click Reset. To replace your current Access Token, click New Token and follow the token exchange instructions under step 8.

Example of Configured Title Text Displayed to Customers The image below is an example of how the text configured in the Title fields would be displayed to customers in the checkout process.



Generating Transaction Reports The Shift4 Payment method provides a number of reporting options that can be useful for comparing your end-of-day totals with DOLLARS ON THE NET.

To generate transaction reports, complete the following steps:

1. Log in to Magento as the administrator.

2. From the Magento Admin Panel menu, select REPORTS > Shift4 Transaction Reports.

3. On the Custom Sales Order Report page, complete the following steps:

• In the Filter By list, select the desired option:

o Order Date o Shipping Date

• In the From field, enter a date in the mm/dd/yyyy format. • In the To field, enter a date in the mm/dd/yyyy format. • In the Order Status list, select the desired option:

o If you want your report to contain transactions regardless of status, select Any.



o If you want your report to only contain a specific transaction status, select Specified and then select the type of transactions to be included in the report. (You may select multiple types by using the Shift key for a range or the Ctrl key for selected types.)

• When you have finished making your selections, click Show Report.



4. The Shift4 Invoice ID listed on the report can be compared to DOLLARS ON THE NET for end-of-day comparison.

Magento Report 1

DOLLARS ON THE NET Report 1



Appendix A – Creating a Magento Attribute for HSA/FSA Payment Cards This appendix provides the basic steps to set up an Inventory Information Approval System (IIAS) attribute in Magento. Setting up the IIAS attribute is required if you will be using HSA/FSA.

Note: For more information on creating attributes and attribute sets, see the Magento help documentation.

1. From the menu, select STORES > Attributes > Attribute Set.



2. Click Add Attribute Set.

3. In the Name field, enter an identifiable name for your attribute set, such as HSA_FSA. 4. In the Based On list, select an attribute set with similar settings, or simply select default. 5. Click Save. 6. Under Groups, click Add New. 7. In the Please enter a new group name field, enter IIAS Type. 8. Click Save.

9. From the main menu, select STORES > Attributes > PRODUCT.



10. Click Add New Attribute.

• The default tab is Properties.

11. In the Default Label field, enter IIAS Type. 12. In the Catalog Input Type for Store Owner list, select Dropdown.

13. Under Manage Options (Values of Your Attribute), click Add Option. 14. In the Admin field, enter IIAS Type, such as 4U-RX.

15. In the Default Store View field, enter the description of the IIAS attribute that will be visible in the store, such as 4U-RX.

16. Click Add Option to add the desired IIAS option.

17. Repeat this process for all of the valid options listed below:

• 4S-Healthcare (Visa/MC Only - Qualified medical expenses, over-the-counter) • 4T-Transit • 4O-Cash Disbursement • 4U-RX • 4V-Vision • 4W-Clinical • 4X-Dental



Note: To reorder the list of attributes, click and drag the attribute to the desired position.

18. In the Advanced Attribute Properties section, enter the following:

• In the Attribute Code field, enter iias_type.

19. Click Save and Continue Edit. 20. From the side menu, click Manage Labels. 21. In the Default Store View field, enter the label name for the attribute. For example IIAS Type.



22. Click Save Attribute.

23. From the main menu, select STORES > Attributes > Attribute Set. 24. Locate the HAS_FSA attribute set you created and click anywhere on the line.

25. Under the Unassigned Attributes section, locate the iias_type attribute you created. 26. Drag the iias_type attribute to the IIAS Type group.



27. From the main menu, select PRODUCTS > Catalog.

28. Select a product to which you want to add an HSA/FSA attribute. 29. Click Edit next to the product. 30. In the Attribute Set list, select the attribute set you created for HSA/FSA.

31. Scroll down to the IIAS Type you created and click . 32. In the list, select the IIAS Type. For example, 4U-RX.

33. Click Save. 34. Repeat this process for additional products to which you want to assign an IIAS Type.

Requirement: You must enter iias_type for HSA/FSA functionality to work.

shift4 plugin for magento 2x magento payment module user gui… · shift4 plugin for magento 2x ......

Documents