Shopify

Shopify is an e-commerce platform that allows you to create, configure, and manage online stores.

Asaas provides Payment Apps for Shopify, allowing stores to process sales by Boleto, Pix, and Credit Card using the Asaas payment gateway.

Each payment method has its own app and can be installed individually, according to the needs of the store operation.


When to use

Use the integration between Asaas and Shopify when your store needs to:

  • offer Boleto, Pix, or Credit Card at the Shopify checkout;
  • process payments through the Asaas gateway;
  • centralize receivables in the Asaas account;
  • allow refunds and reversals according to the payment method used;
  • configure installment payments by credit card;
  • use a checkout experience integrated with the store.

This integration is recommended for merchants who want to operate payments on Shopify without developing their own integration with the Asaas API.


Available payment apps

Asaas provides three Payment Apps for Shopify:

AppWhen to use
Asaas BoletoFor stores that want to offer payment by bank slip
Asaas PixFor stores that want to offer instant payment by Pix
Asaas Credit CardFor stores that want to accept card payments, including installments

You can install only one payment method or install all apps to offer a more complete experience to the buyer.


Difference between the apps

Boleto

The Asaas Boleto app should be used when the store wants to make bank slip available at checkout.

After selecting this option, the buyer is redirected to the Asaas invoice, where they can copy the payment line or download the boleto.

In some scenarios, the invoice may also allow payment via Pix, as long as the Asaas account has a registered Pix key.

Pix

The Asaas Pix app should be used when the store wants to offer payment by Pix at checkout.

After selecting this option, the buyer is redirected to the Asaas invoice to make the payment. After confirmation, the order is updated according to the Shopify flow.

❗️

Attention

To use Pix on Shopify, it is necessary to have a Pix key registered in the Asaas account.

If the account does not have a registered Pix key, payment confirmation may occur late, impacting order confirmation on Shopify.

Credit Card

The Asaas Credit Card app should be used when the store wants to accept card payments directly at the Shopify checkout.

This option allows you to configure installments, the maximum number of installments, and the minimum amount per installment.

For credit card payment to work correctly, the store must be configured so that the customer contact method is exclusively by email.


General integration flow

The configuration flow for Asaas Apps on Shopify usually follows the steps below:

Choose the desired payment method
↓
Install the corresponding app on Shopify
↓
Enter the Asaas API key
↓
Configure the Production or Sandbox environment
↓
Adjust the app-specific settings
↓
Activate the app on Shopify
↓
Make a test purchase
↓
Make the payment method available at checkout

Each app has its own settings, detailed on the specific Boleto, Pix, and Credit Card pages.


Important configuration information

During the installation of Asaas Apps, some data and settings are essential for the integration to work correctly.

ConfigurationFunction
Production API KeyRequired to process real transactions
Sandbox API KeyOptional, used for testing
Test modeDefines whether the app will use Production or Sandbox
Pix keyRequired for Pix to work properly
Customer contact methodFor credit card, it must be configured as email
InstallmentsDefines the maximum number of installments and the minimum amount per installment in the Credit Card app
🚧

Attention

The API key is displayed only once at the time of creation.

Store the key in a secure location. If it is lost, it will be necessary to generate a new key.


Production and Sandbox

During app configuration, it is mandatory to enter the Production API key.

The Sandbox key is optional and should be entered only when the store wants to run tests before operating with real transactions.

The environment used depends on the Test mode configuration in the app:

ConfigurationBehavior
Test mode disabledTransactions use the Production key
Test mode enabledTransactions use the Sandbox key

Before activating the operation in Production, it is recommended to make a test purchase to validate the complete flow.


Expected behaviors

After installing and activating the apps:

  • the enabled payment methods are displayed at the Shopify checkout;
  • payments are processed by Asaas;
  • the order status is updated according to payment confirmation;
  • refunds and reversals can be performed according to the payment method used and the flow available in the store panel or in Asaas;
  • changes to app settings affect only new purchases made after the update.

Operational impacts

The configuration of Asaas Apps can directly impact the store’s order flow.

Incorrect settings may cause:

  • absence of the payment method at checkout;
  • improper use of the Production or Sandbox environment;
  • failure in test transactions;
  • display of fewer installments than expected;
  • delay in confirming orders paid via Pix, if there is no registered Pix key.

Therefore, changes to keys, environment, installments, or payment methods should be validated before periods of high sales volume.


Best practices

When configuring the integration between Asaas and Shopify, it is recommended to:

  • install only the apps for the payment methods that will be used by the store;
  • create an identifiable API key for each installed app;
  • store API keys in a secure location;
  • validate whether Test mode is consistent with the configured key;
  • register a Pix key before activating Pix in the store;
  • review installment settings before activating credit card;
  • make a test purchase after any relevant change.

Related content

To check the complete step-by-step guide for each payment method, access:



Did this page help you?