commercetools-adyen-integration

commercetools-adyen-integration provides an Adyen Web Components based integration between the commercetools and Adyen PSP.

• Supported features
• Supported payment methods
• Overview
  • Extension module
  • Notification module
• Other guides

Supported features

• Adyen Web Component based payment methods. For full list of payment methods that have been tested for CommerceTools integration please refer to supported payment methods section of this document.
  • Note: since the integration relies on the usage of Adyen's web components it does not need to process sensitive credit card data and thus is fully PCI DSS compliant.
• Asynchronous notifications handling via notification module.
• Multi-tenancy to serve multiple Adyen merchant accounts/commercetools projects with one application instance.
• Refunding a payment back to the shopper.
• Authorisation cancellation on a payment that has not yet been captured.
• Manual capture of a payment.
• Restore, which gives your shoppers an opportunity to offset their carbon emissions from the delivery or lifecycle of their purchase at checkout.
• Store payment and disable stored payment gives your shoppers the ability to store payments for later use and removing these stored payments.

Supported payment methods

When adding payment methods in the Adyen Customer Area, please ensure you refer to the Adyen links below, as some payment methods require additional configuration. If you need assistance configuring your payment methods please contact Adyen Support via your Customer Area.

Credit and debit cards

• Credit/debit cards

Buy Now Pay Later

• Klarna Pay Later
• Afterpay

Cash and ATM payment methods

• Multibanco

Online payments

• iDEAL
• Sofort (Online bank transfer)
• BLIK
• MobilePay
• Online banking Poland
• Klarna Pay now

Wallets

• PayPal
• Apple Pay
• Google Pay
• Bancontact
• Vipps
• Swish

Prepaid and gift cards

• Givex

Mobile

• TWINT

Overview

This repository contains two standalone modules that interact with commercetools and Adyen. Complete integration requires running both of the modules.

1. Front end uses Adyen Web Components to present required payment methods. The list of available payment methods can be also obtained through the integration with the help of get available payment methods request. On user interaction, frontend web-component generates JSON payloads for create payment sessions which has to be provided to commercetools payment as described here.
2. With help of the commercetools HTTP API Extensions provided data is sent to the Extension Module.
3. The Extension Module processes provided web component payload passed by the front end, exchanges it with Adyen API, and provides synchronous response back to the front end / commercetools caller. Based on result, the front end either creates an order or continues with further payment steps as described in the integration guide. Note that order/cart creations/modifications should be part of the front end business logic. commercetools-adyen-integration will neither change the cart nor the order.

In addition with help of Adyen notifications any payment status changes are asynchronously exchanged between Adyen and commercetools. Please follow the detailed guides below in order to integrate your front end with the Extension and Notification modules.

Extension module

The extension module is a publicly exposed service that acts as a middleware between the commercetools platform and Adyen. Once commercetools HTTP API Extensions is configured to call Adyen extension module, for every payment create or update request an Adyen extension will be remotely called by the commercetools platform.

• Follow Integration Guide for information how to integrate your shop with this module. For advanced integration flow follow the advanced integration guide.
• Follow How to run the extension module.

Notification module

Notification module is a publicly exposed service which receives asynchronous notifications sent by Adyen. Through notifications, Adyen provides asynchronously payment status changes like authorization, charge, or refund of the payment. The notification module will process the notification sent by Adyen and matches the commercetools payment for this notification, and modifies commercetools payment accordingly.

• Follow Integration Guide for information how to integrate with notification module.
• Follow How to run the notification module.

Other guides

• Follow the FAQ for the answers to frequently asked questions, such as order creation, deployment etc.
• Follow the Contribution Guide if you would like to run modules locally.