Class: ActiveMerchant::Billing::CyberSourceGateway

Inherits:
Gateway
  • Object
show all
Defined in:
lib/active_merchant/billing/gateways/cyber_source.rb

Overview

See the remote and mocked unit test files for example usage. Pay special attention to the contents of the options hash.

Initial setup instructions can be found in cybersource.com/support_center/implementation/downloads/soap_api/SOAP_toolkits.pdf

Debugging If you experience an issue with this gateway be sure to examine the transaction information from a general transaction search inside the CyberSource Business Center for the full error messages including field names.

Important Notes

  • AVS and CVV only work against the production server. You will always get back X for AVS and no response for CVV against the test server.

  • Nexus is the list of states or provinces where you have a physical presence. Nexus is used to calculate tax. Leave blank to tax everyone.

  • If you want to calculate VAT for overseas customers you must supply a registration number in the options hash as vat_reg_number.

  • productCode is a value in the line_items hash that is used to tell CyberSource what kind of item you are selling. It is used when calculating tax/VAT.

  • All transactions use dollar values.

Constant Summary collapse

TEST_URL = 
'https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor'
LIVE_URL = 
'https://ics2ws.ic3.com/commerce/1.x/transactionProcessor'
XSD_VERSION = 
"1.69"
@@credit_card_codes =

map credit card to the CyberSource expected representation

{
  :visa  => '001',
  :master => '002',
  :american_express => '003',
  :discover => '004'
}
@@response_codes =

map response codes to something humans can read

{
  :r100 => "Successful transaction",
  :r101 => "Request is missing one or more required fields" ,
  :r102 => "One or more fields contains invalid data",
  :r150 => "General failure",
  :r151 => "The request was received but a server time-out occurred",
  :r152 => "The request was received, but a service timed out",
  :r200 => "The authorization request was approved by the issuing bank but declined by CyberSource because it did not pass the AVS check",
  :r201 => "The issuing bank has questions about the request",
  :r202 => "Expired card", 
  :r203 => "General decline of the card", 
  :r204 => "Insufficient funds in the account", 
  :r205 => "Stolen or lost card", 
  :r207 => "Issuing bank unavailable", 
  :r208 => "Inactive card or card not authorized for card-not-present transactions", 
  :r209 => "American Express Card Identifiction Digits (CID) did not match", 
  :r210 => "The card has reached the credit limit", 
  :r211 => "Invalid card verification number", 
  :r221 => "The customer matched an entry on the processor's negative file", 
  :r230 => "The authorization request was approved by the issuing bank but declined by CyberSource because it did not pass the card verification check", 
  :r231 => "Invalid account number",
  :r232 => "The card type is not accepted by the payment processor",
  :r233 => "General decline by the processor",
  :r234 => "A problem exists with your CyberSource merchant configuration",
  :r235 => "The requested amount exceeds the originally authorized amount",
  :r236 => "Processor failure",
  :r237 => "The authorization has already been reversed",
  :r238 => "The authorization has already been captured",
  :r239 => "The requested transaction amount must match the previous transaction amount",
  :r240 => "The card type sent is invalid or does not correlate with the credit card number",
  :r241 => "The request ID is invalid",
  :r242 => "You requested a capture, but there is no corresponding, unused authorization record.",
  :r243 => "The transaction has already been settled or reversed",
  :r244 => "The bank account number failed the validation check",
  :r246 => "The capture or credit is not voidable because the capture or credit information has already been submitted to your processor",
  :r247 => "You requested a credit for a capture that was previously voided",
  :r250 => "The request was received, but a time-out occurred with the payment processor",
  :r254 => "Your CyberSource account is prohibited from processing stand-alone refunds",
  :r255 => "Your CyberSource account is not configured to process the service in the country you specified" 
}

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::CURRENCIES_WITHOUT_FRACTIONS, Gateway::DEBIT_CARDS

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary collapse

Methods inherited from Gateway

#card_brand, card_brand, inherited, supports?

Methods included from CreditCardFormatting

#format

Constructor Details

#initialize(options = {}) ⇒ CyberSourceGateway

These are the options that can be used when creating a new CyberSource Gateway object.

:login => your username

:password => the transaction key you generated in the Business Center

:test => true sets the gateway to test mode

:vat_reg_number => your VAT registration number

:nexus => “WI CA QC” sets the states/provinces where you have a physical presense for tax purposes

:ignore_avs => true don’t want to use AVS so continue processing even if AVS would have failed

:ignore_cvv => true don’t want to use CVV so continue processing even if CVV would have failed



95
96
97
98
99
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 95

def initialize(options = {})
  requires!(options, :login, :password)
  @options = options
  super
end

Instance Method Details

#auth_reversal(money, identification, options = {}) ⇒ Object 



115
116
117
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 115

def auth_reversal(money, identification, options = {})
  commit(build_auth_reversal_request(money, identification, options), options)
end

#authorize(money, creditcard_or_reference, options = {}) ⇒ Object

Request an authorization for an amount from CyberSource

You must supply an :order_id in the options hash



109
110
111
112
113
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 109

def authorize(money, creditcard_or_reference, options = {})
  requires!(options,  :order_id)
  setup_address_hash(options)
  commit(build_auth_request(money, creditcard_or_reference, options), options )
end

#calculate_tax(creditcard, options) ⇒ Object

CyberSource requires that you provide line item information for tax calculations If you do not have prices for each item or want to simplify the situation then pass in one fake line item that costs the subtotal of the order

The line_item hash goes in the options hash and should look like 

:line_items => [
  {
    :declared_value => '1',
    :quantity => '2',
    :code => 'default',
    :description => 'Giant Walrus',
    :sku => 'WA323232323232323'
  },
  {
    :declared_value => '6',
    :quantity => '1',
    :code => 'default',
    :description => 'Marble Snowcone',
    :sku => 'FAKE1232132113123'
  }
]

This functionality is only supported by this particular gateway may be changed at any time



197
198
199
200
201
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 197

def calculate_tax(creditcard, options)
  requires!(options,  :line_items)
  setup_address_hash(options)
  commit(build_tax_calculation_request(creditcard, options), options)	  
end

#capture(money, authorization, options = {}) ⇒ Object

Capture an authorization that has previously been requested



120
121
122
123
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 120

def capture(money, authorization, options = {})
  setup_address_hash(options)
  commit(build_capture_request(money, authorization, options), options)
end

#credit(money, identification, options = {}) ⇒ Object 



141
142
143
144
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 141

def credit(money, identification, options = {})
  deprecated CREDIT_DEPRECATION_MESSAGE
  refund(money, identification, options)
end

#purchase(money, creditcard_or_reference, options = {}) ⇒ Object

Purchase is an auth followed by a capture You must supply an order_id in the options hash



127
128
129
130
131
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 127

def purchase(money, creditcard_or_reference, options = {})
  requires!(options, :order_id)
  setup_address_hash(options)
  commit(build_purchase_request(money, creditcard_or_reference, options), options)
end

#refund(money, identification, options = {}) ⇒ Object 



137
138
139
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 137

def refund(money, identification, options = {})
  commit(build_credit_request(money, identification, options), options)
end

#retrieve(reference, options = {}) ⇒ Object

Retrieves a customer subscription/profile



168
169
170
171
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 168

def retrieve(reference, options = {})
  requires!(options, :order_id)
  commit(build_retrieve_subscription_request(reference, options), options)
end

#store(creditcard, options = {}) ⇒ Object

Stores a customer subscription/profile with type “on-demand”. To charge the card while creating a profile, pass options => money



148
149
150
151
152
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 148

def store(creditcard, options = {})
  requires!(options, :order_id)
  setup_address_hash(options)
  commit(build_create_subscription_request(creditcard, options), options)
end

#test? ⇒ Boolean

Should run against the test servers or not?

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 102

def test?
  @options[:test] || Base.gateway_mode == :test
end

#unstore(reference, options = {}) ⇒ Object

Removes a customer subscription/profile



162
163
164
165
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 162

def unstore(reference, options = {})
  requires!(options, :order_id)
  commit(build_delete_subscription_request(reference, options), options)
end

#update(reference, creditcard, options = {}) ⇒ Object

Updates a customer subscription/profile



155
156
157
158
159
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 155

def update(reference, creditcard, options = {})
  requires!(options, :order_id)
  setup_address_hash(options)
  commit(build_update_subscription_request(reference, creditcard, options), options)
end

#void(identification, options = {}) ⇒ Object 



133
134
135
 
# File 'lib/active_merchant/billing/gateways/cyber_source.rb', line 133

def void(identification, options = {})
  commit(build_void_request(identification, options), options)
end