Smart2Pay Magento Plugin Merchant Integration Guide

Transcription

1 Smart2Pay Magento Plugin Merchant Integration Guide Version 5.2

2 COPYRIGHT The information contained in this Merchant Integration Guide is confidential and/or privileged material and is intended only for the persons or the legal entities to which it is addressed. Any review, retransmission, dissemination or other use of, or taking of any action in reliance upon, this information by persons or entities other than the intended recipient is prohibited. If you received this Merchant Integration Guide by error, please contact Smart2Pay and delete the material. Copyright 2015 Smart2Pay. All rights reserved. Version 5.2 Date: October 2015 TRADEMARKS The Smart2Pay logo is a registered trademark of Smart2Pay TM. Other trademarks and service marks in this document are the sole property of the Smart2Pay TM. CONTACT INFORMATION For questions related to this document please contact: Smart2Pay TM Brink 27c, 1251 KS Laren The Netherlands Phone: Fax: support@smart2pay.com

3 1. Introduction About Smart2Pay Smart2Pay TM is a Payment Service Provider specializing in Internet payments since Our head office is based in Amsterdam area (Holland); we have offices in United States, Spain, Austria, Brazil and Romania. We have partnered with many banks and financial institutions all over the world. We are a onestop shop for leading Merchants selling goods or services over the Internet globally. If you need to increase your sales and collect funds from consumers globally, join us. We offer state of the art payment solutions for Internet merchants. For more information on Smart2Pay Payment Service provider, please visit About GlobalPay The GlobalPay payment platform allows Merchants to collect funds from Customers locally in over 70 countries by signing one single contract through one technical interface. Online merchants have access to many (alternative) payment options ranging from online bank transfer (real-time), local regular bank transfer (intraday reporting), ATM payments, Cash Payments, local E-wallet (real-time), Mobile payments (real-time) to Credit and Debit Card processing. GlobalPay is a payment platform that covers the world for online Sellers. It covers all important payment options over the world in one go and is simple to integrate and maintain while providing maximum security and scalability. For more details on GlobalPay payment platform, please request GlobalPay Merchant Integration Guide and GlobalPay Merchant Dashboard Guide from support@smart2pay.com. About Smart2Pay Magento Plugin Smart2Pay Magento plugin connects your Magento store to GlobalPay, the latest payment platform of Smart2Pay. About Merchant Integration Guide This document is aimed at Magento websites administrators as it provides necessary details on how to install and configure the plugin on your Magento store.

4 2. Smart2Pay Magento Plugin installation Plugin version and compatibility list Current stable plugin version of Magento is 1.1.9c. Smart2Pay plugin is compatible with the following Magento versions: 1.5, 1.6, 1.6.1, , 1.7, 1.8, 1.8.1, 1.9, , For newer versions of Magento, please contact Installation 1. Login to the administration area of Magento and then select System-> Magento Connect- >Magento Connect Manager. Image 1 Magento Connect Manager Menu 2. Copy/paste the extension key and click Install.

5 Image 2 Magento Connect Manager

6 3. Smart2Pay Magento plugin configuration Smart2Pay Environments Smart2Pay offers 3 environments you can use to interact with our payment platform. Demo - you should start in Demo environment where all the available payment methods are activated by default and you can use to test our plugin right away. No activation is required. You can test various payment flows for more than 150 payment methods. The order status does not update in this environment, you need to use Test and Live environments for an end to end testing. Test - Once you are familiar with payment flows you should register for a test account online at: You will receive an from our merchant integration team with more details such as your test MID and instructions on how to generate the test signature and setup the notification URL where Magento will receive payment status change notifications so your orders are correctly updated once the payment flows are completed. Live - After testing is completed you can request your production account at: You can always contact our Merchant Integration Team to request additional information about our services at: support@smart2pay.com. Plugin configuration The configurations for the Smart2Pay Magento plugin can be found in the administration area of Magento under: System->Configuration menu, section Sales->Payment Methods-> Smart2Pay Payment Module. Note: If the Smart2Pay Payment Module is not visible, please make sure that the module output is enabled from: System->Configuration->Advanced->Advanced->Disable Modules Output- >Smart2Pay_GlobalPay is Enabled.

7 Image 3 Smart2Pay Payment Module Configuration

8 The available options are described in the following table: Field Description Type Sample Enabled Environment Post URL Live Post URL Test Defines whether the Smart2Pay payment module is active or not. If it is active it will appear in the payment method lists (see image no. 4) The environment to which the plugin points to. If Test is selected then the Post URL Test, Signature Test and MID Test will be used when making the payment. If Demo environment is selected, shop will create transactions on a predefined MID, SiteID and Signature combination, just so that you can see an end-toend transaction flow. This will not require any registration on your behalf on our test or live platforms. However, keep in mind that your shop will not receive background notifications about order updates so not all details and functionality for an order will be available / visible. The URL of GlobalPay API live environment. The URL of GlobalPay API integration environment. [Test, Demo, Live] Yes Test om MID Live MID Test Site ID The Merchant ID for the live Integer environment. Create an account from The account will be activated by Smart2Pay Merchant Integration Team and you will receive an containing this MID. The Merchant ID for the live Integer 1045 environment. Create an account from m. The account will be activated by Smart2Pay Merchant Integration Team and you will receive an containing this MID. If you are managing multiple stores Integer 30112

9 Field Description Type Sample Signature Live Signature Test Return URL Title Skin ID [Debug form] you can use a separate SiteID for each website, with different Signature, ReturnURL and NotificationURL. Please contact support@smart2pay.com for more details on how to setup a multistore configuration. The signature that will be used to compute the hash for live environment. You can set up your signature for production environment at: Configuration Tab->Signature. The signature that will be used to compute the hash for test environment. You can set up your signature for test environment at: An URL where the customer will be redirected after the payment process ends. It is advisable to include the path to the smart2pay/feedback action which displays a friendly message to the user depending on the redirection status of the transaction. This field is filled automatically by plugin at install time. If however, this URL doesn't work for you, you can manually correct it in a similar way which is presented in Sample column This will be displayed to the customers in the checkout process when selecting from possible payment methods. See image 5. Specify the skin ID. The skins can be created in the Online Skin Editor available in the Merchant Dashboard or by uploading a CSS file. For integration/debugging purposes only. If set to Yes, a form with the values sent in the initial POST to GlobalPay will be displayed prior to fb1159ed-3359 fb1159ed index.php/globalpay/index/i nfo/ Alternative payment methods Integer 6 No

10 Field Description Type Sample Display surcharge fee to client Methods mode display Show methods in grid Grid number column Send order number as product description Custom product description Notify customer by Payment Confirmation Template Send payment instructions on order creation Payment Instructions Template (for Multibanco SIBS) Payment Instructions Template (for Bank Transfer) the actual POST. If set to yes, it shows the surcharge amount provided in shop s default currency. By default, method icon images will be shown (Logo). You have the option to display the payment methods as text or as logo and text. By default, methods will be displayed as a two columns table, having payment method's logo or name and description. When set to yes, description is omitted, and columns number can be specified bellow. The number of columns for the grid with logos. Has effect only if Show methods in grid is set to Yes If set to Yes, the Magento order number will be sent as description. If No is selected, the below custom description will be sent. Specifies a global description that will be sent for all the transactions. Integer 4 Yes Logo No Yes Custom product description If set to Yes, the system Yes automatically sends a confirmation to the customer on success payment notification. The template of the List GlobalPay Confirmation Template For Bank Transfer and Multibanco SIBS, Magento can send a confirmation to the customer on order creation with payment details. The template of the containing payment instructions for Multibanco SIBS (PT) payment method. The template of the containing payment instructions for Bank Transfer payment method. List List Yes

11 Field Description Type Sample Create invoice on success Automate shipping New Order status Order status on SUCCESS Order status on CANCEL Order status on FAIL Order status on EXPIRED Auto-select GlobalPay payment methods Skip payment page If set to Yes, the system automatically creates an invoice if payment is successfully completed. The invoice is automatically set to paid. If set to Yes, the system automatically creates a shipping. The status of the order after creation. You should only deliver the goods/services based on the Success notifications. The notifications are received at the notification URL which you set up in the GlobalPay merchant dashboard available at: m. The notification URL is in the form: p/globalpay/index/handleresponse. Magento Smart2Pay_GlobalPay Plugin automatically updates the order status according to the received notifications. This configuration defines the status of the order when the payment has been successfully completed and a success notification is sent by GlobalPay system. You can release the goods/services in this case. The status of the order when a canceled notification is sent by GlobalPay system The status of the order when a failed notification is sent by GlobalPay system The status of the order when an expired notification is sent by GlobalPay system The alternatives payment methods are automatically selected If set to Yes, if all the necessary parameters are sent in the initial List List List List List No No On Hold Processing Canceled Canceled Canceled Yes No

12 Field Description Type Sample Redirect in IFrame Message Success Message Failed Message Canceled Message Pending POST for a specific payment method, the GlobalPay payment page is skipped and the customer is redirected automatically to the payment method provider. If set to Yes, GlobalPay will try to keep the payment flow inside the IFrame. Only some payment methods providers support IFrames, for the others the customer will be redirected to the provider in the main window. See image 6. The message that is displayed at the end of the payment flow when the redirection status is a success. You should only deliver the goods/services based on the success notification received at the notification URL which you set up in the GlobalPay merchant dashboard available at: m. The notification URL is in the form: p/globalpay/index/handleresponse The message that is displayed at the end of the payment flow when the customer is redirected with a failed status. The message that is displayed at the end of the payment flow when the customer has canceled the payment. The message that is displayed to the customer when the redirection status is unknown or the customer must take additional actions to complete the payment: e.g. go to the bank and make an offline bank transfer. Yes Thank you, the transaction was processed successfully. After we receive the final confirmation, we will release the goods. There was a problem processing your payment. Please try again. You canceled the payment. Thank you, the transaction is pending. After we receive the final confirmation, we will release the goods. Table 1 Magento configuration options

13 After the main configuration of the Smart2Pay Payment Module, please activate the payment methods that you plan to use. You have the option to pass the payment method fee to the customer. The fixed amount and/or percentage of the fee can be set in Surcharge column. Image 4 Payment method activation

14 4. Smart2Pay Magento payment flow In the frontend, depending on the billing country of the customer, the activated methods are shown in the checkout process in the payment information step. Image 5 Checkout process / Payment information

15 After order confirmation the customer is redirected to the chosen payment method provider where he finalizes the payment. Image 6 Smart2Pay payment page with Redirect in Iframe set to Yes Upon completion of the payment flow, the customer is redirected back to your website. Image 7 Return page when the redirection status is a success

16 5. Payment status notification After receiving the final confirmation from the provider, our server notifies Magento about the status change. The plugin handles these notifications and updates the order accordingly. This can be checked in Magneto backend in the Orders area. Image 8 The payment status notification of the order