CyberSource connectors
Important
Optimizely Configured Commerce has an integration with Spreedly, a global payments ecosystem, to give you access to more payment gateway options. When implementing new payment gateways on your Configured Commerce storefront, you must select a payment gateway and a payment method Spreedly supports. The previous payment connectors are no longer supported.
CyberSource is a payment gateway and tax calculation plug-in for processing online orders. Optimizely Configured Commerce customers can use CyberSource's Simple Order API for tax calculation and CyberSource's SOAP Toolkit API as the payment gateway.
Complete the following before enabling Cybersource:
- Obtain keys for the SOAP Toolkit API Key
- Obtain the Merchant ID- this is the unique identifier used to log into CyberSource's Business Center. For most users, the Merchant ID and User Name are the same.
How to generate the SOAP toolkit API security key
Requirements
- Java's Runtime Environment must be installed (use this link to download http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html
- Must use a browser other than Google Chrome. Chrome does not work to download the keys on CyberSource's website.
Generate the security key
Use the steps below to generate a new security key:
- Log into the Business Center Test Environment: https://ebctest.cybersource.com
- From the Account Management tab, select Transaction Security Keys.
- Select Security Keys for the SOAP Toolkit API.
- Select Generate Key.
- Either manually copy the key string value from the textbox displayed on-screen, or click Download to select a secure location on your computer to save the key string generated as a text file.
How to Obtain the Simple Order API Security Key
The Simple Order API security key must be generated before enabling Cybersource:
Requirements
- Java's Runtime Environment must be installed (use this link to download http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html
- Must use a browser other than Google Chrome. Chrome does not work to download the keys on CyberSource's website.
Steps to generate the security key
- Log into the Business Center Test Environment: https://ebctest.cybersource.com
- From the Account Management tab, click Transaction Security Keys.
- Select Security Keys for the Simple Order API.
- Select 2048-bit Key. This initiates the key generation applet.
- Once the applet screen appears, select Generate Certificate Request.
- Within the Save dialog box, select the secure location on the current server in which you wish to save the key file.
- The security key file, with extension .p12, needs to be added to the folder configured in the cybs.keysDirectory setting of the web.config. If this is not done an error will occur when attempting to calculate the tax.
<add key="cybs.keysDirectory" value="[PathToDirectoryContainingP12FileForCybersource]" />Update the settings to enable CyberSource to be the payment gateway
- Go to Admin Console > Administration > Settings
- Search for "Payment Gateway" and select CyberSource from the menu.
The following Settings are used to setup CyberSource as the payment provider in Configured Commerce.
Application Setting | Description |
|---|---|
PaymentGateway | CyberSource |
PaymentGateway_CyberSource_MerchantID | A unique value that identifies a merchant within CyberSource systems. This ID must be provided when logging into the Business Center and when submitting transactions to CyberSource. |
PaymentGateway_CyberSource_TransactionKey | Use the Security Key for the SOAP Toolkit API - see instructions for obtaining the key below. |
PaymentGateway_CyberSource_Url | Cybersource URL endpoint |
PaymentGateway_CyberSource_PaymentTokenizationEnabled | CyberSource Tokenization replaces sensitive payment data with a unique identifier or token that cannot be mathematically reversed |
Update the tax calculator setting
Use the following steps to enable CyberSource as the tax calculator:
- Go to Admin Console > Administration > Application Settings.
- Search for "TaxCalculator".
- Click Edit.
- Enter "CyberSource" into the Value field.
- Click Save.
The following Application Settings are used to setup CyberSource as the payment provider in Configured Commerce.
- Go to Admin Console > Administration > Settings.
- Search for "Payment Gateway" and select CyberSource from the menu.
Setting | Description |
|---|---|
Payment Gateway | CyberSource:::hint{style="info"} |
Note | |
This needs to be selected first in order to expose the other CyberSource related settings. ::: | | Merchant ID | A unique value that identifies a merchant within CyberSource systems. This ID must be provided when logging into the Business Center and when submitting transactions to CyberSource. | | Transaction Key | Use the Security Key for the SOAP Toolkit API - see instructions for obtaining the key below. | | Send to Production | Determines if the transaction is sent to the production cybersource server or the test cybersource server Default value: No | | Tokenize Payments | CyberSource Tokenization replaces sensitive payment data with a unique identifier or token that cannot be mathematically reversed |