Version: current

WooCommerce Plugin

About this guide

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

How it works


Before installing our plugin, you can test by yourself in our demonstration page. Access here and have the same experience as your customer.


If you are using our old plugin for Woocommerce, please uninstall it before using the new one.

  1. Install the plugin

    There are two installation methods you can choose from:

    Via Browser

    The easiest and quickest option to install the EBANX plugin for WooCommerce is an automatic installation that can be done without leaving your web browser.

    To do it, log in to the WordPress Dashboard and follow the steps:

    • Open your admin page in WordPress. Go to Plugins > Add new and search for "EBANX Payment Gateway".
    • Click on "Install Now" button.
    • Wait and once the plugin is installed, tap on "Activate".
    • On this step, your plugin is already installed. You have to go to EBANX Settings placed on the sidebar to configure your checkout page.
    • Doing this is time to fill out your information. You need to insert your Integration Keys found on your Dashboard Account, check the payment methods and the other options.

    See an example in the video below:

    Via Github

    You can find our repository here. To view step-by-step installation via GitHub instructions click here.

    To install manually, download our plugin and upload it to your web server via an FTP application. Visit the WordPress codex for further instructions.

  2. Get your Integration Key from your Dashboard

    At the EBANX Dashboard, tap on your user name on the right corner, then Account Settings and Integration to find your Integration Keys.

    Look an example of the page you will find:

    Dashboard page with the Keys

  3. Setup your Integration Key

    Go to your WooCommerce and click on EBANX Settings in sidebar admin menu.

    Add the integration key you've found on the EBANX Dashboard. You will need to use different keys in test (sandbox) and production (live) modes.

    Screen shot with EBANX Plugin Configuration

    Our plugin already comes with set settings, but you can change them according to your necessity.

    Sandbox Integration KeyUnique test mode key, keep it safe and do not expose this information.
    Sandbox Public Integration KeyGeneral test mode key. You can do a token operation using this, key instead of the integration key when the request is from the client of your customer (browser, app, etc.). By doing this, you do not have to deal directly with the credit card information of your customer.
    Live Integration KeyOnce you have completed the process of integration with EBANX, you will receive a unique live mode key which will allow you to operate with our services; it is essential to keep all the information safe and not exposed.
    Live Public Integration Key General live mode key. Just like the Sandbox Public Integration Key, you can do a token operation using this key instead of the integration key when the request is from the client of your customer (browser, app, etc.). By doing this, you do not have to deal directly with the credit card information of your customer.
    EBANX SandboxMark or unmark the box to go into sandbox mode and live. EBANX Sandbox is a testing environment that mimics the live environment. Use it to make payments requirements to see how your eCommerce processes them.
    Debug LogMark or unmark the box to choose to record all errors that occur when executing a transaction.
  4. Enable Payment Methods

    Enable the payment methods for your checkout and make sure that the payment methods chosen are included in your agreement.

    Check the list below for the payment methods available in each country:

    CountryPayment methods
    BrazilBoleto EBANX, Domestic Credit Card and Bank Transfer (TEF)
    MexicoOXXO, Credit and Debit Cards and SPEI
    ArgentinaCupón de Pago
    ColombiaPSE (Pago Seguros en Línea) and Credit Cards
    ChileServiPag, Sencillito, WebPay, Multicaja
    PeruSafetyPay and PagoEfectivo
    EcuadorCash and Bank transfer

    The following image show how it will appear in your administrative area:

    Payment Options

    Credit Card

    • Save Card Data: Choose to allow your customer to save their credit and debit card data for future purchases.(TEF)

    • One-click Payment: Choose to allow your customer to complete payments in one-click using credit cards saved.

    • Enable Auto Capture: Automatically capture payments from your customers, just for the credit card. Otherwise, you will need to capture the payment going to WooCommerce -> Orders. Not captured payments will be cancelled within four days.

    • Maximum Number of Installments: Establish the maximum number of installments in which your customer can pay, as consented to your contract. Only Colombia supports more than 12.

    • Minimum Installment (USD): Set the minimum installment value during checkout. The minimum EBANX allows for BRL is 5 and MXN is 100, lower values in these currencies will be ignored.

    • Interest Rates: Enable and set a custom interest rate for your customers according to the number of Installments you allow the payment.

    Cash Payments

    • Days to Expiration: Define the maximum number of days on which your customer can complete the payment of Boleto, OXXO, Sencillito, PagoEfectivo, and SafetyPay.
  5. Additional Settings

    In the advanced options, you can select features that will help your client to have a better experience in their shops.

    Enable Checkout for

    In order to process with the EBANX Plugin in Brazil there a few mandatory fields such as CPF identification for individuals and CNPJ for companies.

    Checkout Manager

    If you make use of a Checkout Manager, please identify the HTML name attribute of the fields.

    Total Local Amount

    Show your customer the total purchase amount in local currency at the checkout.

    Exchange Rate

    Show your customer the currency exchange rate of the day.

    IOF on Local Amount

    Apply IOF (Brazilian Tax on Financial Operations) when calculating the price in BRL on the checkout.

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 our this form and our commercial team will get in touch with you.
  • In case you’re already our partner please get in touch with our support team at
  • Alternatively, you can check our FAQ at the end of this page for further questions.
Last updated on by FlavioCostaeSilva