FAQ - Shopify
This section gathers the main questions about the Asaas and Shopify integration, aiming to support the configuration and proper use of the solution.
This FAQ brings together frequently asked questions about the integration between Asaas and Shopify, focusing on the configuration of Payment Apps, checkout behavior, use of Production and Sandbox environments, operational adjustments after installation, and precautions to avoid failures in order processing.
Shopify allows merchants to create and manage online stores, while Asaas Apps allow sales to be processed by Bank Slip, Pix, and Credit Card directly in the store’s purchase flow.
Each payment method has its own app and can be installed individually, according to the needs of the operation.
When to use this FAQ
Use this page when you need to clarify questions about:
- configuration of Asaas Apps on Shopify;
- installment adjustment on Credit Card;
- use of Production and Sandbox;
- requirements for the correct operation of the checkout;
- installation of the Bank Slip, Pix, and Credit Card apps;
- use of the same Asaas account in more than one Shopify store;
- impact of the settings on checkout and order confirmation;
- precautions after changes to keys, environment, or payment methods.
For the complete step-by-step installation guide for each app, also see the specific Shopify pages in the documentation.
Important integration rules
Before configuring Asaas Apps on Shopify, consider that:
- each payment method has its own app;
- the Production API key is mandatory in the app configuration;
- the Sandbox API key is optional and should be used only for testing;
- the environment used depends on the Test mode configuration in the app;
- for payments via Pix, it is necessary to have a Pix key registered in the Asaas account;
- for Credit Card payments, the store must be configured so that the customer contact method is exclusively by email;
- changes to settings affect only new purchases made after the update;
- refunds and reversals must be monitored in the Shopify panel and in the Asaas account to ensure correct reconciliation.
Important settings and parameters
During the installation and maintenance of Asaas Apps on Shopify, some settings directly impact the behavior of the integration:
| Setting | Purpose |
|---|---|
| Production API Key | Allows real transactions to be processed in the Asaas account |
| Sandbox API Key | Allows tests to be performed before operating in Production |
| Test mode | Defines whether the app will use Production or Sandbox |
| Pix key | Required for Pix to work properly |
| Customer contact method | For Credit Card, it must be configured only as email |
| Maximum number of installments | Defines the installment limit displayed at checkout |
| Minimum amount per installment | May limit the number of installments available to the buyer |
| Installed apps | Determine which payment methods will be displayed at checkout |
AttentionBefore activating the operation in Production, make a test purchase to validate whether the payment method appears correctly at checkout and whether the order is updated after payment confirmation.
1. Is it possible to adjust the number of installments on the card?
Yes. The adjustment can be made directly in the Credit Card App inside Shopify.
Path:
- Settings > Apps > Credit Card – Asaas
- Open the app
- Adjust the installment settings
- Save the changes
This screen is the same one displayed during the app installation and allows you to configure:
- maximum number of installments;
- minimum amount per installment.
The number of installments displayed to the buyer will be calculated automatically based on these settings and on the total purchase amount.
ExampleIf the store configures installments in up to 12x, but defines a minimum amount per installment, the checkout will display only the options that comply with this minimum amount.
Therefore, a low-value purchase may display fewer installments than the configured maximum limit.
2. Does changing the installment settings affect payments already made?
No. Changing the installment rules affects only new purchases made after the configuration update.
Payments already completed, orders already created, and charges already processed are not automatically recalculated.
ImportantAfter changing the installment settings, it is recommended to make a test purchase to validate how the options will be displayed at the Shopify checkout.
3. What precautions should I take when configuring installments?
Before defining the maximum number of installments and the minimum amount per installment, evaluate:
- the store’s average ticket;
- the operation’s commercial policy;
- the impact of installments on conversion;
- the minimum acceptable amount per installment;
- the expected checkout experience;
- the financial cost of the operation;
- the commercial communication displayed to the buyer.
Avoid configuring a very high minimum amount per installment, as this may reduce the number of options displayed to the buyer.
Also avoid configuring a very low minimum amount without evaluating the financial impacts of the operation.
4. Why are fewer installments displayed than the configured limit?
The number of installments displayed at checkout depends on the combination of:
- total purchase amount;
- configured maximum number of installments;
- minimum amount per installment defined in the app.
For example, if the store allows up to 12 installments, but the purchase amount is low, the checkout may display fewer options to comply with the minimum amount per installment.
This behavior is expected and does not represent a failure in the app.
5. Is it possible to use a single Asaas account in more than one Shopify store?
Yes. The same Asaas account can be used to integrate more than one Shopify store.
In this scenario, each store must have its Asaas Apps installed and configured individually.
ImportantEven when using the same Asaas account, the settings for each Shopify store must be performed separately.
This includes app installation, API keys, environment used, installment settings, and specific settings for each payment method.
6. Does each payment method need its own app?
Yes. Asaas provides separate apps for each payment method on Shopify:
- Bank Slip App;
- Pix App;
- Credit Card App.
You can install only the desired payment method or install all apps to offer a more complete checkout experience.
7. Can I install only one payment app?
Yes. Each app can be installed individually.
For example, the store can choose to offer only Pix, only Credit Card, only Bank Slip, or combine all three payment methods.
The payment method will be displayed at checkout only when the corresponding app is installed, configured, and active.
8. Is it mandatory to enter a Production API key?
Yes. During the configuration of Asaas Apps on Shopify, 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 in production.
AttentionThe 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.
9. Can I use the same API key for all apps?
It is possible to use the same API key, as long as it belongs to the correct Asaas account and is valid.
However, to make identification and maintenance of the integration easier, it is recommended to create identifiable keys for each installed app.
Examples:
Shopify Bank Slip API Key
Shopify Pix API Key
Shopify Credit Card API KeyThis practice helps track which credential is being used in each payment method.
10. How does the Production and Sandbox environment work?
The environment used depends on the Test mode configuration in the Shopify payment app.
- Test mode disabled: transactions use the Production key.
- Test mode enabled: transactions use the Sandbox key.
To process test transactions, it is necessary to:
- enter the Sandbox API key in the app;
- enable Test mode in the payment settings.
ImportantIf Test mode is enabled, but the Sandbox key has not been entered correctly, test transactions may fail.
11. Does changing Test mode affect orders already created?
No. Changing Test mode affects only new transactions made after the change.
Orders already created or payments already processed are not automatically migrated between environments.
Therefore, before starting the store’s real operation, confirm that the app has Test mode disabled and is using the correct Production key.
12. Is it necessary to configure the customer contact method?
Yes. For the correct operation of payment with Credit Card, the store must be configured so that the customer contact method is exclusively by email.
Path:
- Settings > Checkout > Customer contact method
- Select only Email
This setting avoids inconsistencies in the payment flow and ensures that the necessary data is sent correctly during checkout.
AttentionIf the store allows other contact methods besides email, Credit Card payment may present inconsistencies during checkout.
13. Do I need to have a Pix key registered to use Pix on Shopify?
Yes. To make Pix available on Shopify, it is necessary to have a Pix key registered in the Asaas account.
Registration can be performed in the Asaas panel at:
- Pix > My Keys
AttentionIf the account does not have a registered Pix key, charge settlement may occur late, impacting order confirmation on Shopify.
14. Does payment by Pix automatically confirm the order?
Yes. After payment confirmation via Pix, the order should be updated according to the Shopify flow and the integration with Asaas.
However, if the account does not have a registered Pix key or there is a delay in settlement, order confirmation may be impacted.
Therefore, before activating Pix in the store, validate:
- whether the Pix key is registered;
- whether the Pix app is active;
- whether the API key is correct;
- whether the configured environment is the expected one;
- whether a test purchase updates the order correctly.
15. Can Bank Slip display a Pix payment option?
In some scenarios, the Asaas invoice generated from payment by Bank Slip may also allow payment via Pix, as long as the Asaas account has a registered Pix key.
This behavior can speed up payment confirmation, as the customer can choose to pay the invoice using Pix.
ImportantIf the store’s intention is to offer Pix directly at the Shopify checkout, also use the Asaas Pix App.
16. Does Asaas support refunds and reversals on Shopify?
Yes. Asaas Apps for Shopify support refunds and reversals, according to the payment method used and the flow available in the store panel or in Asaas.
After performing a reversal or refund, it is recommended to monitor the status in the Shopify panel and in the Asaas account to ensure that the order reconciliation is correct.
17. Are reversals and refunds completed immediately?
It depends on the payment method used and the processing flow.
Some payment methods may have faster processing, while others depend on banking deadlines, validations, or additional steps.
The integration must monitor the order status in Shopify and the charge status in Asaas before considering the reconciliation completed.
18. Why does a payment method not appear at checkout?
The absence of a payment method at checkout can occur for different reasons, such as:
- corresponding app not installed;
- app installed, but not activated;
- invalid or missing API key;
- environment configured incorrectly;
- Test mode incompatible with the entered key;
- required configuration pending;
- inconsistency in Shopify settings.
In these cases, review the app installation, configured keys, selected environment, and specific settings of the payment method.
19. Can I change the app settings at any time?
Yes. App settings can be changed after installation.
However, changes to keys, environment, installments, or payment methods should be tested before periods of high sales volume.
These changes affect only new purchases made after the update.
20. What should I validate after installing or changing an app?
After installing or changing any Asaas App on Shopify, it is recommended to validate:
- whether the payment method appears at checkout;
- whether the API key is correct;
- whether the configured environment is the expected one;
- whether Test mode is consistent with the key used;
- whether the order is created correctly;
- whether the payment is confirmed;
- whether the order is updated in Shopify;
- whether refunds or reversals follow the expected behavior;
- whether installments appear according to the configuration, in the case of Credit Card.
Configuration best practices
After installing or changing any Asaas App on Shopify, it is recommended to:
- check whether the API key was entered in the correct environment;
- validate whether Test mode is consistent with the key used;
- make a test purchase before activating the operation in production;
- review the Credit Card installment settings;
- confirm whether the Pix key is registered, if using Pix;
- validate whether the checkout correctly displays the desired payment methods;
- avoid changes during campaigns or periods of high volume;
- store API keys in a secure location;
- internally document which apps are installed and which keys are used.
Common errors
Some common problems in the integration between Asaas and Shopify include:
| Situation | Possible cause |
|---|---|
| Payment method does not appear at checkout | App not activated, pending configuration, or invalid key |
| Test transaction fails | Test mode incompatible with the configured key |
| Pix does not confirm correctly | Account without a registered Pix key or late settlement |
| Credit Card presents inconsistency | Customer contact method different from email only |
| Fewer installments than expected | Minimum amount per installment restricting the options |
| Order does not update after payment | Synchronization delay or failure in the confirmation flow |
| Difficulty reconciling refund | Status not yet updated in Shopify or Asaas |
Operational impacts
Changes to the settings of Asaas Apps can directly impact the customer’s purchase experience.
Incorrect settings may cause:
- absence of the payment method at checkout;
- display of fewer installments than expected;
- failures in test transactions;
- improper use of the Production or Sandbox environment;
- delay in confirming orders paid via Pix, if there is no registered Pix key;
- inconsistencies in Credit Card processing;
- divergence between the order status in Shopify and the charge in Asaas;
- need for manual customer support.
Therefore, any change must be validated before periods of high sales volume or commercial campaigns.
Related content
See also:
- Shopify;
- Bank Slip App on Shopify;
- Pix App on Shopify;
- Credit Card App on Shopify;
- General settings of the Asaas + Shopify integration;
- Reversals;
- Payment Split, when applicable to the operation.
