Smart2Pay Magento Plugin: connects your Magento store to GlobalPay, the latest payment platform of Smart2Pay. Below you will find the necessary details for Magento websites administrators on how to install and configure the plugin on your Magento store.
Current stable plugin version of Magento is 1.1.16b. Smart2Pay plugin is compatible with the following Magento versions: 1.5, 1.6, 1.6.1, 1.6.2.0, 1.7, 1.8, 1.8.1, 1.9, 1.9.1.0, 1.9.1.1, 1.9.2.1.
Also, we have released a payment plugin that is compatible with Magento 2.0 version. For more details about the configuration of the new plugin, please go to Smart2Pay Magento 2.0 Plugin Configuration.
After downloading the archive from GitHub, you can install our plugin by following these steps:
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.
Checkout below the available options of configuration for the Smart2Pay Magento plugin:
Smart2Pay Payment Module Configuration
| General Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Enabled | Defines whether the Smart2Pay payment module is active or not. If it is active it will appear in the payment method lists. | Boolean | Yes |
| Environment | 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-to-end 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. | [Test, Demo, Live] | Test |
| Post URL Live | The URL of GlobalPay API live environment. | String | https://api.smart2pay.com |
| Post URL Test | The URL of GlobalPay API integration environment. | String | https://apitest.smart2pay.com |
| MID Live | The Merchant ID for the live environment. Create an account at https://dashboard.smart2pay.com The account will be activated by Smart2Pay Merchant Integration Team and you will receive an e-mail containing this MID. | Integer | |
| MID Test | The Merchant ID for the live environment. Create an account at https://dashboardtest.smart2pay.com. The account will be activated by Smart2Pay Merchant Integration Team and you will receive an e-mail containing this MID. | Integer | 1045 |
| Site ID | If you are managing multiple stores 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. | Integer | 30112 |
| Signature Live | The signature that will be used to compute the hash for live environment. You can set up your signature for production environment at: https://dashboard.smart2pay.com, Configuration Tab->Signature. | String | 0 |
| Signature Test | The signature that will be used to compute the hash for test environment. You can set up your signature for test environment at: https://dashboard.smart2pay.com. | String | fb1159ed-3359 |
| Return URL | 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. | String | http://www.merchant.com/index.php/globalpay/index/info/ |
| Title | This will be displayed to the customers in the checkout process when selecting from possible payment methods. | String | Alternative payment methods |
| Skin ID | 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. | Integer | 6 |
| [Debug form] | 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 the actual POST. | Boolean | No |
| Methods Display Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Display surcharge fee to client | If set to yes, it shows the surcharge amount provided in shop’s default currency. | Yes | |
| Methods display mode | 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. | Boolean | Logo |
| Show methods in grid | 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. | Boolean | No |
| Grid column number | The number of columns for the grid with logos. Has effect only if Show methods in grid is set to ‘Yes’. | Integer | 4 |
| Send order number as product description | If set to ‘Yes’, the Magento order number will be sent as description. If ‘No’ is selected, the below custom description will be sent. | Boolean | Yes |
| Custom product description | Specifies a global description that will be sent for all the transactions. | String | Custom product description |
| Email Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Notify customer by email | If set to ‘Yes’, the system automatically sends a confirmation email to the customer on success payment notification. | Boolean | Yes |
| Payment Confirmation Template | The template of the e-mail | List | GlobalPay Confirmation Template |
| Send payment instructions on order creation | For Bank Transfer and Multibanco SIBS, Magento can send a confirmation email to the customer on order creation with payment details. | Boolean | Yes |
| Payment Instructions Template (for Multibanco SIBS) | The template of the e-mail containing payment instructions for Multibanco SIBS (PT) payment method. | List | |
| Payment Instructions Template (for Bank Transfer) | The template of the e-mail containing payment instructions for Bank Transfer payment method. | List | |
| Order Related Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Create invoice on success | If set to ‘Yes’, the system automatically creates an invoice if payment is successfully completed. The invoice is automatically set to ‘paid’. | Boolean | No |
| Automate shipping | If set to ‘Yes’, the system automatically creates a shipping. | Boolean | No |
| New Order status | The status of the order after creation. | List | On Hold |
| Order status on SUCCESS | 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: https://dashboardtest.smart2pay.com. The notification URL is in the form: http://www.merchant.com/index.php/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. | List | Processing |
| Order status on CANCEL | The status of the order when a ‘canceled’ notification is sent by GlobalPay system. | List | Canceled |
| Order status on FAIL | The status of the order when a ‘failed’ notification is sent by GlobalPay system. | List | Canceled |
| Order status on EXPIRED | The status of the order when an ‘expired’ notification is sent by GlobalPay system. | List | Canceled |
| Payment Flow Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Auto-select GlobalPay payment methods | The alternatives payment methods are automatically selected | Boolean | Yes |
| Skip payment page | If set to ‘Yes’, if all the necessary parameters are sent in the initial POST for a specific payment method, the GlobalPay payment page is skipped and the customer is redirected automatically to the payment method provider. | Boolean | No |
| Redirect in IFrame | 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. | Boolean | Yes |
| Message Success | 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: https://dashboardtest.smart2pay.com. The notification URL is in the form: http://www.merchant.com/index.php/globalpay/index/handleResponse. | String | Thank you, the transaction was processed successfully. After we receive the final confirmation, we will release the goods. |
| Message Failed | The message that is displayed at the end of the payment flow when the customer is redirected with a failed status. | String | There was a problem processing your payment. Please try again. |
| Message Canceled | The message that is displayed at the end of the payment flow when the customer has canceled the payment. | String | You canceled the payment. |
| Message Pending | 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. | String | Thank you, the transaction is pending. After we receive the final confirmation, we will release the goods. |
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.
You can download the archive of the Smart2Pay Magento 2.0 Plugin from GitHub.
The configurations for the Smart2Pay Magento 2.0 plugin can be found in the administration area of Magento under: Stores-> Settings -> Configuration menu->section Sales->Payment Methods-> Smart2Pay.
Note: If the Smart2Pay Payment Module is not visible, please make sure that the module output is enabled from: Stores->Settings->Configuration menu->section Advanced->Advanced->Disable Modules Output->Smart2Pay_GlobalPay.
Checkout below the available options of configuration for the Smart2Pay Magento 2.0 plugin:
Smart2Pay Payment Module Configuration
| Smart2Pay – General Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Enabled | Defines whether the Smart2Pay payment module is active or not. If it is active it will appear in the list of payment methods. | Boolean | Yes |
| Method Title | You can insert a custom title for the payment module. This will be displayed to the customers in the checkout process when selecting from possible payment methods. | String | Smart2Pay Methods |
| Environment | 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-to-end 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. | [Test, Demo, Live] | Test |
| Post URL Live | The URL of GlobalPay API live environment. | String | https://api.smart2pay.com |
| Post URL Test | The URL of GlobalPay API integration environment. | String | https://apitest.smart2pay.com |
| MID Live | The Merchant ID for the live environment. Create an account at https://dashboard.smart2pay.com. The account will be activated by Smart2Pay Merchant Integration Team and you will receive an e-mail containing this MID. | Integer | 0 |
| Site ID | If you are managing multiple stores 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. | Integer | 30562 |
| MID Test | The Merchant ID for the test environment. Create an account at https://dashboardtest.smart2pay.com. The account will be activated by Smart2Pay Merchant Integration Team and you will receive an e-mail containing the MID. | Integer | 1045 |
| Signature Live | The signature that will be used to compute the hash for live environment. You can set up your signature for production environment at: https://dashboard.smart2pay.com, Configuration Tab->Signature. | String | |
| Signature Test | The signature that will be used to compute the hash for test environment. You can set up your signature for test environment at: https://dashboard.smart2pay.com. | String | 752ae49a-7958 |
| Return URL | 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. | String | http://www.yoursite.com/smart2pay/payment/finish/ |
| Skin ID | 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. | Integer | 0 |
| Debug form | 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 the actual POST. | Boolean | Yes |
| Sort order | Sort order will change order of all Smart2Pay payment methods. | Integer | 0 |
| Smart2Pay – Methods Display Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Methods display mode | By default, method icon images and text will be shown (Logo and Text). You have the option to display the payment methods as text, as logo, or as logo and text. | List | Logo and Text |
| Display method description | By default, methods will be displayed having payment method’s logo and description. When set to yes, description will be displayed. | Boolean | Yes |
| Send order number as product description | If set to ‘Yes’, the Magento order number will be sent as description. If ‘No’ is selected, the below custom description will be sent. | Boolean | Yes |
| Custom product description | Specifies a global description that will be sent for all the transactions. | String | Custom product description |
| Smart2Pay – Email Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Notify customer by email | If set to ‘Yes’, the system automatically sends a confirmation email to the customer on success payment notification. | Boolean | Yes |
| Payment Confirmation Template | The template of the email. | List | Payment Confirmation |
| Send payment instructions on order creation | For Bank Transfer and Multibanco SIBS, Magento can send a confirmation email to the customer on order creation with payment details. | Boolean | Yes |
| Payment Instructions Template (for Multibanco SIBS) | The template of the e-mail containing payment instructions for Multibanco SIBS (PT) payment method. | List | Payment Instructions (SIBS) |
| Payment Instructions Template (for Bank Transfer) | The template of the e-mail containing payment instructions for Bank Transfer payment method. | List | Payment Instructions (Bank Transfer) |
| Smart2Pay – Order Related Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Create invoice on success | If set to ‘Yes’, the system automatically creates an invoice if payment is successfully completed. The invoice is automatically set to ‘paid’. | Boolean | Yes |
| New Order status | The status of the order after creation. | List | Smart2Pay New Order |
| Order status on SUCCESS | 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: https://dashboardtest.smart2pay.com. The notification URL is in the form: http://www.merchant.com/index.php/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 the GlobalPay system. You can release the goods/services in this case. | List | Smart2Pay Success |
| Order status on CANCEL | The status of the order when a ‘canceled’ notification is sent by GlobalPay system. | List | Smart2Pay Canceled |
| Order status on FAIL | The status of the order when a ‘failed’ notification is sent by GlobalPay system. | List | Smart2Pay Failed |
| Order status on EXPIRED | The status of the order when an ‘expired’ notification is sent by GlobalPay system. | List | Smart2Pay Expired |
| Smart2Pay – Payment Flow Settings | |||
|---|---|---|---|
| Field | Description | Type | Sample |
| Skip payment page | If set to ‘Yes’, if all the necessary parameters are sent in the initial POST for a specific payment method, the GlobalPay payment page is skipped and the customer is redirected automatically to the payment method provider. | Boolean | Yes |
| Message Success | 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: https://dashboardtest.smart2pay.com. The notification URL is in the form: http://www.merchant.com/index.php/globalpay/index/handleResponse. | String | Thank you, the transaction was processed successfully. After we receive the final confirmation, we will release the goods. |
| Message Failed | The message that is displayed at the end of the payment flow when the customer is redirected with a failed status. | String | There was a problem processing your payment. Please try again. |
| Message Canceled | The message that is displayed at the end of the payment flow when the customer has canceled the payment. | String | You have canceled the payment. |
| Message Pending | 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. | String | Thank you, the transaction is pending. After we receive the final confirmation, we will release the goods. |
After the main configuration of the Smart2Pay Payment Module, please activate the payment methods that you plan to use.
The customer adds the product in the shopping cart and Proceeds to checkout.
In the Shipping area the customer needs to enter a valid email address that will be used for order confirmation. Also, the customer needs to provide a delivery address. The mandatory filed are marked with an asterisk sign. The customer can create an account after the checkout.
After choosing a delivery address, the customer has to select a shipping method.
Depending on the billing country of the customer, the activated methods are shown in the checkout process in the Payment step, Smart2Pay Methods section. After choosing the payment method, the customer can click Place the Order button.
After selecting the preferred payment method the customer needs to confirm the order by clicking on the Submit button.
After order confirmation the customer is redirected to the chosen payment method provider where he enters the necessary details of the payment.
The customer is redirected to the provider’s confirmation page. All the payment details are provided here and the customer has the posibility to print them.
Upon completion of the payment flow, the customer is redirected back to your website.
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.
After order confirmation the customer is redirected to the chosen payment method provider where he finalizes the payment.
Upon completion of the payment flow, the customer is redirected back to your website.
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.
