VTEX

Instructions

1. Access Ecart Pay and navigate to the "Integrations" section. Here, you will find all supported e-commerce platforms. Select the VTEX option to initiate the integration setup process.

2. You will be redirected to the OAuth page to integrate your store. Since you are integrating with VTEX, select that option.
   Important Note: VTEX can only be integrated using OAuth.

3. After selecting VTEX as your e-commerce platform, scroll to the bottom of the page and enter your store's URL.

4. After adding the URL, you will be redirected to your VTEX store's configuration page. Here, you must enter your account name, App Key, and App Token.
   Note: You must generate the App Key and App Token in VTEX for the correct installation of Ecart Pay. Click on "Click here" for more details on generating these keys in VTEX.

• 4.1. To generate the App Key and App Token in VTEX, go to your store's control panel. At the top, you will see your profile (represented by the first letter of your registered email). Click on Account Settings and then select API Keys.

• 4.2. Click the "Generate Key" button.

• 4.3: Assign a name to your new key and set the permissions. (Recommendation: Use owner - super admin). Click "Generate".
  Note: The App Key appears at the top, and the App Token at the bottom. Once this window is closed, the App Key cannot be retrieved unless a new one is generated.

5. After filling in your VTEX store details, you will be redirected to the Ecart Pay page, where you must either create an account (if you don’t have one) or log in to your existing Ecart Pay account.

6. Once logged into your Ecart Pay account, you will be redirected to the integration configuration page. Here, you must confirm linking your Ecart Pay account with your VTEX store. If you want to link a different account, select the "Use another account" option.

7. After linking your Ecart Pay account with your VTEX store, you will be redirected to the VTEX dashboard under the "Payment Provider Configuration" section. Here, you must configure your Ecart Pay account’s private keys (explained in Step 8). The App Key is the Public Key of your Ecart Pay account, and the App Token is the Private Key of your account. You can also select your payment provider's environment. To test payments, enable the Sandbox Mode in Ecart Pay.

8. To obtain your credentials for configuring the connector in VTEX, log into your Ecart Pay account and navigate to Integrations/API. Here, you can copy your Public Key and Private Key.

9. After configuring the "Ecart Pay" Payment Provider in VTEX, an alert will notify you that the integration requires the installation of the connector for proper functionality. Click "Install App."

10. Install the Ecart Pay connector to ensure the proper operation of the VTEX Payment Provider.

11. After installing the Ecart Pay connector, go to Store Settings > Payment > Settings and add a new payment method for your VTEX store.

12. Search for Ecart Pay as a payment method option.

13. After activating the Ecart Pay payment method and selecting Ecart Pay as the Payment Provider, save the configuration. This configuration should be reflected within 10 minutes in your VTEX store checkout.

14. After saving your configuration, the Ecart Pay payment method will appear in your store’s payment options.

15. Once the payment method is configured, it will be available in your VTEX store’s checkout. Select Buy Now to process your order with Ecart Pay.

16. After selecting Buy Now, you will be redirected to the Ecart Pay checkout, where your order details will be displayed. Enter your card details to process the payment via Ecart Pay.

17. Once the transaction is completed, you will be redirected to your VTEX store, where the order confirmation page will be displayed.

By following these steps, you will successfully integrate Ecart Pay with your VTEX store, ensuring a smooth and secure payment process for your customers. This integration simplifies order management and enhances the overall shopping experience on your platform.