Configurações iniciais

Após instalar o módulo, configure o ambiente, a API Key, os Webhooks e os meios de pagamento que serão exibidos no checkout.

Ao concluir, valide uma compra completa e confirme se o pedido é atualizado automaticamente após o pagamento.

Antes de começar

Confirme que:

• o módulo Asaas está instalado;
• a conta Asaas está ativa;
• você possui uma API Key do ambiente que será utilizado;
• você possui acesso administrativo ao Magento.

Se ainda não instalou o módulo, consulte Instalando o módulo.

Como funciona

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
    A["Configurar o módulo"] --> B["Cliente cria o pedido"]
    B --> C["Criar cobrança no Asaas"]
    C --> D["Cliente realiza o pagamento"]
    D --> E["Asaas envia o Webhook"]
    E --> F["Magento atualiza o pedido"]

    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 validacao
    class F sucesso

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

1. Configure o endereço do cliente

No painel administrativo do Magento, acesse:

Lojas > Configuração > Clientes > Configurações de Cliente > Opções de Nome e Endereço

Em Número de Linhas em Endereço, informe 4.

2. Acesse as configurações do Asaas

Acesse:

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

Expanda Asaas pagamentos.

Habilite o módulo

Na opção responsável pela ativação do módulo, selecione Sim.

3. Configure a integração

API Key

Informe a API Key correspondente ao ambiente escolhido.

As chaves de Produção e Sandbox são distintas. Se precisar criar uma nova chave, acesse a interface web do Asaas em Integrações > Chaves de API.

Consulte como criar e gerenciar chaves de API.

Ambiente

Selecione o ambiente utilizado pelo módulo:

• Desenvolvimento;
• Produção.

A API Key informada deve pertencer ao ambiente correspondente.

URL para Webhooks de cobrança

O módulo apresenta uma URL para receber as atualizações das cobranças.

Utilize essa URL ao configurar o Webhook de cobrança na conta Asaas. É por meio desse Webhook que alterações financeiras são enviadas ao Magento para atualização automática dos pedidos.

Consulte como criar um Webhook pela aplicação web.

Prefira essa sincronização por Webhooks em vez de realizar consultas periódicas à API.

Ordem de exibição

Defina a ordem em que os meios de pagamento habilitados pelo módulo serão apresentados no checkout.

Habilitar notificações entre Asaas e comprador

Defina se o comprador receberá e-mails relacionados às alterações de status do pagamento.

4. Configure o cartão de crédito

Habilitado

Habilite ou desabilite pagamentos com cartão de crédito.

Parcelas

Defina:

• a quantidade máxima de parcelas;
• o percentual de juros aplicado conforme a quantidade de parcelas.

Tipo do Cartão de Crédito

Selecione as bandeiras que serão exibidas no formulário de cartão de crédito.

5. Configure o boleto

Habilitado

Habilite ou desabilite pagamentos por boleto bancário.

Dias de validade do boleto

Informe quantos dias serão adicionados à data atual para definir o vencimento da cobrança.

Instruções ao usuário

Defina a mensagem exibida na tela de agradecimento após a conclusão do pedido.

6. Configure o Pix

Habilitado

Habilite ou desabilite pagamentos via Pix.

Dias de validade do Pix

Informe quantos dias serão adicionados à data atual para definir a validade do pagamento Pix.

Instruções ao usuário

Defina a mensagem exibida na tela de agradecimento após a conclusão do pedido.

7. Valide a integração

Antes de utilizar a configuração em Produção:

1. selecione o ambiente correto;
2. confirme se a API Key pertence a esse ambiente;
3. realize uma compra de teste;
4. verifique se a cobrança foi criada na conta Asaas;
5. conclua ou simule a alteração do pagamento;
6. confirme se o Webhook atualizou automaticamente o pedido no Magento;
7. valide as condições de parcelamento, vencimento e instruções exibidas no checkout.

Resultado esperado

O checkout deve apresentar somente os meios de pagamento habilitados e utilizar as regras configuradas para cada modalidade.

Após uma alteração financeira no Asaas, o pedido correspondente deve ser atualizado automaticamente no Magento por meio do Webhook.

Erros comuns

API Key inválida

Verifique se:

• a chave foi copiada integralmente;
• a chave continua ativa;
• a credencial corresponde ao ambiente selecionado.

Pedido não é atualizado automaticamente

Verifique a configuração do Webhook.

Se o pagamento estiver atualizado no Asaas, mas o pedido permanecer sem alteração no Magento, confirme se a URL do módulo foi cadastrada corretamente no Webhook de cobrança.

Consulte o FAQ do Magento.

Pix expirado ou boleto vencido

Revise os dias de validade configurados para a respectiva forma de pagamento.

Cartão não apresenta o parcelamento esperado

Revise a quantidade máxima de parcelas e os juros configurados no módulo.

Próximos passos

• Consulte o FAQ do Magento
• Configure e gerencie Webhooks pela aplicação web
• Gerencie suas chaves de API
• Volte à visão geral da integração Magento