Woocommerce

Understand when to use the Asaas plugin for WooCommerce, which flows it supports, and which pages to consult for installation, configuration, and troubleshooting.

Use the Asaas plugin for WooCommerce to receive payments from your WordPress store through the Asaas payment gateway.

WooCommerce is an open-source e-commerce plugin for WordPress. It turns a WordPress website into an online store, with products, cart, checkout, and orders.

The Asaas plugin for WooCommerce connects this store to Asaas, allowing Asaas to be the operator of payments made at checkout. This page works as a navigation guide for the integration. Throughout it, you will understand when to use the plugin, which resources are available, and on which pages to find detailed installation, configuration, and troubleshooting instructions.

When to use the plugin

Use the Asaas plugin for WooCommerce when you need to:

Offer transparent checkout, where the customer pays without leaving your website.
Receive upfront credit card charges.
Receive installment charges by bank slip and credit card.
Customize interest according to the number of installments.
Configure payment split (automatic division of the amount received between selected wallets).
Generate subscriptions through WooCommerce Subscriptions by bank slip or credit card.
Offer One-Click-Buy so the customer can store credit card data for future payments, when tokenization has been released by the commercial team.
Enable automatic anticipation on credit card charges.

Prerequisites

Before configuring the integration:

Have a WordPress store with WooCommerce installed.
Install the Asaas plugin for WooCommerce following the guide Installing the plugin.
Configure the plugin’s initial information in Initial settings.
Request tokenization release with the commercial team if you are going to use One-Click-Buy.
Activate WooCommerce Subscriptions if you are going to generate subscriptions through the plugin.

Integration flow

The main integration flow follows this order:

Install the plugin. Add the Asaas plugin to your WooCommerce store to make the payment settings available.
Configure the Asaas account. Enter the credentials and preferences necessary to connect the store to Asaas.
Choose the charge methods. Define which payment methods will be offered at checkout, such as credit card and bank slip.
Configure installment rules. Define when to offer installments and which interest to apply according to the number of installments.
Optional: configure payment split. Apply a global rule to send a percentage of sales to the selected wallets.
Optional: configure subscriptions. Use WooCommerce Subscriptions to generate recurring charges by bank slip or credit card.
Test the checkout. Validate whether the customer can complete the purchase without leaving the website and whether the order follows the expected behavior in WooCommerce.

Main settings

Setting	When to use	Operational impact
Charge methods	When you want to choose which payment methods appear at checkout.	Defines the options the customer sees when completing the purchase.
Installments and interest	When you sell by bank slip or installment credit card.	Changes the final amount according to the number of configured installments.
Payment split	When part of the sale amount must be automatically sent to partners or other wallets.	Divides the sale amounts according to the configured global rule.
WooCommerce Subscriptions	When you sell recurring subscriptions.	Allows subscriptions to be generated by bank slip or credit card through the plugin.
One-Click-Buy	When you want to make future purchases easier with a saved credit card.	Requires prior tokenization release with the commercial team.
Automatic anticipation	When you want to anticipate credit card charges.	Applies automatic anticipation to the configured credit card charges.

Important behaviors

Transparent checkout: the customer completes the payment on your website, without being redirected to an external page.
CPF/CNPJ validation: the plugin validates whether the document informed by the customer is valid before proceeding with the payment.
Payment split: the configuration is global; every sale made in the e-commerce sends a percentage to the selected wallets.
Tokenization: storing card data for One-Click-Buy depends on prior release with the commercial team.
Subscriptions: generating subscriptions through the plugin depends on WooCommerce Subscriptions.

Troubleshooting

If the integration does not work as expected:

Review the plugin’s initial settings in Initial settings.
Check known issues in Common errors.
See Payment method and Charge methods to review the configuration of payment methods.
If the problem involves events or asynchronous updates, see the Webhooks documentation.

What will be configured

During the plugin configuration, you will define, among other points:

Setting	Where it will be performed
Environment (Sandbox or Production)	Initial settings
API Key	Initial settings
Payment methods	Payment methods
Installments and interest	Payment methods
Payment split	Payment methods
Webhooks	Webhooks
Recurring subscriptions	WooCommerce Subscriptions
Tokenization (One-Click-Buy)	Credit card

Each of these settings has specific requirements and behaviors, detailed on the corresponding pages of this guide.

Journey example

The most common plugin configuration follows the flow below:

Install the plugin
        ↓
Connect to Asaas using the API Key
        ↓
Choose the payment methods
        ↓
Configure installments and interest
        ↓
(Test) Make a purchase in Sandbox
        ↓
Validate charge creation
        ↓
Track order update via Webhook
        ↓
Publish in Production

This flow represents most implementations using the Asaas plugin for WooCommerce.