RELATED TO THIS PAGE

ON THIS PAGE

Product Overview

The Cyber source integration for commercetools enables merchants to connect commercetools with Cybersource payment, fraud, and payment security services, for global payment acceptance and secure checkout experiences within a composable commerce architecture.

Built on commercetools API Extensions, the integration supports flexible deployment models, including self-hosted and cloud-based implementations. Supporting libraries and sample service implementations are available, including a Spring Boot reference application.

  • Integration Features:
    • REST API
    • Unified Checkout
    • Microform
    • 3DSecure
  • Channels:
    • eComm (CNP)
    • MOTO
  • Payment Methods:
    • Visa
    • MasterCard
    • Maestro
    • American Express
    • Discover
    • Diners
    • Apple Pay
    • Google Pay
    • Click to Pay
    • Paypal (Express Checkout)
  • Payment Functions:
    • Authorisation
    • Capture
    • Sale
    • Void
    • Full Refund
    • Partial Refund
    • Full Reversal
    • Follow on Credit
    • Standalone Credit
    • Token Management Services (CIT only)
    • Network Tokenization
  • Fraud Management:
    • Decision Manager
    • Device Fingerprint ID    

Getting Started

Prerequisites - commercetools 

Merchant Center configuration:

  • Create a merchant account in the commercetools Merchant Center by visiting here.
  • Payment create and update API extension must have time limit of 10ms and Customer update API should have limit of 3ms and above. You may require commercetools support for increasing this to maximum allowable value. 


System Requirements:

  • System: Windows or macOS
  • Server RAM: We recommend setting the memory allocation per script (memory limit) to a minimum of 256M.
  • Editor: Visual Studio Code is recommended
  • Node: An installation of node JS is required

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.

Generate REST Keys

Before configurating this integration, you are required to generate your REST keys within your Merchant Portal for both (Live) and (Test)

  • 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

 

 

 

 

 

commercetools Merchant Center

  • Login to the commercetools Merchant Center and create your project by referring to the following (link)
  • Once the project setup is done, create the API Client Keys
    • Settings → Developer Settings → Create new API client
       
  • Give an API Client name and select the following scopes which are mentioned below:
    • Manage -> Customers, Extensions, Orders, Payments, Types
    • View -> Customers, Orders, Payments, Types
       
  • Click Create API client to confirm your entries
  • Once the keys are generated, ensure to save them securely since they are one-time-accessible

Installing the Plugin

Navigate to Cybersource integration for commercetools marketplace or directly to our GitHub Repository, click on Get the integration and clone the source code to your system.

  • Once the repository is cloned successfully, open it using Visual Studio Code Editor
  • Open the terminal, and run the below command to install all the dependencies

Configure and run the extension

After installing all the dependencies, setup the .env file in the root folder of the plugin by referring to the table below:

Environment Variable Value Notes
CONFIG_PORT Port to listen on for HTTP requests Port on which you want the plugin to run
PAYMENT_GATEWAY_MERCHANT_ID Your Cybersource merchant ID Refer to Step 1
PAYMENT_GATEWAY_MERCHANT_KEY_ID ID of your Cybersource shared secret key to be used for HTTP Signature authentication Created in Step 1
PAYMENT_GATEWAY_MERCHANT_SECRET_KEY Value of a Cybersource shared secret key to be used for HTTP Signature authentication Created in Step 1
PAYMENT_GATEWAY_RUN_ENVIRONMENT TEST or PRODUCTION Property for running the project in TEST or PRODUCTION environment
PAYMENT_GATEWAY_DECISION_MANAGER Boolean value - true or false Flag for enabling and disabling Decision Manager for Authorization. Case sensitive.
PAYMENT_GATEWAY_TARGET_ORIGIN https://{yourdomain} Base URL where your frontend will be accessible
PAYMENT_GATEWAY_VERIFICATION_KEY Use Openssl -rand64 32 to generate verification key Used to check Flex tokens for tampering
PAYMENT_GATEWAY_3DS_RETURN_URL URL that the issuing bank will redirect to the customer for payer Used only if payment.paymentMethodInfo.method == creditCardWithPayerAuthentication
PAYMENT_GATEWAY_APPLE_PAY_MERCHANT_ID Your Apple Pay merchant ID Provided by Apple
PAYMENT_GATEWAY_APPLE_PAY_CERTIFICATE_PATH Path where the apple pay certificate is stored Used only if payment.paymentMethodInfo.method == applePay
PAYMENT_GATEWAY_APPLE_PAY_KEY_PATH Path where the apple pay key is stored Used only if payment.paymentMethodInfo.method == applePay
PAYMENT_GATEWAY_ENABLE_RATE_LIMITER Boolean value - true or false Enable to restrict the number of cards a customer can save within the given time limit
PAYMENT_GATEWAY_LIMIT_SAVED_CARD_RATE Numeric value Provide the number of attempts in below specified time period(this time frame includes Success & Failure)
PAYMENT_GATEWAY_SAVED_CARD_LIMIT_FRAME Numeric value between 1-24 Provide the number of hours that saved card attempts are counted(Max 24 hours)
PAYMENT_GATEWAY_DECISION_SYNC Boolean value - true or false Flag for enabling and disabling Decision Sync. Case sensitive.
PAYMENT_GATEWAY_RUN_SYNC Boolean value - true or false Flag for enabling and disabling Run Sync. Case sensitive
CT_PROJECT_KEY Project key for your Commercetools project Created in Step 2
CT_CLIENT_ID Client Id of you Commercetools payment API key Created in Step 2
CT_CLIENT_SECRET Client secret of your Commercetools Payment API key Created in Step 2
CT_AUTH_HOST Commercetools auth server URL Created in Step 2
CT_API_HOST Commercetools API server URL Created in Step 2



Once all the required values are populated in .env file, run the plugin using the following command:

                npm run start

Extending commercetools API & Customization

In-order to extend the commercetools APIs and customization follow the steps given below:

  • Navigate to {baseUrl}/orders
  • Click on Run Script button (this will invoke the {baseUrl}/configurePlugin to employ the API extension & Customization) 

Note: The {baseUrl} will be defined by where you deploy the plugin

Alternatively, you can directly hit the following endpoint

{baseUrl}/configurePlugin 

Note:. See API Extension Setup to know the values to be passed for the fields required before running the script

Further Information

Need more guidance as you implement a Cybersource‑powered solution?
The Cybersource Developer Center offers resources to help merchants and system integrators build reliable, compliant, and well‑tested integrations.

• Explore Cybersource API documentation for payment processing, tokenization, refunds, and reporting to understand how each capability works within your ISV’s integration.
• Review SDK and code sample libraries to accelerate development and align with recommended implementation patterns.
• Access sandbox environment details to validate transaction flows, verify configuration, and complete end‑to‑end testing.
• Consult integration guides for information on authentication, security controls, risk services, and digital channel support.
• Use the Cybersource Support Center for troubleshooting articles, FAQs, and release updates relevant to your integration path.

These resources are designed to help you deploy and manage your ISV solution efficiently, ensuring a smooth payment experience for your customers.