Transcription

Moneris Checkoutand Magento Integration Guide(03/2021)

Record your Moneris merchant ID here:

ContentsIntegrating Moneris Checkout into the Magento Plugin .2Install the Moneris Checkout module . 3Setup and Configuration . 4Set up a Moneris Checkout profile . 4Retrieve the API token . 10Add Moneris Checkout profile details to the Magento 2 configuration .10Capture payments and process refunds. 12Capture payments in Magento 2 . 12Process Refunds in Magento 2 . 12Capture a Preauthorization in the Merchant Resource Center .13Process a Refund in the Merchant Resource Center . 14Process a Void in the Merchant Resource Center . 15Merchant support . 16User help . 17Moneris Checkout and Magento : Integration Guide1

Integrating Moneris Checkout into the Magento PluginIntegratingMoneris Checkoutinto the MagentoPluginIn this section, we go over everything you need toknow to integrate Moneris Checkout with theMagento plugin to accept payments on yourecommerce website.Moneris Checkout and Magento : Integration Guide2

Install the Moneris Checkout moduleThe following steps will guide you through installing and verifying the installation of the Moneris Checkoutmodule.Note: If you have any difficulty with this process, contact CollinsHarper for support. Refer to the User helpsection on page 17 for their contact details.1. Download and extract the Moneris Checkout module to your Magento 2 Installation folder.2. Run the following commands in your hosting command line: bin/magento setup:upgradebin/magento di:compile3. Clear the Magento 2 cache using one of the two following methods:a. Run the following command in your hosting command line: bin/magento cache:flushORb. Navigate to System Tools Cache Management.i. From the drop-down menu in the top left, click Select All.ii. Click the Flush Magento Cache button in the top right corner.4.Verify that the module was successfully installed:a. Go to Stores Settings Configuration Sales Payment Methods.b. In the Payment Methods screen, locate Moneris Payments option.Moneris Checkout and Magento : Integration Guide3

Setup and ConfigurationThe following steps will guide you through the general setup and configuration of a Moneris Checkout profile,and the integration of that profile into Magento 2.If additional support is required, including information about other Moneris Checkout settings, please refer tothe Moneris Merchant Resource Center User Manual, available on the Merchant Resource Center login page,or contact Moneris Customer Care at 1-866-319-7450.Set up a Moneris Checkout profileNote: Some of the items and settings described in these steps may not be visible to you based on the servicesand modules for which you registered when you signed up for Moneris Checkout. You will only see options thatare enabled for your store profile.1. Navigate to one of the two environments in the Merchant Resource Center (MRC): Testing environment: https://esqa.moneris.com/mpg/Production environment: https://www3.moneris.com/mpg/2. Login using your Moneris credentials (Username, Store ID, and Password).3. Click the Admin menu, then click MonerisCheckout Config.4. Click the Create Profile button to create aMoneris Checkout profile.A Saved dialog box appears.5. Click the OK button.Moneris Checkout and Magento : Integration Guide4

6. Under the Checkout Type section, ensurethat the Use Moneris Checkout for thecomplete set of online payment formsradio button is selected, then click theSave button near the top of the screen.7. Scroll down and expand the OrderSummary (Cart) section. Ensure the Order Summary (Cart)details and Product Imagecheckboxes are checked.8. Scroll down and expand the CustomerDetails section. In this section, be sure to uncheck allof the checkboxes.Moneris Checkout and Magento : Integration Guide5

9. Scroll down and expand the MultiCurrency section: Enable/disable Multi-Currency.Determine if you want to enable geolocation for transactions.Note: Geo-location detects the IPaddress of customers using your checkoutand displays product prices andtransaction amounts in the currencycorresponding to the country/location inwhich customers are using the checkoutsubject to the following restrictions: If acustomer's IP address does not correspondwith a currency that your checkout isconfigured to support, the checkout willdisplay prices and transaction amounts inUnited States dollars (USD). If acustomer's IP address does not correspondwith a supported currency and yourcheckout is not configured to supportUSD, the checkout will display prices andtransaction amounts in Canadian dollars(CAD).10. Enable/disable the default currencies thatyou want to support in your checkoutprofile.Note: Support for pricing in Canadiandollars is mandatory (i.e., the CanadianDollar option is always enabled).11. Add/remove other currencies from yourlist of supported currencies:a. Go to the Additional Currenciessection, and click Add Currency.b. When the "Add Currency" dialog boxdisplays, click the Currency dropdown menu and click on the currencythat you want to add.c. Click the Add button.d. Repeat steps 11a – 11c to add othercurrencies as necessary.e. Click the Close button when finished.Moneris Checkout and Magento : Integration Guide6

12. If you want to change a percentagemarkup of a supported currency, click EditMarkup.a. When the "Edit Currency Markup"dialog box displays, locate thecurrency for which you want to editthe markup and enter a wholenumber in the corresponding field.b. Click the Save button to close thedialog box.13. Scroll down and expand the Paymentsection. Under the Accepted Digital Walletssection enable/disable digital walletsupport per your integrationrequirements.Under the Card Logos sectionenable/disable the display of debitand credit card logos per yourintegration requirements.Under the Payment Security section,select fraud-prevention tools per yourintegration requirements. Determine whether to allowMoneris to manage autodecisioning concerning howtransaction requests are handledand processed through yourcheckout:Note:Decisions are basedon fraud-prevention responsecodes from supported fraudprevention tools such as AVS, CVV,3-D Secure, and Moneris Kount .Auto-decisioning may or may notbe configurable from your settingspanel, and may beMoneris Checkout and Magento : Integration Guide7

enabled/disabled by defaultdepending on the fraudprevention features for whichyour store is enabled. Enable/disable each fraudprevention tool (AVS, CVV, 3DSecure, and Kount) if displayed onyour settings panel.Note:The fraud-preventiontools displayed on your settingspanel are dependent on the fraudprevention features for whichyour store is enabled. Some fraudprevention tools may beenabled/disabled by default andmay or may not be configurablefrom your settings panel.Scroll down to Transaction Type andselect the preferred transaction type: To perform purchasetransactions, select Purchase.To perform pre-authorizationtransactions, selectPreauthorization.Note: You can select either Purchaseor Preauthorization, but not both.Note: If you selectedPreauthorization, a customer’spreauthorization can be completedeither through the MRC, or throughMagento 2. For more information,please refer to section Capturepayments and process refunds onpage 12. Under Transaction Limits sectionenable/disable a minimum andmaximum transaction dollar limittype.Note: Transaction limits control themaximum and minimum dollaramounts that can be charged for anyone order submitted by a customer inthe checkout. To enable a limit,Moneris Checkout and Magento : Integration Guide8

checkmark the box beside the desiredlimit type (Transaction Min ( ) andTransaction Max ( )), and then entera dollar amount (#.##) in thecorresponding field. To disable a limit,unmark the box beside the undesiredlimit type.14. Scroll down and expand the OrderConfirmation section. Under Order ConfirmationProcessing, select the Use Monerisoption.Under the Confirmation PageContent section, select the desiredinformation you wish to be displayedon the confirmation page (when thecustomer is completing theirtransaction).15. Scroll down and expand the EmailCommunications section. Under the Email Contents section,select the desired contents that willappear in the order confirmationemail the customer will receive.Under the Customer Emails section,place a checkmark in the desiredcheckbox for what event triggers anemail to be sent to a customer.16. Click the Save button in the upper right corner.17. Click OK in the Success dialogue box.Moneris Checkout and Magento : Integration Guide9

18. Make note of the Checkout ID in theCheckout profile. This value will need tobe entered later during the integrationprocess.Retrieve the API tokenYou also require the API token to integrate Moneris Checkout into your Magento configuration. To access theAPI token, follow the steps below.1. On the Merchant Resource Center main page, click the Admin menu.2. On the Admin menu, click Store Settings.3. On the Store Settings page, record the API Token value.Add Moneris Checkout profile details to the Magento 2 configuration1. Login to the Magento 2 Admin Panel.2. Navigate to Stores Settings Configuration Sales Payment Methods Moneris Payments.3. Click inside the Store ID field and enter the Moneris Store ID value (used to login to the Moneris MRC).4. Click inside the Moneris Checkout ID field and enter the Checkout ID you recorded earlier.5. Click inside the API Token field and enter the API Token you recorded earlier.Moneris Checkout and Magento : Integration Guide10

6. Click the Save Config button in the top right corner.7. Navigate to System Tools Cache Management, select All from the top left drop down menu, then clickthe Flush Magento Cache button in the top right corner.Moneris Checkout and Magento : Integration Guide11

Capture payments and process refundsThe following sections will provide detailed steps for capturing payments and processing refunds (CreditMemos) from the Magento 2 Admin Portal, and to perform administrative transactions in the Moneris MerchantResource Center.Note: If additional support is required beyond the instructions presented in this section, please refer to the Userhelp section on page 17.Capture payments in Magento 2If Moneris Checkout profile payment transaction type selected is Purchase, the payment will automatically becaptured. If Moneris Checkout profile payment transaction type selected is Preauthorization, an invoice needsto be created in Magento 2. Follow the instructions below to create an invoice for a preauthorized transaction.1. Login to the Magento 2 Admin Panel.2. Navigate to Sales Orders.3. Locate the order for which an invoice is to be created and click the View link.4. Click the Invoice button near the top right corner.5. Validate the invoice details and click Submit Invoice in the bottom right corner.Process Refunds in Magento 2A credit memo cannot be issued until after an order payment has been captured. As such, if the transaction typefor the order was preauthorization and the payment has not yet been captured, the order can be cancelled, andyou should perform a 0 capture through the MRC. If the payment has been captured, the merchant can thenissue a credit memo.1. Login to the Magento 2 Admin Panel.2. Navigate to Sales Orders.3. Locate the order for which a credit memo is to be issues and click the View link.4. Click Invoices on the left-hand menu.5. Locate the invoice for which a refund will be issued and click the View link.6. Click Credit Memo near the top-right corner.Moneris Checkout and Magento : Integration Guide12

7. Edit the refund details in the bottom-right corner of the page.8. Do one of the following: To process the credit memo with an automatic refund, click Refund.To process the credit memo but manage the refund outside of Magento 2 Admin Portal, click RefundOffline.Capture a Preauthorization in the Merchant Resource CenterFollow the steps below to capture a debit/credit Preauthorization for a full or partial amount so that theauthorized funds are transferred to your account at settlement. This procedure can also be used to cancel aPreauthorization.1. On the menu bar in the MRC, click on Terminal Capture.The "Capture/Preauth Completion" page appears.2. Enter the order ID of the original debit/credit Preauthorization that you want to capture into the Order IDfield.Note: If you only have a partial order ID, select the begins with or the ends with radio button.3. Click the Locate Transaction button.4. In the "Transaction List" area, locate the Preauthorization that you want to capture, and then click on itscorresponding Capture button.5. Wait for the "Transaction Details" area to display, and then do the following:a. In the Statement Descriptor field, enter a descriptor for the card statement. If the Customer Code field displays, optionally enter a customer code.If the Invoice Number field displays, optionally enter an invoice number.b. In the Amount field, do one of the following: To capture the Preauthorization, enter the amount (e.g. 12.50) that you want to capture.Note: If the Preauthorization is captured for an amount that is less than the originalPreauthorization amount, the un-captured amount will for a period of time remain available for asubsequent Reauthorization. To cancel the Preauthorization and release the funds, enter a zero-dollar amount (0.00).Moneris Checkout and Magento : Integration Guide13

c. If the Add Level 2/3 Details button displays, ignore it and proceed to step 6.6. Click on the Process Transaction button.7. When the "APPROVED" or "DECLINED" response displays on the "Capture" page, the transaction iscomplete:8. Print or e-mail the debit/credit Capture receipt.For more information on performing transactions within the MRC, refer to the Moneris Merchant ResourceCenter User Manual for instructions. That manual is available as a PDF on the MRC login page.Process a Refund in the Merchant Resource CenterFollow the steps below to fully or partially reverse (refund) a Merchant Resource Center-referenced credit cardPurchase or Capture in a closed batch. The funds are restored to the cardholder's card. The Refund and theoriginal transaction will be referenced on the cardholder's statement.Note: To reverse a Merchant Resource Center-referenced debit card transaction, you must do a Void. Refer tothe Moneris Merchant Resource Center User Manual for instructions on performing a Void.Note: Multi-currency pricing (MCP) does not support partial refunds through the Merchant Resource Center.Transactions conducted using MCP will need to be refunded in full.1. On the menu bar, click on Terminal Refund.2. On the Refund page, click inside the Order ID field and enter the order ID of the original transaction that youwant to reverse.Note: If you only have a partial order ID, select the begins with or the ends with radio button.3. Click on the Locate Transaction button.4. In the "Transaction List" area, click on the Refund button beside the transaction that you want to reverse.5. In the "Transaction Details" area, do the following:a. In the Amount field, enter the amount to be refunded e.g. 12.50; otherwise, leave the displayed amountas is to refund the full amount of the original transaction. If the Customer Code field displays, optionally enter a customer code.If the Invoice Number field displays, optionally enter an invoice number.b. If the Add Level 2/3 Details button displays, ignore it and proceed to step 6.6. Click on the Process Transaction button.7. When the "APPROVED" or "DECLINED" response displays on the "Refund" page, the transaction is complete.8. Print or e-mail the debit/credit Refund receipt.For more information on performing transactions within the MRC, refer to the Moneris Merchant ResourceCenter User Manual for instructions. That manual is available as a PDF on the MRC login page.Moneris Checkout and Magento : Integration Guide14

Process a Void in the Merchant Resource CenterFollow the steps below to reverse (cancel) a Merchant Resource Center-referenced debit/credit card Purchase,Capture, or Voice Authorization-Advice in an open batch. The funds of the original transaction are fully restoredto the cardholder's card. The Void transaction and the original transaction will not be referenced on thecardholder's statement.1. On the menu bar, click on Terminal Void.2. Wait for the "Void" page to display.3. In the Order ID field, enter the order ID of the original transaction that you want to reverse.Note: If you only have a partial order ID, select the begins with or the ends with radio button.4. Click on the Locate Transaction button.5. Wait for the "Void" page to display.6. In the "Transaction List" area, click on the Void button beside the transaction that you want to reverse.7. In the "Transaction Details" area, do the following: If the Customer Code field displays, optionally enter a customer code.If the Invoice Number field displays, optionally enter an invoice number.8. Click on the Process Transaction button.9. When the "APPROVED" or "DECLINED" response displays on the "Void" page, the transaction is complete.For more information on performing transactions within the MRC, refer to the Moneris Merchant ResourceCenter User Manual for instructions. That manual is available as a PDF on the MRC login page.Moneris Checkout and Magento : Integration Guide15

Merchant supportMerchant supportAt Moneris, help is always here for you 24/7.Moneris Checkout and Magento : Integration Guide16

User helpShould you find you need assistance beyond this integration guide, please reach out to the appropriate team.For support with the Magento plugin, contact our integration partner, CollinsHarper: [email protected] 226-907-0004 (voicemail only)For support with the Moneris Merchant Resource Center and Moneris Checkout, contact Moneris CustomerCare: Web: moneris.com/support-gateway Email: [email protected] Toll-free: 1-866-319-7450 You can also send us a secure message 24/7 by logging in to Merchant Direct atmoneris.com/mymerchantdirect.Moneris Checkout and Magento : Integration Guide17

MONERIS, MONERIS BE PAYMENT READY & Design and MERCHANT DIRECT are registered trademarks of Moneris Solutions Corporation. Magento is aregistered trademark of Magento Inc. All other marks or registered trademarks are the property of their respective owners. 2021 Moneris Solutions Corporation, 3300 Bloor Street West, Toronto, Ontario, M8X 2X2. All Rights Reserved. This document shall not wholly or in part,in any form or by any means, electronic, mechanical, including photocopying, be reproduced or transmitted without the authorized consent of MonerisSolutions Corporation. This document is for informational purposes only. Neither Moneris Solutions Corporation nor any of its affiliates shall be liable forany direct, indirect, incidental, consequential or punitive damages arising out of use of any of the information contained in this document. Neither MonerisSolutions Corporation or any of its affiliates nor any of our or their respective licensors, licensees, service providers or suppliers warrant or make anyrepresentation regarding the use or the results of the use of the information, content and materials contained in this document in terms of theircorrectness, accuracy, reliability or otherwise. Your credit and/or debit card processing is governed by the terms and conditions of your agreement(s) formerchant credit/debit card processing services with Moneris Solutions Corporation.It is your responsibility to ensure that proper card processing procedures are followed at all times. Please refer to the Moneris Merchant OperatingManual (available at: moneris.com/CAFTC) and the terms and conditions of your applicable agreement(s) for credit/debit processing or other serviceswith Moneris Solutions Corporation for details.MCO Magento-EN (03/2021)

1. Download and extract the Moneris Checkout module to your Magento 2 Installation folder. 2. Run the following commands in your hosting command line: bin/magento setup:upgrade bin/magento di:compile 3. Clear the Magento 2 cache using one of the two following methods: a