Install the Asaas module on Magento

Install the official Asaas module to offer Pix, bank slip (boleto), and credit card payments in Magento stores.

After completing the installation, configure the environment, the API Key, the payment methods, and the Webhook in the Initial settings step.

Before you begin

Confirm that your environment meets the requirements:

You also need:

• access to the application server;
• permission to run Magento commands;
• support for installation via Composer or through the app/code directory;
• a backup before making changes to the store.

Choose the installation method

The module can be installed through the Adobe Commerce Marketplace, through Composer, or directly from the official Asaas repository.

Adobe Commerce Marketplace

Go to Asaas Payment on the Adobe Commerce Marketplace and add the extension to your account.

Then follow the extension installation process defined by Adobe:

See the Adobe Commerce extension installation guide.

Composer

Install the package:

composer require asaas/module-magento2

During the process, Magento may ask for the credentials used to access the packages.

After the installation, run:

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

If your store uses static content specific to pt_BR, run:

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

Official repository

Use the official Magento module repository.

1. Download or clone the repository.
2. Place the module in:

app/code/Asaas/Magento2

3. Confirm that the directory structure is correct.
4. Run:

bin/magento setup:upgrade

5. Compile the dependencies:

bin/magento setup:di:compile

6. Generate the static content:

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

7. Clear the cache:

bin/magento cache:clean

Validate the installation

After running the commands, go to the Magento admin panel:

Stores > Configuration > Sales > Payment Methods

Confirm that Asaas pagamentos appears among the available payment methods.

The presence of this configuration confirms that the module was loaded by Magento. The integration still needs to be configured before it can process charges.

From installation to the first payment

%%{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["Make a test purchase"]
    D --> E["Confirm the payment"]
    E --> F["Receive Webhook"]
    F --> G["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 validacao
    class G sucesso

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

The configuration of the API Key, environment, payment methods, and Webhook URL is done in the next step.

Common installation errors

The module does not appear in Magento

Check that:

• the directory is in app/code/Asaas/Magento2, for manual installations;
• setup:upgrade was run after the installation;
• the compilation finished without errors;
• the Magento cache was cleared.

After fixing it, go back to Stores > Configuration > Sales > Payment Methods.

The module stopped working after updating Magento

Validate compatibility in a staging environment before applying the update in Production.

If necessary, review the installation and run the upgrade, compilation, static content deploy, and cache cleaning commands again.

Next steps

• Configure the Asaas module
• See the Magento FAQ
• Go back to the integration overview