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::DEBIT_CARDS, 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

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
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 25

def initialize(options = {})
  requires!(options, :login, :password)
  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


40
41
42
43
44
45
46
47
48
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 40

def authorize(amount, payment_method, options={})
  post = {}
  add_invoice(post, amount, options)
  add_payment_method(post, payment_method, options)
  add_customer_data(post, options)
  add_merchant_defined_fields(post, options)

  commit("auth", post)
end

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


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

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


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

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

  commit("credit", post)
end

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


30
31
32
33
34
35
36
37
38
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 30

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

  commit("sale", post)
end

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


67
68
69
70
71
72
73
74
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 67

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


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

def scrub(transcript)
  transcript.
    gsub(%r((password=)\w+), '\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


94
95
96
97
98
99
100
101
102
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 94

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

  commit("add_customer", post)
end

#supports_network_tokenization?Boolean

Returns:

  • (Boolean)

123
124
125
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 123

def supports_network_tokenization?
  true
end

#supports_scrubbing?Boolean

Returns:

  • (Boolean)

109
110
111
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 109

def supports_scrubbing?
  true
end

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


85
86
87
88
89
90
91
92
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 85

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

  commit("validate", post)
end

#verify_credentialsObject


104
105
106
107
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 104

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

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


59
60
61
62
63
64
65
# File 'lib/active_merchant/billing/gateways/nmi.rb', line 59

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

  commit("void", post)
end