Feedback

Check with your platform contact for product availability

Product overview

Product editions

Getting started

Cybersource extension

Product overview

Version #1.2.0

Release notes

Releases

Requirements

  • Yarn version: 1.22.4
  • NodeJS version: 18.16.1, You could use NVM to manage multiple versions locally
  • Compatible with OSF: v5.1.0 and below
  • Compatible with OCC Version: v23.11

Cybersource and Oracle’s partnership gives you access to a wide range of features, tailor-made to help you increase sales and approve more orders. Improved fraud management solutions, tokenization, and popular payment acceptance methods mean more happy customers and less risk. Cybersource supports you to move forward and grow, away from legacy architecture.

New SuiteApp Functionality

  • Card Payments
  • eCheck/ACH
  • Tokenisation
  • Recurring Merchant Initiated Transactions

Product editions

Getting started

Create an Extension ID

In order to upload an extension into Commerce Cloud, you must generate an ID for the extension and update the same in packages/payment-gateway/ext.json file To create an extension ID:

  • Log into Commerce Cloud.
  • Navigate to Settings->Extensions->Developer tab.
  • Click on Generate ID button.
  • Enter a name for the extension and click Save.
  • Copy and update the generated extension ID

 

Upload Extension

Before uploading the extension, zip up all the files within your packages/payment-gateway directory except settings.json. This is the file you upload to Commerce Cloud to make the extension available for use.

Settings -> Extension ->

Click the Upload Extension button and select the extension zip file from your local file system. Once the module is installed, head back to the Oracle Commerce Cloud Admin to configure it.

Pre-Requisites

Before starting configuration of your Oracle Commerce Cloud instance you are required to generate your Cybersource SOAP keys within your Business Center for both (Live) and (Test)

a.       Sign into your Cybersource Business Center account (Live) or (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 Key' and Generate Key

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

Enable gateway in OCC Admin

After successful deployment you will need to enable payment gateway:

  • Go to OCC Admin -> Settings -> Payment Processing
  • Open 'Payment gateways' tab and choose ‘Cybersource Official’ from the list
  • Select 'Payment Gateway Enabled' option
  • Configure gateway settings by providing values (e.g. merchant credentials) for particular channel (Preview, Storefront, Agent)
  • Save Changes
  • Go back to the 'Payment Types' type
  • Select supported credit/debit card types from the list [Possible card types: VISA, MASTERCARD, AMEX, DISCOVER, DINERSCLUB, JCB, CARTESBANCAIRES, MAESTRO, CARNET, CUP]
  • Save Changes


Configure Generic Webhooks

You need to setup Generic Payment so that Oracle Commerce knows where to send payment requests.

  • Open OCC Admin and got to Settings -> Web APIs -> Function APIs
  • Configure both Generic Payment Production and Preview webhooks
  • Replace URL (the {env} part) with your specific value
  • Make sure you copy secret key as it will be required for SSE deployment

 

Install SSE (server-extension)

Configure production settings in the following file packages/server-extension/config/app.prod.json:

  • cache.service.ttl.secs - Default caching TTL, can be zero value
  • cache.gatewaysettings.ttl.secs - Caching TTL for gateway settings call (see packages/server-extension/src/middlewares/gatewaySettings.ts). You might want to use TTL value '1' while testing SSE so that changes in gateway settings performed in OCC Admin become immediately available to SSE and Payment Widget respectively
  • crypto.service.key - Random key which is used to encrypt data so that it is not tampered in UI
  • partner.developerId - Leave the value as is
  • partner.solutionId - Leave the value as is
  • logging.webhook.http - Enable webhook request/response logging
  • logging.api.error - Enable logging for errors
  • logging.api.access - Enable logging for incoming requests
  • payments.secret.key - Webhook secret key (SHA512)

 

Deploy

Build SSE extension with the following command:

cd packages/occ-sse-gateway

yarn build:prod

 

Deploy SSE by running commands (from project's root):

yarn occ package-app osf-payment-sse

yarn occ upload-app -u ${OCC_ADMIN_HOST} -k ${APPLICATION_KEY} osf-payment-sse

where

- APPLICATION_KEY - Application Key created in Settings -> Web APIs -> Registered Applications

- OCC_ADMIN_HOST - your OCC specific environment, e.g. asbx80c1dev-admin-{env}.oraclecloud.com

 

Install Payment Widget

Copy the contents from cybersource-plugins-oraclecxcommerce/plugins into the plugins directory of your storefront(OSF workspace) code. Copy plugins/actions into your storefront code and export the actions in the index and meta files:

plugins/actions/index.js

plugins/actions/meta.js

Copy plugins/components into your storefront code and export the components in the index and meta files:

plugins/components/index.js

plugins/components/meta.js

Copy plugins/endpoints into your storefront code and export the endpoints in the index and meta files:

plugins/endpoints/index.js

plugins/endpoints/meta.js

Copy plugins/selectors into your storefront code and export the selectors in the index file:

plugins/selectors/index.js

Copy plugins/fetchers into your storefront code and export the fetchers in the hook, index and meta files:

plugins/fetchers/hook.js

plugins/fetchers/index.js

plugins/fetchers/meta.js

Add widget to Checkout Layout

Go to the OCC admin design tab and replace the default checkout-continue-to-review-order- button component with the IsvCheckoutContinueToReviewOrderButton on the checkout- payment page

Go to the OCC admin design tab and replace the default checkout-place-order-button component with the IsvCheckoutPlaceOrderButton on the checkout-review-order page

Layout the IsvPaymentMethod component on the checkout payments container

Remove the CheckoutCreditCard component from the layout and replace it with IsvPaymentMethod

Publish the uploaded and configured widgets: OCC Admin -> Publishing -> Publish

Configure the Extension

Go to OCC Admin -> Settings -> Payment Processing and click on Payment Gateways

Selected Cybersource Official and enable

Enter your Cybersource Merchant ID and REST Key details

Choose supported Payment Methods and click save

Ready to Go Live

When you are ready to go live configure the cartridge using your production Cybersource account details. Please refer to this step for a reminder on where to do this.