Instale o módulo Asaas no Magento

Instale o módulo oficial do Asaas para disponibilizar pagamentos por Pix, boleto bancário e cartão de crédito em lojas Magento.

Após concluir a instalação, configure o ambiente, a API Key, os meios de pagamento e o Webhook na etapa de Configurações iniciais.

Antes de começar

Confirme que o ambiente atende aos requisitos:

Você também precisa:

• de acesso ao servidor da aplicação;
• de permissão para executar comandos do Magento;
• de suporte à instalação via Composer ou pelo diretório app/code;
• de um backup antes de alterar a loja.

Escolha a forma de instalação

O módulo pode ser instalado pelo Adobe Commerce Marketplace, pelo Composer ou diretamente pelo repositório oficial do Asaas.

Adobe Commerce Marketplace

Acesse o Asaas Payment no Adobe Commerce Marketplace e adicione a extensão à sua conta.

Depois, siga o processo de instalação de extensões definido pela Adobe:

Consulte o guia de instalação de extensões do Adobe Commerce.

Composer

Instale o pacote:

composer require asaas/module-magento2

Durante o processo, o Magento poderá solicitar as credenciais utilizadas para acesso aos pacotes.

Depois da instalação, execute:

php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Se sua loja utiliza conteúdo estático específico para pt_BR, execute:

php bin/magento setup:static-content:deploy pt_BR

Repositório oficial

Utilize o repositório oficial do módulo Magento.

1. Baixe ou clone o repositório.
2. Posicione o módulo em:

app/code/Asaas/Magento2

3. Confirme se a estrutura de diretórios está correta.
4. Execute:

bin/magento setup:upgrade

5. Compile as dependências:

bin/magento setup:di:compile

6. Gere o conteúdo estático:

bin/magento setup:static-content:deploy -f

7. Limpe o cache:

bin/magento cache:clean

Valide a instalação

Após concluir os comandos, acesse o painel administrativo do Magento:

Lojas > Configuração > Vendas > Formas de Pagamento

Confirme se Asaas pagamentos aparece entre os meios de pagamento disponíveis.

A presença dessa configuração confirma que o módulo foi carregado pelo Magento. A integração ainda precisa ser configurada antes de processar cobranças.

Da instalação ao primeiro pagamento

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
    A["Instalar o módulo"] --> B["Configurar ambiente e API Key"]
    B --> C["Habilitar formas de pagamento"]
    C --> D["Realizar compra de teste"]
    D --> E["Confirmar o pagamento"]
    E --> F["Receber Webhook"]
    F --> G["Atualizar pedido no Magento"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
    classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px
    classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px

    class A inicio
    class B,C,D,E,F validacao
    class G sucesso

    linkStyle default stroke:#94A3B8,stroke-width:2px

A configuração da API Key, ambiente, formas de pagamento e URL de Webhook é feita na próxima etapa.

Erros comuns na instalação

O módulo não aparece no Magento

Verifique se:

• o diretório está em app/code/Asaas/Magento2, quando a instalação for manual;
• setup:upgrade foi executado após a instalação;
• a compilação foi concluída sem erro;
• o cache do Magento foi limpo.

Após corrigir, acesse novamente Lojas > Configuração > Vendas > Formas de Pagamento.

O módulo parou de funcionar após atualizar o Magento

Valide a compatibilidade em um ambiente de homologação antes de aplicar a atualização em Produção.

Se necessário, revise a instalação e execute novamente os comandos de upgrade, compilação, deploy de conteúdo estático e limpeza de cache.

Próximos passos

• Configure o módulo Asaas
• Consulte o FAQ do Magento
• Volte à visão geral da integração