Adobe Commerce (REST

Product overview

Adobe Commerce creates engaging shopping moments that integrate both digital and physical experiences, with a leading commerce solution for merchants and brands. Adobe Commerce is a unified commerce solution that lets you manage all content and products in one place, whether you own more than one brand, sell in several countries, or use different business models.

With Adobe Commerce and Cybersource, you gain access to simple and secure payments and fraud management solutions, in 190+ countries and territories.

Compatible with Magento Open Source (CE) : 2.4+
Compatible with Adobe Commerce on prem (EE) : 2.4+
Compatible with Adobe Commerce on Cloud (ECE) : 2.4+

This integration is developed and tested using the default Luma theme for Magento.
The Hyvä theme is compatible, but Hyvä Checkout is not supported.

PHP Compatibility – 8.1+

Integration Features:
- REST API
- Unified Checkout
- 3DSecure
Channels:
- eComm (CNP)
- In-App
Payment Methods:
- Visa
- MasterCard
- Maestro
- American Express
- Discover
- Diners
- Google Pay
- Apple Pay
- Click to Pay
Payment Functions:
- Authorisation
- Capture
- Sale
- Void
- Full Refund
- Partial Refund
- Full Reversal
- Follow-on Credit
- Token Management Services (CIT only)
Fraud Management:
- Decision Manager

Getting started

Adobe Prerequisites

In order to use the Visa Acceptance Solutions Extension for Magento with your Cybersource account, please make sure you have a working instance of Magento.

View the Adobe Commerce Installation Guide and Flow here - Installation flow | Adobe Commerce Developer Guide (magento.com)
Set up a Magento Commerce Account - Creating a Commerce Account | Adobe Commerce 2.4 User Guide (magento.com)
Log Into the Market Place (ensure you have created an access key, for details please see Adobe support documentation here)

Cybersource Prerequisites

You will be able to configure this integration to either Test or Production. If you do not yet have a live Cybersource account, or you wish to first test the integration, then creating a sandbox account will not only allow you to start programmatic integration but also provides access to the Merchant Portal.

Enable Unified Checkout

Sign into your Cybersource Merchant Portal (Live) or (Test)
Configure your account's Unified Checkout settings, as detailed in the Unified Checkout documentation.

Generate REST Keys

Sign into your Merchant Portal (Live) or (Test)
Access Payment Configuration -> Key Management
Select the 'Generate Key' button in the top right hand corner
Select your key type as 'REST - Shared Secret' and Generate Key
Copy your Shared Secret Key values and save them securely

Obtain the extension

In the Magento Marketplace. search for 'Cybersource Payment Management Platform' to locate the extension or follow the direct link.
Select your Magento 'Edition' & 'Store version' i.e. 'Commerce on Cloud' and '2.4'
Add your selection to cart.*
Complete checkout*

Upon completion of the checkout, obtain the access keys by navigating to My Profile -> My Products -> Access Keys and copy keys.

*n.b. Although you're required to go through a checkout process the extension is free of charge and no card details are required to be saved within you Magento Marketplace account

Prepare you Magento Environment

Copy your Public and Private Keys into your Magento instance:

Go to My Profile -> My Products -> Access Keys
Select the Cyber Source extension line
Copy both the Public and Private Keys
In your Magento instance rename auth.json.sample file to auth.json in the Magento root directory on your server, and enter the access keys from steps above.
Add the following code text to the auth.json file

                {
     "http-basic":{
        "repo.magento.com": {
            "username": "Your_Public_Key",
            "password": "Your_Private_key"
        }
    }
}

Download the Extension

Now that you've prepared the environment you just need to import the code base through Composer. In order to do this run the following commands:

Import the extension code:

                composer require cybersource/module-payment:25.2.0

Commit the updated files:

                git add composer.json composer.lock
git commit -m "Add Cybersource Payment module"
git push

Enable Module:

                php bin/magento app:config:dump

Commit the updated configuration file:

                git add app/etc/config.php
git commit -m "Enable Cybersource Payment module"
git push

Run the following commands in your environment:

                composer require cybersource/module-payment:25.2.0
php bin/magento module:enable CyberSource_Payment
php bin/magento setup:di:compile
php bin/magento indexer:reindex
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy -f
php bin/magento cache:clean
php bin/magento cache:flush
php bin/magento module:status

Initial Configuration

For in-depth guide on configuring the Extension please refer to the wider Documentation.

To configure the Visa Acceptance Solutions extension, you need to login into the administration section of your Adobe Commerce website. The configuration panel can be accessed by navigating to the following screen:

Stores > Configuration > Sales > Payment Methods

On the Payment Methods screen, you will see the settings to configure the Visa Acceptance Solutions extension.

General Settings

Environment: (Test/Production)
Merchant ID: ( your Cyber Source Organization ID)
API key: (Created in Step 1)
API Shared Secret key: (Created in Step 1)
Accepted Card Types: Select the card brands you want to accept.

Debug Mode

Enable to store detailed logs. This is only recommended for Test environment, or troubleshooting Production issues.

Message Level Encryption

This is a security enhancement that is being introduced to Cybersource. Please reach out to Support to confirm if this is enabled for your merchant account.

Secure Payment Methods

Enable: Select “Yes” to enable the Visa Acceptance Solutions extension.
Title: The text saved here is displayed to Customers as the name of payment method
Payment Action: Set to either Authorize or Capture to authorize and capture respectively during customer checkout.
Payment Card Types: Select accepted payment card brands.
Allowed Payment Methods: Choose payment methods through which customer can complete their order.
Select Layout: Select Embedded or Side bar as layout to display the Unified Checkout payment widget.
Payment from Applicable Countries: By selecting ‘All Allowed’ Countries option, payment method is aligned with the Adobe Commerce global settings for Customer’s Country. Whereas if set to ‘Specific Countries’ option, Merchant can set the allowed Countries for the Customer.
Payer Authentication / 3D Secure: By enabling this option, it adds an additional layer of security to the payments by authenticating customer’s identities before their payments are authorized.
Tokenisation: If this setting is enabled, customer can save the cards for future payments.
Tokenization Title: This text will specify the title of saved cards payment method.
Saved Card Verification: An option is provided to process saved card transaction with or without CVV.
Enforce Strong Customer Authentication: if enabled, the cardholder will be 3DS challenged when saving a card.

Product overview

Getting started

Further Information