Magento

Use the official Asaas module to process Pix, bank slip (boleto), and credit card payments in Magento 2.3.x and 2.4.x stores.

The integration creates charges in the configured Asaas account and uses Webhooks to keep Magento orders updated after payment changes.

Available features

Before you start

Confirm that:

• your store uses Magento 2.3.x or 2.4.x;
• the environment uses PHP 7.1.x or higher;
• you have an active Asaas account;
• the environment allows installing modules through Composer or the application directory;
• you have permission to run the required Magento commands.

The API Key will be configured after installation and must match the environment selected in the module.

How it works

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
A["Install the module"] --> B["Configure environment and API Key"]
B --> C["Enable payment methods"]
C --> D["Customer places the order"]
D --> E["Create charge in Asaas"]
E --> F["Process the payment"]
F --> G["Receive Webhook"]
G --> H["Update order in 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,G validacao
class H sucesso

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

Order updates depend on the Webhook URL configured in the module. Use this communication to track payment changes instead of periodic API queries.

Choose where to continue

You haven't installed the module yet

Go to Installing the module.

In this guide you will find:

• versions and requirements;
• installation through the Adobe Marketplace;
• installation via Composer;
• installation through the application directory;
• commands required to complete the installation.

You've already installed it and need to configure payments

Go to Initial settings.

In this step you configure:

• operating environment;
• API Key;
• Webhook URL;
• payment methods;
• installments and interest;
• bank slip and Pix validity;
• buyer notifications.

You need to check limitations or answer a question

See the FAQ - Magento.

Environments

The module lets you select:

• Development for testing;
• Production for real operations.

Each environment uses its own API Key. The configured credential must belong to the same environment selected in the module.

Before publishing changes to Production, validate charge creation, payment, and automatic order updates in the development environment.

Next steps

• Install the Asaas module
• Configure the payment methods
• See the Magento FAQ