📢 Use this project, contribute to it or open issues to help evolve it using Store Discussion.

Adyen

This app integrates Adyen with VTEX checkout.

Configuration

Adyen Setup

Before you can configure the VTEX Adyen connector, you will need to do the following setup in your Adyen merchant account:

1. Generate Web Service API credentials.
   • Under the Developers tab, select API credentials
   • Select Webservice
   • Keep Username and Password somewhere safe
   • Generate a new API Key and store it somewhere safe. This can be regenerated if lost
2. (Do Only Once) Send an email to Adyen support ([email protected]), requesting the permissions listed in the model below:
   • Subject: Setting VTEX web-service user permissions for {accountName}
   • Email Body: Adyen Support, I send this email to ask you to grant the necessary permissions to the user [email protected] so that it can be used on the VTEX platform. Thank you in advance!
3. In Merchant Settings, update the Capture Delay option to manual. This allows VTEX to handle payment capture timing.
4. Create a Standard Notification Webhook
   • Use https://{accountName}.myvtex.com/_v/api/connector-adyen/v0/hook for the URL
     • Example: https://mysampleshop.myvtex.com/_v/api/connector-adyen/v0/hook
   • Make sure Service Version is 1
   • Make sure the webhook is marked as active
   • Make sure Method is set to JSON
   • Create a username and password of your choice for the webhook events

Installing the App

1. Install this app in the desired account using the CLI command vtex install vtex.connector-adyen.
2. In your admin sidebar, search for Payments and select Settings under the Payments tab.
3. Click the Gateway Affiliations tab and click the green plus sign to add a new affiliation.
4. Select Adyen Payments from the Others list.
5. Modify the Affiliation name if desired, choose an Auto Settlement behavior from the dropdown and then click Save. Leave Application Key and Application Token blank.
6. Click the Payment Conditions tab and click the green plus sign to add a new payment condition.
7. From the Credit Card list, click the card type you want to process using Adyen.
8. In the Process with affiliation dropdown, choose Adyen Payments or the name of the affiliation that you created in step 6. Set the status to Active and click Save. Note that this will activate the payment method in checkout!
9. Repeat steps 8 and 9 for each credit type to be processed with Adyen.
10. In your admin sidebar, search for Adyen. This will bring you to the Adyen admin panel to configure the app settings.
11. Complete the settings with the values from your Adyen setup, following the guide below.

App Configurations

⚠️ Only users with access to the Payments section in the VTEX admin (or assigned the PCI Gateway role in License Manager) will be able to configure the app.

1. Adyen Merchant Account is the merchant account name.
   • Note: This is not the company name.
2. Adyen API Key is the API key that is generated in Step 1 of Adyen Setup
3. Adyen Production API URI is the Checkout API's URI.
   • This can be found in the Developer > API URLs tab in Adyen.
   • Example: http://checkout-test.adyen.com
   • Note: Please use http instead of https
4. Adyen Webhook Username and Adyen Webhook Password is the Username/Password created in Step 4 of Adyen Setup
5. VTEX App Key/App Token should be a VTEX application key that has the Super Admin role in your account and its associated token. Reference this documentation for app key generation and configuration.

• If you are running Adyen in a marketplace, make sure to grant this application key the same Super Admin role on all seller accounts as well. In other words, create the application key on the marketplace account, then go to the Application Keys admin panel on each seller account and click + Add to grant the key permissions for that account.

Contributors ✨

Thanks goes to these wonderful people:

This project follows the all-contributors specification. Contributions of any kind are welcome!