--- title: "Installation & configuration" canonical_url: https://docs.connect.worldline-solutions.com/documentation/Plugins/VTEX/installation-and-configuration --- 1. [Home](https://docs.connect.worldline-solutions.com/) 2. [Developer tools](https://docs.connect.worldline-solutions.com/documentation.md) 3. [Plugins](https://docs.connect.worldline-solutions.com/documentation/Plugins.md) 4. [VTEX](https://docs.connect.worldline-solutions.com/documentation/Plugins/VTEX.md) 5. Installation \& configuration We enhanced our VTEX plugin to support the Global Collect platform! Reach out to [our support team](https://worldline.com/en/home/solutions/online-payments/large-global-businesses.html) to kick off the integration. ## **Before you begin** The Worldline VTEX integration requires no installation. Ensure you have the following before starting the configuration: * **VTEX account**: Manage your digital commerce experience through the VTEX admin * **Worldline account and Configuration Center access**: Contact us to set up your account # Configuration 1. Access the VTEX admin panel 2. Go to **Store Settings** \> **Payment** \> **Providers** 3. In Providers, click on the blue **New Provider** button ![Menu overview, showing where to find the New Provider button on screen.](https://docs.connect.worldline-solutions.com/dA/462b0f3bf3/fileAsset/VTEX-Plugin-Installation-1.png) 1. Search for the **worldline.globalcollect** provider, and click on it. ![Seach bar, with the worldline.globalcollect provider](https://docs.connect.worldline-solutions.com/dA/1193908a3c/fileAsset/VTEX-Plugin-Installation-2.png) 1. Once the provider is added, the integration configuration page is opened. ![Seach bar, with the worldline.globalcollect provider](https://docs.connect.worldline-solutions.com/dA/bb7583e0db/fileAsset/VTEX-Plugin-Installation-3.png) ![Seach bar, with the worldline.globalcollect provider](https://docs.connect.worldline-solutions.com/dA/ddd87491a0/fileAsset/VTEX-Plugin-Installation-4.png) To access more information, go to your Configuration Center of the applicable environment ([sandbox](https://sandbox.account.ingenico.com/), [pre-production](https://account.preprod.connect.worldline-solutions.com/), [production](https://account.connect.worldline-solutions.com/)) and check the guides on how to use the [Configuration Center](https://docs.connect.worldline-solutions.com/documentation/configuration-center.md), and how to set up your [webhooks](https://docs.connect.worldline-solutions.com/documentation/webhooks/.md). | VTEX name | Worldline platform | |--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Provider Authorization** || | App key | API key ID of the correct environment (pre-production or production). You must copy this information from your Configuration Center. | | App token | Secret API key of the correct environment (pre-production or production). You must copy this information from your Configuration Center. | | **Basic Information** || | Name | Desired name to present for this provider. If you add multiple worldline.globalcollect providers, the name should be unique for each. | | **Payment Control** || | Enable test mode | Tick off, if you are testing payment options - when unticked, the options linked to this provider will be visible to customers in the store. | | **Provider Fields** || | Environment | The environment you'd like to use (note that this defines our Worldline endpoints of the specific environments pre-production or production) | | Merchant ID | Your Worldline merchant ID. You must copy this information from your Configuration Center. | | Webhook key ID | Key ID under Webhooks keys of the correct environment (pre-production or production). You must copy this information from your Configuration Center. | | Webhook secret key | Secret key under Webhooks keys of the correct environment (pre-production or production). You must copy this information from your Configuration Center. | | Capture type | You can choose either direct or delayed capture type. Direct - payments will automatically be captured and reported as paid when the capture is complete on the gateway (an invoice is created automatically) Delayed - there are two separate calls for Authorization and Capturing of the funds, meaning that the capture (or settlement of the funds) will take place at a later date than the authorization. | | Payment subdomain | Applicable for any payment products using [Defines which MyCheckout hosted payment pages subdomain you would like to use from the available options setup under your Worldline Configuration Center.](https://docs.connect.worldline-solutions.com/documentation/hosted-payment-pages/.md) | | 3DS mode | Enabled/Disabled. Please note that Worldline's 3DS provider has to be configured on our side to make it work, you can align with your integration manager during your account setup. | | Soft descriptor | Your desired descriptor passed on with the transactions. | 1. After the initial setup is done, the integration configuration page can be accessed through: Store Settings\> Payment\> Providers, where you can see and edit all fields. ![Showing the configured integration under VTEX Providers.](https://docs.connect.worldline-solutions.com/dA/2e6d8e687b/fileAsset/VTEX-Plugin-Installation-5.png) # Application configuration Once you install the application, the system automatically redirects you to the configuration page: | Property | Description | |-----------|------------------------------------------------------------------------------------------------------------| | App key | Enter the VTEX API key - mandatory to handle the Worldline actions. See below how to create this. (LINK) | | App token | Enter the VTEX API token - mandatory to handle the Worldline actions. See below how to create this. (LINK) | | Email | Enter the email address that will receive Worldline notifications. | ![Worldline application showing the app key, app token, and email fields.](https://docs.connect.worldline-solutions.com/dA/1d0747b074/fileAsset/VTEX-Plugin-App-1.png) ## Creating app key and token To generate the VTEX app key and token from your VTEX account, go to the **Account icon** \> **Account Settings** \> **API Keys Dashboard** and press the **"Generate Key"** button. ![Preseting the API Keys with Generate Key button.](https://docs.connect.worldline-solutions.com/dA/e220b2f36b/fileAsset/VTEX-Plugin-App-2.png) The system will display a popup where you can define a name for the key and assign a role. Ensure the selected role includes the following resources: | Product | Category | Resource | |-------------|-----------------------|------------------| | PCI Gateway | Payment-Make Payments | Process payments | ![The necessary resource can be configured under the Roles.](https://docs.connect.worldline-solutions.com/dA/10d5a2dd7f/fileAsset/VTEX-Plugin-App-3.png)