PHPackages                             uol/module-boacompra - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. uol/module-boacompra

ActiveMagento2-module

uol/module-boacompra
====================

044PHP

Since Jul 8Pushed 5y agoCompare

[ Source](https://github.com/boacompra/boacompra-plugin-magento-v2)[ Packagist](https://packagist.org/packages/uol/module-boacompra)[ RSS](/packages/uol-module-boacompra/feed)WikiDiscussions master Synced 4d ago

READMEChangelogDependenciesVersions (1)Used By (0)

\#BoaCompra Magento 2 Module

BoaCompra official module for Magento 2
---------------------------------------

[](#boacompra-official-module-for-magento-2)

This module enable Boa Compra payment method in Magento 2 that allows your store to integrate your checkout with Boa Compra.

Getting Started
---------------

[](#getting-started)

### Prerequisites

[](#prerequisites)

- Magento 2.3+
- PHP 7.1+

### Installing

[](#installing)

> ATTENTION We recommend that you back up your Magento store prior to any installation or upgrade of the module.

#### Installing via Composer

[](#installing-via-composer)

To install the module, please following commands:

```
composer require boacompra/boacompra-magento2

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

```

#### Installing via ZIP file

[](#installing-via-zip-file)

1. Unpack the extension ZIP file on **app/code/Uol/BoaCompra**
2. Run following commands:

```
php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

```

### Configuration

[](#configuration)

> The sections and paths names in Magento may vary depending on the version and the translation of your store.

To configure the module go to the administrative panel of your store **Stores -> Configuration**. On the configuration screen, choose the **Sales -> Payment Methods** option in the left panel, then look for the **BoaCompra** section, fill in all the required fields. - Enabled: Enable or disable the BoaCompra payment Method;

- Environment: Select Sandbox or Production mode for your keys (this information is provided by BoaCompra to you);
- Merchant ID: The Merchat Id key (this information is provided by BoaCompra to you);
- Secret Key: The Secret Key (this information is provided by BoaCompra to you);
- Checkout Type: The checkout type allowed in your store (this information is provided by BoaCompra to you);
- Log Transactions: Enable or disable logging all BoaCompra transactions (it is used by developers).

Address (optional)
------------------

[](#address-optional)

In order for the user address to be fully sent in some countries through the BoaCompra (like in brazilian address) module the clients address must be configured as follows:

- Access through the administrative panel of your store: **Stores -> Configuration**. On the Configuration screen, access **Customers -> Customer Configuration -> Name and Address Options**
- Change the **Number of Lines in a Street Address** to 4.
    - The BoaCompra Module will wait for the address as follows:
        - address1 = street
        - address2 = number
        - address3 = neighborhood
        - address4 = complement

======================================

Módulo oficial BoaCompra para Magento 2
---------------------------------------

[](#módulo-oficial-boacompra-para-magento-2)

Este módulo permite o método de pagamento Boa Compra no Magento 2, que permite que sua loja integre seu checkout com a Boa Compra.

Começando
---------

[](#começando)

### Pré-requisitos

[](#pré-requisitos)

- Magento 2.3+
- PHP 7.1 ou superior

### Instalando

[](#instalando)

> ATENÇÃO Recomendamos que você faça backup da sua loja Magento antes de qualquer instalação ou atualização do módulo.

#### Instalando via Composer

[](#instalando-via-composer)

Para instalar o módulo, siga os comandos:

```
composer require boacompra/boacompra-magento2

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

```

#### Instalando via arquivo ZIP

[](#instalando-via-arquivo-zip)

1. Descompacte o arquivo ZIP da extensão em \*\* app / code / Uol / BoaCompra \*\*
2. Execute os seguintes comandos:

### Configuração

[](#configuração)

> Os nomes das seções e caminhos no Magento podem variar dependendo da versão e da tradução da sua loja.

Para configurar o módulo, vá para o painel administrativo da sua loja **Lojas -> Configuração**. Na tela de configuração, escolha a opção **Vendas -> Formas de pagamento** no painel esquerdo e procure a seção **BoaCompra**, preencha todos os campos obrigatórios.

- Ativado: ativa ou desativa o método de pagamento BoaCompra;
- Ambiente: selecione o modo Sandbox ou Production para suas chaves (essa informação é fornecida pela BoaCompra para você);
- ID do comerciante: a chave do ID do comerciante (essa informação é fornecida pela BoaCompra para você);
- Chave Secreta: A Chave Secreta (esta informação é fornecida pela BoaCompra para você);
- Tipo de finalização da compra: o tipo de finalização da compra permitido em sua loja (essa informação é fornecida pela BoaCompra para você);
- Transações de log: ative ou desative o log de todas as transações do BoaCompra (usadas pelos desenvolvedores).

Endereço (opcional)
-------------------

[](#endereço-opcional)

Para que o endereço do usuário seja totalmente enviado em alguns países através do módulo BoaCompra (como no endereço brasileiro), o endereço do cliente deve ser configurado da seguinte maneira:

- Acesse através do painel administrativo da sua loja: **Lojas -> Configuração**. Na tela Configuração, acesse **Clientes -> Configuração do cliente -> Opções de nome e endereço**
- Altere o \* Número de linhas em um endereço\*\* para 4.
    - O módulo BoaCompra aguardará o endereço da seguinte forma:
        - endereço1 = rua
        - endereço2 = número
        - address3 = bairro
        - endereço4 = complemento

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity33

Early-stage or recently created project

 Bus Factor1

Top contributor holds 60% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/46e3fad26aa8089400977e3b37c396cfd7213ce1eedc8e41af56b119315d2fbb?d=identicon)[raphael.rejes](/maintainers/raphael.rejes)

---

Top Contributors

[![raphaelrejes](https://avatars.githubusercontent.com/u/17185920?v=4)](https://github.com/raphaelrejes "raphaelrejes (3 commits)")[![boacompra-integrations](https://avatars.githubusercontent.com/u/36899954?v=4)](https://github.com/boacompra-integrations "boacompra-integrations (2 commits)")

### Embed Badge

![Health badge](/badges/uol-module-boacompra/health.svg)

```
[![Health](https://phpackages.com/badges/uol-module-boacompra/health.svg)](https://phpackages.com/packages/uol-module-boacompra)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)