Class: ActiveMerchant::Billing::Integrations::AuthorizeNetSim::Notification

Inherits:
Notification
  • Object
show all
Defined in:
lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb

Instance Attribute Summary

Attributes inherited from Notification

#params, #raw

Instance Method Summary collapse

Methods inherited from Notification

#amount, #empty!, #gross_cents, #initialize, #valid_sender?

Constructor Details

This class inherits a constructor from ActiveMerchant::Billing::Integrations::Notification

Instance Method Details

#acknowledge(md5_hash_set_in_authorize_net, authorize_net_login_name) ⇒ Object

Called to request back and check if it was a valid request. Authorize.net passes us back a hash that includes a hash of our ‘unique’ MD5 value that we set within their system.

Example: acknowledge(‘my secret md5 hash that I set within Authorize.Net’, ‘authorize_login’)

Note this is somewhat unsafe unless you actually set that md5 hash to something (defaults to ” in their system).



321
322
323
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 321

def acknowledge(md5_hash_set_in_authorize_net, )
  Digest::MD5.hexdigest(md5_hash_set_in_authorize_net +  + params['x_trans_id'] + gross) == params['x_MD5_Hash'].downcase
end

#all_custom_values_passed_in_and_now_passed_back_to_us ⇒ Object

If you pass any values to authorize that aren’t its expected, it will pass them back to you verbatim, returned by this method. custom values:



113
114
115
116
117
118
119
120
121
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 113

def all_custom_values_passed_in_and_now_passed_back_to_us
  all = {}
  params.each do |key, value|
    if key[0..1] != 'x_'
      all[key] = unescape value
    end
  end
  all
end

#auth_code ⇒ Object 



68
69
70
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 68

def auth_code
  unescape params['x_auth_code']
end

#avs_code ⇒ Object

avs [address verification] code A = Address (Street) matches, ZIP does not B = Address information not provided for AVS check E = AVS error G = Non-U.S. Card Issuing Bank N = No Match on Address (Street) or ZIP P = AVS not applicable for this transaction R = Retry – System unavailable or timed out S = Service not supported by issuer U = Address information is unavailable W = Nine digit ZIP matches, Address (Street) does not X = Address (Street) and nine digit ZIP match Y = Address (Street) and five digit ZIP match Z = Five digit ZIP matches Address (Street) does not



191
192
193
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 191

def avs_code
  params['x_avs_code']
end

#avs_code_matches? ⇒ Boolean

Returns true if their address completely matched [Y or X, P from #avs_code, which mean ‘add+zip match’, ‘address + 9-zip match’, and not applicable, respectively].

Returns:

  • (Boolean) 


198
199
200
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 198

def avs_code_matches?
  return ['Y', 'X', 'P'].include? params['x_avs_code']
end

#billing_address ⇒ Object

Passes a hash of the address the user entered in at Authorize.Net



56
57
58
59
60
61
62
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 56

def billing_address
  all = {}
  [:fax, :city, :company, :last_name, :country, :zip, :first_name, :address, :email, :state].each do |key_out|
    all[key_out] = unescape params['x_' + key_out.to_s]
  end
  all
end

#cavv_matches? ⇒ Boolean

Check if #cavv_response == ”, ‘2’, ‘8’ one of those [non failing] [blank means no validated, 2 is passed, 8 is passed issuer available]

Returns:

  • (Boolean) 


255
256
257
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 255

def cavv_matches?
  ['','2','8'].include? cavv_response
end

#cavv_response ⇒ Object

cavv_response–‘cardholder authentication verification response code’–most likely not use for SIM Blank or not present =

CAVV not validated 0 = CAVV not validated because erroneous data was submitted 1 = CAVV failed validation 2 = CAVV passed validation 3 = CAVV validation could not be performed; issuer attempt incomplete 4 = CAVV validation could not be performed; issuer system error 5 = Reserved for future use 6 = Reserved for future use 7 = CAVV attempt – failed validation – issuer available (U.S.-issued card/non-U.S acquirer) 8 = CAVV attempt – passed validation – issuer available (U.S.-issued card/non-U.S. acquirer) 9 = CAVV attempt – failed validation – issuer



248
249
250
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 248

def cavv_response
  params['x_cavv_response']
end

#complete? ⇒ Boolean

Payment is complete – returns true if x_response_code == ‘1’

Returns:

  • (Boolean) 


260
261
262
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 260

def complete?
  params["x_response_code"] == '1'
end

#customer_id ⇒ Object 



64
65
66
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 64

def customer_id
  unescape params['x_cust_id']
end

#cvv2_resp_code ⇒ Object

cvv2 response M = Match N = No Match P = Not Processed S = Should have been present U = Issuer unable to process request



210
211
212
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 210

def cvv2_resp_code
  params['x_cvv2_resp_code']
end

#cvv2_resp_code_matches? ⇒ Boolean

check if #cvv2_resp_code == ‘m’ for Match. otherwise false

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 215

def cvv2_resp_code_matches?
  return ['M'].include? cvv2_resp_code
end

#description ⇒ Object 



133
134
135
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 133

def description
  unescape params['x_description']
end

#duty ⇒ Object 



123
124
125
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 123

def duty
  unescape params['x_duty']
end

#freight ⇒ Object Also known as: shipping

Shipping we sent them.



128
129
130
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 128

def freight
  unescape params['x_freight']
end

#gross ⇒ Object

The money amount we received in X.2 decimal. Returns a string



298
299
300
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 298

def gross
  unescape params['x_amount']
end

#invoice_num ⇒ Object

Invoice num we passed in as invoice_num to them.



106
107
108
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 106

def invoice_num
  item_id
end

#item_id ⇒ Object

Alias for invoice number–this is the only id they pass back to us that we passed to them, except customer id is also passed back.



266
267
268
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 266

def item_id
  unescape params['x_invoice_num']
end

#method ⇒ Object

Payment method used–almost always CC (for credit card).



96
97
98
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 96

def method
  unescape params['x_method']
end

#method_available ⇒ Object

Ff our payment method is available. Almost always “true”.



101
102
103
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 101

def method_available
  params['x_method_available']
end

#payer_email ⇒ Object

End-user’s email



282
283
284
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 282

def payer_email
  unescape params['x_email']
end

#po_num ⇒ Object 



72
73
74
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 72

def po_num
 unescape params['x_po_num']
end

#received_at ⇒ Object

When was this payment was received by the client. –unimplemented – always returns nil



277
278
279
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 277

def received_at
  nil
end

#receiver_email ⇒ Object

They don’t pass merchant email back to us – unimplemented – always returns nil



288
289
290
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 288

def receiver_email
  nil
end

#response_code_as_ruby_symbol ⇒ Object

Returns the response code as a symbol. => :approved, ‘2’ => :declined, ‘3’ => :error, ‘4’ => :held_for_review



139
140
141
142
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 139

def response_code_as_ruby_symbol
  map = {'1' => :approved, '2' => :declined, '3' => :error, '4' => :held_for_review}
  map[params['x_response_code']]
end

#response_reason_code ⇒ Object

The response reason text’s numeric id [equivalent–just a number]



149
150
151
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 149

def response_reason_code
  unescape params['x_response_reason_code']
end

#response_reason_text ⇒ Object 



144
145
146
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 144

def response_reason_text
  unescape params['x_response_reason_text']
end

#response_subcode ⇒ Object

‘used internally by their gateway’



154
155
156
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 154

def response_subcode
  params['x_response_subcode']
end

#security_key ⇒ Object

md5 hash used internally



293
294
295
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 293

def security_key
  params['x_MD5_Hash']
end

#ship_to_address ⇒ Object 



76
77
78
79
80
81
82
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 76

def ship_to_address
 all = {}
  [:city, :last_name, :first_name, :country, :zip, :address].each do |key_out|
    all[key_out] = unescape params['x_ship_to_' + key_out.to_s]
  end
  all
end

#status ⇒ Object

#method_available alias



308
309
310
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 308

def status
  complete?
end

#tax ⇒ Object

Tax amount we sent them.



85
86
87
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 85

def tax
  unescape params['x_tax']
end

#tax_exempt ⇒ Object

They pass back a tax_exempt value.



159
160
161
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 159

def tax_exempt
  params['x_tax_exempt']
end

#test? ⇒ Boolean

Was this a test transaction?

Returns:

  • (Boolean) 


303
304
305
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 303

def test?
  params['x_test_request'] == 'true'
end

#transaction_id ⇒ Object

They return this number to us [it’s unique to Authorize.net].



271
272
273
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 271

def transaction_id
  params['x_trans_id']
end

#transaction_type ⇒ Object

Transaction type (probably going to be auth_capture, since that’s all we set it as).



91
92
93
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 91

def transaction_type
  unescape params['x_type'] 
end

#unescape(val) ⇒ Object

:nodoc:



47
48
49
50
51
52
53
 
# File 'lib/active_merchant/billing/integrations/authorize_net_sim/notification.rb', line 47

def unescape(val) #:nodoc:
  if val
    CGI::unescape val
  else
    val
  end
end