Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
gateways:cybersource [2018/11/02 15:12] – [Important Notes and Caveats] marijagateways:cybersource [2021/02/23 12:18] (current) – [Setting Up Cybersource for FoxyCart] adam
Line 1: Line 1:
 ---- dataentry gateway ---- ---- dataentry gateway ----
-type            : gateway         # do not change this line+type                             : gateway # do not change this line 
 +name                             : Cybersource 
 +countries                        : US, GB, JP 
 +support-added                    : 0.3.0 
 +support-removed                  :  
 +supports-3dsecure                : yes 
 +supports-multicurrency           :  # enter "yes" or "no" (without quotes) 
 +supports-transaction-id-override : yes 
 +gateway_url                      : http://www.cybersource.com/ 
 +----
  
-# Add the full name of the gateway after the colon below. 
-name            : Cybersource 
  
-# Supported Countries. Please use 2-character ISO Country Codes available at 
-# http://www.iso.org/iso/english_country_names_and_code_elements 
-# Separate multiple country codes by commas. 
-countries       : US, GB, JP 
- 
-# Enter the FoxyCart versions where support was added or removed (if applicable). 
-# Version numbers should include applicable decimals, such as "0.7.0" and not "070" 
-support-added   : 0.3.0 
-support-removed :  
-supports-multicurrency  : # enter "yes" or "no" (without quotes) 
- 
-# Gateway URL 
-gateway_url     : http://www.cybersource.com/ 
----- 
  
  
Line 26: Line 19:
   - Set up your CyberSource account - [[http://www.cybersource.com/register/]]   - Set up your CyberSource account - [[http://www.cybersource.com/register/]]
   - Login to 'Test Business Center' [[https://ebctest.cybersource.com/]]   - Login to 'Test Business Center' [[https://ebctest.cybersource.com/]]
-  - On the left nav click Account Management -> Transaction Security Keys. Then click on the "Security Keys for the SOAP Toolkit API" link.+  - On the left nav click Payment Configuration -> Key Management.
   - Generate a new key by clicking the "Generate Key" button.   - Generate a new key by clicking the "Generate Key" button.
-    - If you don't see this optionthere may be two options (one for SOAP, one for something else). Try the other setting. +    - Select "Transaction Processing" on the first screenand "SOAP" on the second screen 
-  - Copy the key that appears (and download it for safekeeping if desired).+  - Copy the key that appears (and download it for safekeeping if desired as it won't be shown again).
   - Login to your FoxyCart admin. Click the "payment" link under "STORE". Set your payment method to Cybersource.com.   - Login to your FoxyCart admin. Click the "payment" link under "STORE". Set your payment method to Cybersource.com.
   - Flip to the Live Server radio button. If it's disabled you'll need to "Start your FoxyCart subscription today!".   - Flip to the Live Server radio button. If it's disabled you'll need to "Start your FoxyCart subscription today!".
   - Enter your Merchant ID (which you use when you login to CyberSource) and the Transaction Key that you just copied.   - Enter your Merchant ID (which you use when you login to CyberSource) and the Transaction Key that you just copied.
 +  - If your store needs to verify that the credit card is valid for certain amounts, you can set the (live or test) //card verification mode:// field. This feature's use is if you want to save a credit card for the customer and verify that it's valid, but not charge it at the time of entry. See the <wrap hi>?</wrap> to the right of the field for help on options.
   - Click the "Update Payment Gateway" button.   - Click the "Update Payment Gateway" button.
   - Get back to your CyberSource account. Click "Account Management" -> "SmartAuth Settings". Set your checkboxes to look like this:\\ {{:docs:paymentgateways:cybersource-smartauth-settings-cvv2.png|CyberSource CVN settings}}   - Get back to your CyberSource account. Click "Account Management" -> "SmartAuth Settings". Set your checkboxes to look like this:\\ {{:docs:paymentgateways:cybersource-smartauth-settings-cvv2.png|CyberSource CVN settings}}
Line 60: Line 54:
   - Activate the option "Payment Token Required".   - Activate the option "Payment Token Required".
  
 +
 +===== Overriding the Merchant Reference Number =====
 +As of Foxy v2.0, the "Merchant Reference Number" that Foxy passes to CyberSource (which is normally the Foxy transaction ID) can be overridden. This is considered advanced functionality, and is only relevant for very specific use cases (such as complex fulfillment processes where multiple authorizations and captures may need to be grouped by the Merchant Reference Number).
 +
 +To override the default Foxy transaction ID, add [[https://api.foxycart.com/rels/attributes|an ''attribute'' via the API]] named ''fx_transaction_id_gateway_override'', to the ''cart'' resource. The value of that attribute will be passed to CyberSource as the Merchant Reference Number (aka Merchant Reference Code).
 +
 +For reference, here's the field in the CyberSource portal:
 +{{ :gateways:cybersource-merchant-reference-code-override.png?400 |An image showing the CyberSource admin with the Merchant Reference Number column header circled.}}
 ===== Testing ===== ===== Testing =====
 ==== Obtaining a Test Account ==== ==== Obtaining a Test Account ====
Line 71: Line 73:
  
 ===== Important Notes and Caveats ===== ===== Important Notes and Caveats =====
-Cybersource limits the number of characters we can send in the requests for payment, while Foxy's character limits on the checkout are more permissive. Therefore, when the customer fills out the checkout form, some of the information may be cut off or special characters removed before sending to Cybersource. If you wish to validate the checkout data entry instead of automatically replacing and/or truncating input values, you can do so using [[v:2.0:checkout#adding_custom_validation_to_your_checkout|JavaScript validation]]. +Cybersource limits the number of characters we can send in the requests for payment, while Foxy's character limits on the checkout are more permissive. Therefore, when the customer fills out the checkout form, some of the information may be cut off or special characters removed before sending to Cybersource. Note though that <wrap tip>the original data remains in Foxy</wrap>. Our opinion is that it's more important to allow the customer to checkout (with data intact in Foxy) than to reject on an error because the customer put "ext" instead of "x" in their phone field, or included a disallowed character in their company name field. 
 + 
 +If you wish to validate the checkout data entry instead of automatically replacing and/or truncating input values, you can do so using [[v:2.0:checkout#adding_custom_validation_to_your_checkout|JavaScript validation]]. 
  
 ===== User Notes and Experiences ===== ===== User Notes and Experiences =====
 <wrap tip>If you have tips, experience, or helpful notes related to this gateway that would benefit others, please add them below, including your name and the date. We at FoxyCart reserve the right to edit or remove comments that don't add value to this page.</wrap> <wrap tip>If you have tips, experience, or helpful notes related to this gateway that would benefit others, please add them below, including your name and the date. We at FoxyCart reserve the right to edit or remove comments that don't add value to this page.</wrap>

Site Tools