RELATED TO THIS PAGE

ON THIS PAGE

Product overview

Whether you’re looking to move to commercetools or are already using it, our certified integration can quickly help you reach your digital commerce goals. Our global, modular payment management platform can support you to enhance customer experience, grow revenues and mitigate risk.

  • Card Payments
  • 3D-Secure (SCA Compliant)
  • Tokenization
  • Visa Checkout
  • Google Pay
  • ApplePay
  • eChecks
  • Fraud Prevention Tools (Decision Manager)

 

 

Product editions

The Cybersource Payment Management Platform for commercetools provides access to the following Cybersource services.

Key features:

  • Payment acceptance: Accept credit card payments worldwide with functionality including payment, payment reversal, capture, refund and credit.
  • Digital Wallet Acceptance through Apple Pay, Google Pay & Visa Click To Pay
  • Fraud management: Tools and expert help you need to reduce fraud and accept more valid orders across channels and geographies. With 3-D Secure 2.1, you can help support Europe’s PSD2 SCA mandate—all while maintaining a customer-friendly checkout experience.
  • Payment security: Our extension reduces your exposure to risk and simplify your PCI DSS compliance using our SAQ-A Flex Microform solution.

The integration approach is based-on commercetools’ API Extensions, enabling access to Cybersource services through commercetools in a flexible way. commercetools’ customers can choose to either self-host or make use of cloud provider services, such as serverless functions, to host the code invoked by commercetools. The extension is split into library services used to support the web-services needed for API Extension invocations and sample implementations of the web-services. The sample implementation makes uses of a lightweight Spring-boot application.

Getting started

Cybersource Prerequisites

Before configuring your commerctools instance, you are required to generate your Cybersource REST keys within your Business Center for both (Live) and (Test)


a.       Sign into your Cybersource Enterprise Business Center account (Live) and (Test)

b.       Access Payment Configuration -> Key Management

c.       Select the 'Generate Key' button in the top right hand corner

d.       Select your key type as 'REST - Shared Secret' and Generate Key

e.       Copy your Shared Secret Key values and save them securely

 

commercetools Prerequisites

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: The more the merrier. 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 of version 16.3.0 or above is recommended

commercetools Merchant Center

Login to the commercetools Merchant Center and create your project by referring to the following (link).

Once the project setup is complete, create the API Client Keys:

  • Settings → Developer Settings → Create new API client


Set an API Client name and select the following scopes:

  • Manage -> Customers, Extensions, Orders, Payments, Types
  • View -> Customers, Orders, Payments, Types


Click Create API Client to confirm your entries.

Once the keys are generated, save them securely, as they are one-time-accessible.

                npm install

Configure and run the extension

a.        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 Obtained from Cybersource Business Center
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_SCA_CHALLENGE Boolean value - true or false Flag to force Strong Consumer Authentication challenge while saving a card using Payer Authentication. Case sensitive
PAYMENT_GATEWAY_ORDER_RECONCILIATION Boolean value - true or false Flag for enabling or disabling Order reconciliation to indicate whether reconciliation Id to be passed in authorization, capture and refund transactions. Case sensitive. NOTE: The Cybersource-Commercetools Plugin will consider order number as the reconciliation id if available. The order number from Commercetools should be numeric/alpha-numeric string to reflect in Cybersource
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_ENABLE_DEBUG Boolean value - true or false Flag for enabling or disabling logging of requests that is send to Cybersource. Case sensitive
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
AWS_ACCESS_KEY_ID AWS Access Key ID Provided by AWS in AWS-Serverless-Deployment#AWSSecurityCredentials. Required when running Docker container in AWS
AWS_SECRET_ACCESS_KEY AWS Secret Key Provided by AWS in AWS-Serverless-Deployment#AWSSecurityCredentials. Required when running Docker container in AWS
AWS_REGION AWS Region Name Provided by AWS. Required when running Docker container in AWS
PAYMENT_GATEWAY_ENABLE_CLOUD_LOGS Boolean value - true or false Set the value to true to get AWS Cloudwatch logs. Case sensitive.
PAYMENT_GATEWAY_ENABLE_SERVERLESS_DEPLOYMENT Boolean value - true or false Set the value to true when the plugin is hosted using any serverless deployments.
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 

Alternatively, you can directly hit the following endpoint

Endpoint

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