Class: ActiveMerchant::Billing::NmiGateway

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

Constant Summary collapse

DUP_WINDOW_DEPRECATION_MESSAGE =
'The class-level duplicate_window variable is deprecated. Please use the :dup_seconds transaction option instead.'

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::RECURRING_DEPRECATION_MESSAGE, Gateway::STANDARD_ERROR_CODE

Instance Attribute Summary

Attributes inherited from Gateway

#options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Gateway

#add_field_to_post_if_present, #add_fields_to_post_if_present, #card_brand, card_brand, #generate_unique_id, inherited, #supported_countries, supported_countries, supported_countries=, supports?, #test?

Methods included from CreditCardFormatting

#expdate, #format

Methods included from PostsData

included, #raw_ssl_request, #ssl_get, #ssl_post, #ssl_request

Constructor Details

#initialize(options = {}) ⇒ NmiGateway

Returns a new instance of NmiGateway.


25
26
27
28
29
30
31
32
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 25

def initialize(options = {})
  if options.has_key?(:security_key)
    requires!(options, :security_key)
  else
    requires!(options, :login, :password)
  end
  super
end

Class Method Details

.duplicate_windowObject


21
22
23
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 21

def self.duplicate_window
  instance_variable_defined?(:@dup_seconds) ? @dup_seconds : nil
end

.duplicate_window=(seconds) ⇒ Object


16
17
18
19
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 16

def self.duplicate_window=(seconds)
  ActiveMerchant.deprecated(DUP_WINDOW_DEPRECATION_MESSAGE)
  @dup_seconds = seconds
end

Instance Method Details

#authorize(amount, payment_method, options = {}) ⇒ Object


48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 48

def authorize(amount, payment_method, options = {})
  post = {}
  add_invoice(post, amount, options)
  add_payment_method(post, payment_method, options)
  add_stored_credential(post, options)
  add_customer_data(post, options)
  add_vendor_data(post, options)
  add_merchant_defined_fields(post, options)
  add_level3_fields(post, options)
  add_three_d_secure(post, options)
  commit('auth', post)
end

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


61
62
63
64
65
66
67
68
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 61

def capture(amount, authorization, options = {})
  post = {}
  add_invoice(post, amount, options)
  add_reference(post, authorization)
  add_merchant_defined_fields(post, options)

  commit('capture', post)
end

#credit(amount, payment_method, options = {}) ⇒ Object


87
88
89
90
91
92
93
94
95
96
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 87

def credit(amount, payment_method, options = {})
  post = {}
  add_invoice(post, amount, options)
  add_payment_method(post, payment_method, options)
  add_customer_data(post, options)
  add_vendor_data(post, options)
  add_level3_fields(post, options)

  commit('credit', post)
end

#purchase(amount, payment_method, options = {}) ⇒ Object


34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 34

def purchase(amount, payment_method, options = {})
  post = {}
  add_invoice(post, amount, options)
  add_payment_method(post, payment_method, options)
  add_stored_credential(post, options)
  add_customer_data(post, options)
  add_vendor_data(post, options)
  add_merchant_defined_fields(post, options)
  add_level3_fields(post, options)
  add_three_d_secure(post, options)

  commit('sale', post)
end

#refund(amount, authorization, options = {}) ⇒ Object


78
79
80
81
82
83
84
85
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 78

def refund(amount, authorization, options = {})
  post = {}
  add_invoice(post, amount, options)
  add_reference(post, authorization)
  add_payment_type(post, authorization)

  commit('refund', post)
end

#scrub(transcript) ⇒ Object


129
130
131
132
133
134
135
136
137
138
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 129

def scrub(transcript)
  transcript.
    gsub(%r((password=)[^&\n]*), '\1[FILTERED]').
    gsub(%r((security_key=)[^&\n]*), '\1[FILTERED]').
    gsub(%r((ccnumber=)\d+), '\1[FILTERED]').
    gsub(%r((cvv=)\d+), '\1[FILTERED]').
    gsub(%r((checkaba=)\d+), '\1[FILTERED]').
    gsub(%r((checkaccount=)\d+), '\1[FILTERED]').
    gsub(%r((cryptogram=)[^&]+(&?)), '\1[FILTERED]\2')
end

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


109
110
111
112
113
114
115
116
117
118
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 109

def store(payment_method, options = {})
  post = {}
  add_invoice(post, nil, options)
  add_payment_method(post, payment_method, options)
  add_customer_data(post, options)
  add_vendor_data(post, options)
  add_merchant_defined_fields(post, options)

  commit('add_customer', post)
end

#supports_network_tokenization?Boolean

Returns:

  • (Boolean)

140
141
142
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 140

def supports_network_tokenization?
  true
end

#supports_scrubbing?Boolean

Returns:

  • (Boolean)

125
126
127
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 125

def supports_scrubbing?
  true
end

#verify(payment_method, options = {}) ⇒ Object


98
99
100
101
102
103
104
105
106
107
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 98

def verify(payment_method, options = {})
  post = {}
  add_payment_method(post, payment_method, options)
  add_customer_data(post, options)
  add_vendor_data(post, options)
  add_merchant_defined_fields(post, options)
  add_level3_fields(post, options)

  commit('validate', post)
end

#verify_credentialsObject


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

def verify_credentials
  response = void('0')
  response.message != 'Authentication Failed'
end

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


70
71
72
73
74
75
76
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 70

def void(authorization, options = {})
  post = {}
  add_reference(post, authorization)
  add_payment_type(post, authorization)

  commit('void', post)
end