Version: current

Magento 2 extension

About this guide

This guide will guide you through the steps to setup EBANX as a payment gateway on your Magento store.

How it works

  1. Update your merchant settings

    Access the Dashboard inserting your username and password.

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

    • Status Change Notification URL: {YOUR_SITE}/digitalhub_ebanx/notification/status
    • Response URL: {YOUR_SITE}/digitalhub_ebanx/return/status

    dashboard-settings_integration_key

  2. Install the extension

    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.

    1. Upload the folder app/code and merge them.

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

      php bin/magento setup:upgrade
    3. Remove the content of the folder pub/static and run the command:

      php bin/magento setup:static-content:deploy
    4. Now run the command:

      php bin/magento indexer:reindex
    5. And the composer:

      composer require ebanx/ebanx
    6. Set the permissions that you use on your project to the new files.

  3. Flush Magento Cache

    If necessary, you have to flush the cache at System > Cache Management, by clicking on the button "Flush Magento Cache".

    Magento 2 Plugin Cache

  4. Update the extension settings

    You will see EBANX settings at System > Configuration > Sales > Payment Methods > EBANX.

    Enable the EBANX payment extension and add the integration key you were given by the EBANX integration team. You will need to use different keys in test and production modes.

    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

    SettingDescription
    EnabledEnables or disables the EBANX Standard extension.
    TitleThe title of the payment method, which will be shown on Magento's checkout page.
    Integration keyThey integration key. It'll be different for test and production environments.
    Test modeEnable or disable the test mode.
    Due dateDue date for printable slips (boleto/boletas, etc). You must ask EBANX to change this limit for your account.
    Payment currencyThe 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 statusThe open order status. Standard option is "Pending".
    Paid order statusThe paid order status. Standard option is "Complete".
    Canceled order statusThe paid order status. Standard option is "Canceled".

    EBANX Express -- Transparent credit card checkout settings

    SettingDescription
    EnabledEnables or disables the EBANX Express extension.
    TitleThe title of the payment method, which will be shown on Magento's checkout page.
    Integration keyThey integration key. It'll be different for test and production environments.
    Test modeEnable or disable the test mode.
    Instalments numberThe number of instalments that are enabled.
    Enable instalmentsEnable or disable instalments. Your merchant account must be allowed to process credit card payments with instalments.
    Payment currencyThe 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).

Getting help

We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:

  • If you’re not our partner yet and would like to know more about our prices and conditions please fill ou this form and our comercial team will get in touch with you.
  • In case you’re already our partner please get in touch with our support team at integration@ebanx.com.
  • Alternatively, you can check our FAQ at the end of this page for further questions.
Last updated on by Fernando Pankiewicz Gomes