Boleto - Shopify
Using Asaas Boleto with Shopify
Install Asaas Boleto on Shopify
Use the Asaas Boleto App to offer bank slip (boleto) as a payment method in the Shopify checkout.
After completing the order, the buyer is redirected to the Asaas invoice, where they can copy the digitable line or download the bank slip.
AttentionIf you want to offer the Pix option on the Asaas invoice in your Shopify store, you must create a Pix key in your Asaas account to speed up the receiving flow, through the Pix > My Keys menu.
If you have no registered Pix keys, charges may be cleared late, affecting order confirmation on Shopify.
Before you start
You need:
- a Shopify store;
- an Asaas account;
- a Production API key;
- optionally, a Sandbox account and API key for testing.
The Production key is required to configure the app. To test before go-live, also configure a Sandbox key.
See how to create and manage API keys.
1. Install the Asaas Boleto App
Go to Boleto - Asaas on the Shopify App Store.
With your store logged in, click Install.
On the next screen, review the permissions requested by the Asaas Boleto App. To continue, click Install again.
2. Configure the API keys
Enter in the app:
- Production API key: used for real transactions;
- Sandbox API key: used for testing and validation.
Production and Sandbox have independent accounts and keys. Use the credential that matches the configured environment.
To make it easier to identify and maintain credentials, you can create a key specifically for the app, for example: Chave API Shopify Boleto.
Attention
- A Production API key is required.
- The Sandbox API key is optional. Provide it only if you want to test your store before putting it into Production.
- If you provide both keys, in the next step you can choose whether to use the Production environment or the Sandbox environment.
- The API key will be displayed only once, at the time it is created. Store your keys securely, as they authenticate actions in your Asaas account.
- If the key is lost, you will need to generate a new key, as it is not possible to recover keys that have already been created.
3. Configure the bank slip
Define the settings used for new purchases.
Minimum due date
In the Minimum due date field, enter the bank slip due period after the charge is created.
When the bank slip reaches the defined due date, the charge and the order will be automatically canceled to restore inventory, if this setting is enabled on the product.
Charge notifications
Enable Enable Asaas charge notifications to use Asaas notifications with the buyer.
Keep the option disabled if your operation does not use this messaging.
After configuring the app, click Save.
If an error occurs when saving, confirm that the keys provided are valid and match the configured environments.
4. Choose the environment and activate the app
Use Test mode to determine which environment will process transactions:
| Setting | Environment used |
|---|---|
| Test mode enabled | Sandbox |
| Test mode disabled | Production |
To use the Sandbox, provide a Sandbox key before enabling Test mode.
After defining the environment, activate the Asaas Boleto App and click Save.
Expected result
The Boleto option should appear among the payment methods available in the Shopify checkout.
Before operating in Production, make a test purchase and confirm that the buyer is redirected to the Asaas invoice.
Payment experience
When selecting Boleto and clicking Pay now, the buyer is redirected to the Asaas invoice.
On the invoice, the buyer can:
- copy the digitable line;
- download the bank slip;
- use Back to return to checkout;
- use I've already paid, displayed after copying the digitable line or downloading the bank slip, to proceed to the store's thank-you page.
When the Pix option is available on the invoice, the buyer can also use it to make the payment.
Next steps
Updated 20 days ago