Initial Settings

With the Asaas Plugin, WooCommerce, and the Brazilian Market on WooCommerce installed on your site, your store will be ready to be configured.

You can now activate the payment methods you wish to offer.

To configure this, just access the WooCommerce > Settings menu. On the page, go to the "Payments" tab, and you will find all available payment methods, which you can activate as needed.

Each payment method has its own settings, which can be deactivated or performed independently.

Environments and API Key

Before starting to configure payment methods, you will need to connect your Wordpress store with your Asaas account.

If you first want to test the integration, you can create an account in the Asaas Development environment (Sandbox). To do this, go to https://sandbox.asaas.com and create your account.

The production environment is accessed by https://www.asaas.com/

It is important to highlight that, although the Sandbox environment is identical to the Asaas production environment, each environment will have its own credentials and API Key.

After defining the environment, you will need to generate its API key.

To do this, access your Asaas account (in the required environment), and in the user menu, access the "Integrations" option. On this screen, click on "Generate new API Key", and copy the entire contents of the displayed key:

After copying your API Key, access the management page for any payment method provided by Asaas, through the Payments menu in your WooCommerce. With the page open, navigate to the "API" section.

• 

  Ambiente: Nesse campo, você irá selecionar o ambiente que deseja conectar com a sua loja. Caso deseje apenas testar a sua integração e já tenha gerado sua chave de API de Sandbox, selecione a opção "Sandbox". Para utilizar no ambiente real, selecione "Produção".

• Chave da API: Cole aqui todo o conteúdo copiado da API Key no Asaas, incluindo caracteres especiais.

  Assim que informar o ambiente e a sua chave, as informações serão validadas. Em caso de sucesso, mostraremos a mensagem "✅ Chave de API válida" ao lado do campo da chave. Em caso da chave inválida, verifique se o ambiente informado está correto e/ou se gerou a chave de API no ambiente desejado antes de salvar suas configurações.

  Após informar o ambiente e a sua Chave de API estar validada, você já poderá salvar as alterações.

  ❗️

  Atenção: Sua API Key carrega muitos privilégios, portanto certifique-se de mantê-la protegida. Não informe ela em atendimentos e guarde-a com muito cuidado.

Webhooks Configuration

The webhook is the mechanism responsible for keeping your store's orders updated according to their payment status in Asaas.

Starting with version 2.5 of the Asaas Plugin, webhooks configuration has become fully automatic. In other words, when you enter your account's API key and save, the plugin will automatically configure the webhooks queue in your Asaas account.

📘

The API and Webhook configuration will be present in all payment methods, however this configuration is shared between all of them, and there is no need to configure each one individually.

Configuring Bank Slip

In the management options for the "Bank Slip" payment method, you will find the following configuration options:

Enable/Disable

Activate to offer payment via Bank Slip to your customer.

Title

This field controls the title of the payment method on the checkout screen.

Description

Information that will be viewed just below the title of the payment method on the checkout screen.

Installments

Inform the limit of installments allowed for Bank Slip. Accepted values between 0 to 60.

Interest per installment

If you have informed a limit of installments in the previous field, additional fields will open for you to inform the interest configuration for each installment option.

Minimum installment value

Defines the minimum allowed value for each installment.

Validity days

Number of days that the bank slip is valid after the purchase.

Validity period

Number of days that the bank slip will be kept in Asaas after its expiration. At the end of this period, the bank slip will be removed. It will be kept if the field is left blank.

Split

If you need to pay commissions or perform divisions of the balance to be received in your charges, you can use the Payment Split in WooCommerce. The functionality is available to all WooCommerce user clients, starting from the Asaas plugin version 2.2.0. See more below in the Split session.

Notifications between Asaas and the customer

Allows Asaas to send email and SMS about the purchase to your customer and notify them periodically while the purchase is not paid. This option is shared with other Asaas payment methods.

API

If you have already configured following the flow of the "Environments, API Key, and Webhook Settings" section, it will not be necessary to configure again.

Configuring PIX

In the management options for the "Pix" payment method, you will find the following configuration options:

Enable/Disable

Activate to make the Pix payment available to your customer.

Title

This field controls the title of the payment method on the checkout screen.

Description

Information that will be viewed right below the payment method title on the checkout screen.

Validity Days

Number of days the Pix is valid after purchase. At the end of this period, the Pix will be removed.

Copy and Paste

If this option is active, the Copy and Paste Pix will be displayed at checkout. If it is disabled, only the QRCode will be displayed.

Split

If you need to pay commissions or perform divisions of the balance to be received on your charges, you can use the Payment Split in WooCommerce. The feature is available to all WooCommerce user clients, starting from the Asaas plugin version 2.2.0. See more below in the Split section.

Notifications between Asaas and the customer

Allows Asaas to send email and SMS about the purchase to your customer and notify them periodically while the purchase is not paid. This option is shared with other Asaas payment methods.

API

If you have already configured following the flow of the section "Environments, API Key, and Webhook Settings", it will not be necessary to configure again.

Configuring Credit Card

In the management options for the "Credit Card" payment method, you will find the following configuration options:

Enable/Disable

Activate to make the Credit Card payment available to your customer.

Title

This field controls the title of the payment method on the checkout screen.

Description

Information that will be viewed right below the payment method title on the checkout screen.

Minimum Total Order

Defines the minimum order value to make the Credit Card payment method available. If you enter the value "0", the payment method will be fully available.

Installments

Inform the limit of installments allowed for Credit Card. Accepted values from 0 to 12.

Interest per Installment

If you have informed a limit of installments in the previous field, additional fields will be opened for you to inform the interest configuration for each installment option.

Minimum Installment Value

Defines the minimum allowed value for each installment.

Split

If you need to pay commissions or perform divisions of the balance to be received on your charges, you can use the Payment Split in WooCommerce. The feature is available to all WooCommerce user clients, starting from the Asaas plugin version 2.2.0. See more below in the Split section.

Notifications between Asaas and the customer

Allows Asaas to send email and SMS about the purchase to your customer and notify them periodically while the purchase is not paid. This option is shared with other Asaas payment methods.

API

If you have already configured following the flow of the section "Environments, API Key, and Webhook Settings", it will not be necessary to configure again.

Subscriptions

If you have the WooCommerce Subscriptions Plugin in your store, you can use it in conjunction with Asaas to create and manage your bank slip and credit card charges in a recurrence/subscriptions format.

The Asaas gateway supports recurrences in the following cycles: MONTHLY, BIWEEKLY, BIMONTHLY, QUARTERLY, SEMIANNUAL, ANNUAL.

To create and manage your subscriptions, just access the menu WooCommerce > Subscriptions.

In the menu, you can follow the status of all your already created subscriptions, besides creating new subscriptions.

With the Asaas plugin, you can create subscriptions with a trial period, in addition to also charging registration fees.

All orders created within a subscription will be linked to it as a "child-order", and can be viewed within the subscription management panel, in the "Related Purchases" field.

It is also possible to determine an end date for the subscription directly in its settings, and this setting will be sent to Asaas to determine the end of the charges.

Payment Split

If you need to pay commissions or perform divisions of the balance to be received on your charges, you can use the Payment Split in WooCommerce. The feature is available to all WooCommerce user clients, starting from the Asaas plugin version 2.2.0.

At the moment, it is possible to configure percentage splits individually for credit card, bank slip, and Pix, allowing you to set up different splits for each payment method.

Configuring the Split

First, you need the WalletId of the wallet that will receive the commission.

Your commissionee needs to access the Asaas account and the WalletId will be located in the Integrations menu.

With the WalletId, you can now configure the Payment Split. For this, go to your store and access the menu WooCommerce > Settings > Payments and select the Asaas payment method for which you want to configure the split.

When selecting the desired payment method, navigate to the Split section. Then, you will define in Quantity the number of commissioned wallets. After saving, the wallet index will be displayed. Now, you can put a Nickname (of your choice, to easily identify in the order logs), the Wallet ID (which is the WalletId provided by your partner) and the Percentage that the commissionee will receive. In total, it should not exceed 100%.

After that, just save the changes and repeat the process in the other payment methods, if necessary.

❗️

Attention

• Subscriptions are not yet compatible, but we will work on it soon.
• The split settings are not shared between payment methods, being necessary to configure separately for Pix, Bank Slip, and Card.

Possible Errors

If you enter a value above 100%, when saving the changes, you will receive the following exception:

Split: The sum of the wallets cannot exceed 100%.

If you enter an invalid wallet, you will receive the following exception:

Wallets without nickname, invalid ID, or percentage equal to zero will not be processed at checkout. The wallet $nickname contains an invalid ID format.