EBANX Magento 2 Extension

Version: 1.0.0

For Magento 2.0 or later

Magento 2 Plugin EBANX

1. Update your merchant settings

1.1 Access the Dashboard inserting your username and password.

1.2 Go to Settings and change the following fields, where {YOUR_SITE} is your store URL:

  • Status Change Notification URL: {YOUR_SITE}/ebanx/payment/notify
  • Response URL: {YOUR_SITE}/ebanx/payment/return
dashboard-settings_integration_key

2. Install the extension

2.1 Download the EBANX Magento 2 extension and extract its contents to the root folder of your Magento installation. You may want to extract it in your computer and then upload its contents to your server.

2.2 Upload the folder app/code and merge them.

2.3 Open the terminal from the Magento 2 folder and run the command:

language-markup php bin/magento setup:upgrade

2.4 Remove the content of the folder pub/static and run the command:

php bin/magento setup:static-content:deploy

2.5 Now run the command:

php bin/magento indexer:reindex

2.6 And the composer:

composer require ebanx/ebanx

2.7 Set the permissions that you use on your project to the new files.

2.8 If it’s necessary, you have to flush the cache at System > Cache Management, by clicking on the button “Flush Magento Cache”.

Magento 2 Plugin Cache

2.9 If everything was done correctly, you will see EBANX settings at System > Configuration > Sales > Payment Methods > EBANX.

Magento 2 Plugin Config

Magento 2 Plugin Payment Methods

Magento 2 Plugin EBANX Configs

Magento 2 Plugin EBANX Configs Express Checkout

3. Update the extension settings

3.1 Enable the EBANX payment extension.

3.2 Add the integration key you were given by the EBANX integration team. You will need to use different keys in test and production modes.

3.3 Change the other settings as needed. The EBANX extension configuration has three sections: EBANX, the general configurations of the extension; EBANX Express, the transparent checkout for credit cards configuration; and EBANX Standard, the default checkout configuration. Below you will find a detailed description of all availabe settings:

EBANX Standard – Checkout settings

Enabled

Enables or disables the EBANX Standard extension.

Title

The title of the payment method, which will be shown on Magento’s checkout page.

Integration key

They integration key. It’ll be different for test and production environments.

Test mode

Enable or disable the test mode.

Due date

Due date for printable slips (boleto/boletas, etc). You must ask EBANX to change this limit for your account.

Payment currency

The currency to be used in the payment – it can be either the currency shown to the customer or the one used in the backend of the store (base currency).

Open order status

The open order status. Standard option is “Pending”.

Paid order status

The paid order status. Standard option is “Complete”.

Canceled order status

The paid order status. Standard option is “Canceled”.

EBANX Express – Transparent credit card checkout settings

Enabled

Enables or disables the EBANX Express extension.

Title

The title of the payment method, which will be shown on Magento’s checkout page.

Integration key

They integration key. It’ll be different for test and production environments.

Test mode

Enable or disable the test mode.

Instalments number

The number of instalments that are enabled.

Enable instalments

Enable or disable instalments. Your merchant account must be allowed to process credit card payments with instalments.

Payment currency

The currency to be used in the payment – it can be either the currency shown to the customer or the one used in the backend of the store (base currency).

Terms and conditions

Copyright (c) 2016, EBANX Ltda. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of EBANX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. This software is provided by EBANX “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall EBANX be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.