Stripe is a payment platform that offers an integrated system for receiving payments, transfers, donations, and any typical financial transaction in ecommerce and other websites.
You can integrate your store with Stripe via Application Key and Application Token. To obtain this data, you have to create your account on the platform and then access Stripe’s documentation to get your Public key and Secret key. They are required for the setup in the VTEX environment.
Stripe supports payments in over 40 countries. The list of available countries can be accessed on the Stripe website.
To process your payments with Stripe, you must:
Configuring the Stripe connector
After installing the Stripe connector, follow the steps below to configure it on the VTEX platform.
- In the VTEX Admin, go to Store Settings > Payment > Providers, or type Providers in the search bar at the top of the page.
- On the providers screen, click the
New Provider
button. - Type the name StripeConnector in the search bar and click on the name of the provider.
- Fill in the fields below with the following information:
- App key: Publishable key available in your Stripe dashboard.
- App token: Secret Key available in your Stripe dashboard.
- Click on Save.
After configuration in the VTEX environment, you also need to configure Webhook in your Stripe account.
- Go to your Stripe account dashboard.
- Click on the Developers button.
- Click on the Webhooks tab.
- Click on Add an endpoint.
- In the Endpoint URL field, add your VTEX store’s endpoint URL in the format
https://{account-name}.myvtex.com/_v/notifications
replacing{account-name}
with your VTEX account name. - Click on + Select events.
- Click on the categories and select the desired events. If you are not sure which events to add, please contact Stripe support and they can help you with this type of configuration.
- Click on Add events.
- Click on Add endpoint.
If you wish to carry out credit card transactions on Stripe, you must open a ticket on Stripe as follows: - Request the release of the "raw card data" function, indicating that VTEX and Stripe are payment partners. - Please attach the VTEX AOC (Attestation of Compliance for Onsite Assessments – Service Providers). To check the latest version of AOC VTEX, access the VTEX certifications page and download the file available in the PCI section. The above actions will prevent errors related to the transmission of sensitive data from occurring in the integration between Stripe and VTEX.
Configuring a payment condition
Once you have completed the steps above, Stripe will be ready to be used in your store. It will be available in the Process with affiliation field — provided that the payment method is compatible with Stripe — when creating a payment condition.
Learn more in the article Configuring payment conditions.
Configuring Google Pay
The Stripe connector allows you to add Google Pay as a payment method in your store's checkout. Once the Stripe connector is configured, you can add Google Pay by following the steps below.
- In the VTEX Admin, go to Store Settings > Payment > Settings, or type Settings in the search bar at the top of the page.
- In the Payment conditions tab, click on
+
. - Click on the Google Pay option.
- Activate the condition in the Status field.
- In Process with affiliation, select the StripeConnector option.
- Click on Save.
After this configuration, Google Pay will be displayed as one of the available payment methods in your store’s checkout.
Configuring Apple Pay
The Stripe connector allows you to add Apple Pay as a payment method in your store's checkout.
Apple Pay currently only works on MacOs and IOS operating systems, and with Safari browser. For more information, visit Devices compatible with Apple Pay.
Once the Stripe connector is configured, you can add Apple Pay by following the steps below.
- Go to your Stripe account dashboard in the payments setup section.
- In Settings, click on Payment Methods.
- Click on Apple Pay > Configure and then Add to new domain.
- Enter the public domain of your store's website.
- Click on Donwload verification file to save it to your device.
- Create the credentials appkey and apptoken.
- Make a call to the endpoint to send the previously downloaded verification file, adding the created credentials and your public domain address in the header (https://{{dominioPublicodoSite}}/well-known/raw/apple-developer-merchantid-domain-association).
- Click on Add.
- Access the Admin VTEX.
- Click on Payments.
- Then, click on Settings.
- In the Payment conditions, click on the
+
button. - Click on Apple Pay.
- Fill the Rule Name field with a name of your choice for identification.
- Activate the condition in the Status field.
- In the Process with affiliation field, select the Stripe option.
- If you have an anti-fraud set up in your store, you can enable it for that payment condition by checking the Use anti-fraud solution box.
- Choose whether payments will be with or without installments.
- It you want, you can also configure special payment conditions.
- Click on Save.
After this configuration, Apple Pay will be displayed as one of the available payment methods in your store’s checkout.