Installing the module

Install the official Asaas module to use Pix, bank slip (boleto), and credit card in the Nuvemshop checkout.

The installation connects your store to an Asaas Production account and lets you configure the initial billing rules.

Before you start

Confirm that:

• your store is on at least the Nuvemshop Essencial plan;
• you have administrative access to the store;
• you will use an existing Asaas Production account or create an account during installation.

If the store is on the Free plan, Nuvemshop lets you change plans and test the plan's features during a trial period managed by the platform itself.

To check the current plan, click the store name in the upper right corner of the admin panel and go to Plans.

The integration provides:

• Bank slip, single payment;
• Pix, single payment;
• Credit Card, single payment or in installments.

1. Install the module

In the Nuvemshop admin panel:

1. Go to My apps.
2. Click Boost your business.
3. Search for Asaas in the app store.
4. Click Install app.
5. Review the requested permissions.
6. Click Accept and start using.

You can also go to the Nuvemshop app store.

After authorizing the installation, choose between connecting an existing Asaas account or creating an account.

2. Connect your Asaas account

If you already have an account, select Has an Asaas account.

In the Asaas API Key field, enter a valid API key from your Production account.

To create a key:

1. Go to the Asaas web interface.
2. Go to Integrations > API Keys.
3. Create a new key.
4. Copy the displayed value.

The key is displayed only once and cannot be recovered later. Store it before leaving the screen.

See how to create and manage API keys.

Go back to the installation in Nuvemshop and paste the full key in the Asaas API Key field.

3. Configure the charges

During installation, define the initial rules used by the module.

Bank slip due date

In No. of days until bank slip due date, enter how many days will be added to the purchase date to define the due date.

The default value is 5.

For example, if the purchase happens today, a value of 5 will make the bank slip due five days later.

Pix expiration

In Expiration period (Pix), define how long the payment will remain available.

Accepted formats:

When no suffix is provided, the value is interpreted in days.

If the field is left empty, no custom expiration will be set for Pix.

After reaching the configured period, the Pix expires and the order may be canceled.

Credit card installments

Select the maximum number of installments you want to offer.

When you enable installments, the module displays additional fields to define the interest applied to each number of installments.

In Minimum amount per installment, define the lowest amount allowed for an installment.

If the minimum amount is not reached, the number of installments shown to the buyer may be reduced or installments may become unavailable.

After completing the settings, click Save.

The rules can be reviewed later as described in Initial settings.

If you do not have an Asaas account yet

If you do not have an Asaas account yet, you can open one directly through the installation of the Asaas module on Nuvemshop.

When you select this option, in addition to the module settings shown in this section, you will also need to provide your company/individual details so that the Asaas account can be opened.

You will need to provide: Name, Email, CPF or CNPJ, Mobile phone, Landline, Address, Number, Neighborhood, and ZIP code (CEP).

After filling in all the fields and defining the module settings, just click "Save" to finish the setup.

You will then receive an email from Asaas to set your password for our platform. Once it is set, you can access Asaas through our website and complete your registration (document submission, additional information, etc.)

Validate the installation

After saving:

1. confirm that Asaas appears in Nuvemshop's Settings > Payment Methods;
2. review the enabled payment methods;
3. make a controlled test purchase;
4. confirm that the charge was created in the Asaas account;
5. check whether the order receives the update after the payment changes.

Expected result

The module should remain active, connected to the Asaas account, and available among the Nuvemshop payment methods.

Charges created by the store should appear in the Asaas account, and payment changes should update orders automatically through the communication configured by the integration.

Common problems

Invalid API Key

Confirm that:

• the key was copied in full;
• the key is still active;
• the credential belongs to the Production account used by the integration.

If necessary, create a new API Key.

Expired Pix

When the configured period is reached, the payment is no longer available and the order may be canceled.

Installments unavailable

Check whether the Minimum amount per installment is compatible with the purchase amount.

This rule may reduce the number of installments shown to the buyer.

Order not updated after payment

The integration uses Webhooks to automatically synchronize Asaas and Nuvemshop.

In cases of temporary unavailability, the update may occur a few moments after the payment changes.

See the Nuvemshop FAQ for other behaviors and limitations.

Next steps

• Review the module settings
• See the Nuvemshop FAQ
• Create and manage your API keys