This page's content:

EBANX Pay Magento 2 Extension
Version: 1.0.0
Compatibility: For Magento 2.0 or later

1. Install the extension

1.1 Download the EBANX Pay 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.

1.2 Upload the folder app/code and merge them.

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

php bin/magento setup:upgrade

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

php bin/magento setup:static-content:deploy

1.5 Now run the command:

php bin/magento indexer:reindex

1.6 And the composer:

composer require ebanx/benjamin-local

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

1.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

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

Magento 2 Plugin Config

Magento 2 Plugin Payment Methods

2. Update the extension settings

2.1 Enable the EBANX Pay payment extension.

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

2.3 Change the other settings as needed. The EBANX Pay extension configuration has three sections: EBANX Pay, 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 Pay Standard – Checkout settings


Enables or disables the EBANX Pay extension.

Sandbox Mode

Enable it to generate payments for testing.

Integration key

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

Public Integration Key

Public integration key.


Enable it to get EBANX Pay API messages (good for testing/development).

Show total local amount

Show to customer the total purchase amount in local currency on the checkout.

Brazil payments

Set the Brazil available payment types on checkout: Credit Card and/or Boleto.

3. Terms and conditions

Copyright (c) 2020, EBANX Pay 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 Pay 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 Pay “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 Pay 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.