Using our VTEX plugin doesn't require downloading additional software or complicated installation. Before moving on to plugin configuration, make sure you have the following:
- VTEX account (manage the entire digital commerce experience in one place via Admin tool)
- Worldline account (please get in touch with us to set it up)
Plugin configuration
Step 1: Access the VTEX Admin panel
Step 2: Go to Payments > Settings
Step 3: In Gateway Affiliations, click on the green + button
Step 4: Scroll down and search for the worldline.globalcollect connector, click on it
Step 5: By completing the previous step, our app will be automatically installed
Step 6: You'll get the following screen, that needs to be adjusted:
Step 7: Fill out the fields with the provided information below:
| VTEX | Our platform | Mandatory |
|---|---|---|
| Application key | API key ID of the correct environment (Sandbox, Pre-Production or Production). You can find this information in our Configuration Center. | Yes |
| Application token | API key ID of the correct environment (Sandbox, Pre-Production or Production). You can find this information in our Configuration Center. | Yes |
| Capture type | Depending on how you'd like to capture the transaction, you can choose direct or delayed capture type | Yes |
| Environment | The environment you'd like to use (note that this defines our Worldline endpoints) | Yes |
| Merchant ID | Your Worldline merchant ID (you can find this information in the our Configuration Center). | Yes |
| Payment subdomain | Only applicable if you use MyCheckout hosted payment pages. Add your desired payment sub-domain. | Yes in case of MyCheckout hosted payment pages |
| Webhook key ID | Key ID under Webhooks keys of the correct environment (Sandbox, Pre-Production or Production). You can find this information in our Configuration Center. | No, only applicable if you're using Webhooks with us |
| Webhook secret key | Secret key under Webhooks keys of the correct environment (Sandbox, Pre-Production or Production). You can find this information in our Configuration Center. | No, only applicable if you're using Webhooks with us |