Adyen provides a LINK cartridge to integrate with Salesforce Commerce Cloud (SFCC). This cartridge enables an SFCC storefront to use the Adyen payment service.
For general inquiries related to this repository, developers are welcome to leverage 
Navigate to Adyen Docs to read about how to:
- 1. Install the cartridge,
- 2. How to add Adyen Settings page (src/bm_adyen) into SFCC Business Manager for easy payments set-up,
- 3. Set-up Adyen Cartridge,
- 4. Configure Adyen Payments,
- 5. How to Customise the cartridge, Front-end and Payment methods,
- 6. See a full list of Supported Payment Methods,
- 7. Upgrade your Adyen cartridge,
- 8. Apple Pay configuration using Adyen certificate or own certificate via Salesforce Apple Pay cartridge. We recommend using Apple pay with Adyen certificate as Adyen has no insight into Salesforce Apple Pay cartridge.
Adyen provides specialized cartridge support for 2 years for major versions, following the SFCC B2C Support policy, along with permanent Adyen support. Navigate to your Adyen Customer Area Merchant Account to raise a support case. When a major cartridge version is no longer under cartridge support, it will be treated as a custom merchant integration.
Best practice!
- Modularizing customizations is the recommended approach, as outlined by Salesforce.
- To customize Adyen payments, create a custom cartridge in your project directory or leverage
int_custom_cartridge, which is already set up in our repository. - For more guidance on customization, refer to Adyen Customization Guide.
Not Recommended
- We strongly discourage adding changes directly to Adyen code in /src/cartridges.
- Customizations made in Adyen default code cannot be easily separated from your codebase once deployed to production, leading to a more complex and costly upgrade process and reduced Support.
- SFRA version 5.x.x, 6.x.x. & 7.x.x.: Supported in all cartridge versions, see the latest
- We have a separate repository for Adyen SFCC PWA (Composable Storefront) payment integration.
This cartridge allows you to integrate with Adyen without the need for any development work from your end.
- Online payments are processed on the back-end using the Checkout API, and on the client side, Adyen’s Web Components are used to render payment methods.
- Point of Sale (POS) payments are processed using a cloud-based Terminal API.
Some files in the /src directory contain modern JavaScript (ES6) that Salesforce Commerce Cloud does not natively support. If you want to make ES6 code compatible with ES5 by transpiling, compiling, and uploading the auto-generated code to the /cartridges directory, see more in our Docs.
It is required to have an Adyen TEST and, later, LIVE account to use the cartridge. You can set it up here or contact Adyen.
End-to-End tests can be found in the adyen-salesforce-commerce-cloud/tests/e2e directory.
They are run automatically via Github Actions using the E2E.yml workflow.
To run the tests locally use the following command:
`npm run test:e2e`
Note: Please make sure to fill in the environment variables in the fixtures directory before running the tests locally.
As for Unit tests, they are currently only available for SFRA. Test files can be found next to the files they are testing. Mocks are kept in the jest directory.
To run SFRA unit tests locally use the following command:
`npm run test`
We strongly encourage you to join us in contributing to this repository so everyone can benefit from:
- New features and functionality
- Resolved bug fixes and issues
- Any general improvements
Read our contribution guidelines to find out how.
Read more information about the Adyen platform.
MIT license see LICENSE.