Class: ActiveMerchant::Billing::HpsGateway

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

Constant Summary collapse

PAYMENT_DATA_SOURCE_MAPPING = 
{
  apple_pay:        'ApplePay',
  master:           'MasterCard 3DSecure',
  visa:             'Visa 3DSecure',
  american_express: 'AMEX 3DSecure',
  discover:         'Discover 3DSecure',
  android_pay:      'GooglePayApp',
  google_pay:       'GooglePayApp'
}

Constants inherited from Gateway

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

Instance Attribute Summary

Attributes inherited from Gateway

#options

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?, #supports_network_tokenization?

Methods included from CreditCardFormatting

#expdate, #format

Methods included from PostsData

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

Constructor Details

#initialize(options = {}) ⇒ HpsGateway

Returns a new instance of HpsGateway.



28
29
30
31
 
# File 'lib/active_merchant/billing/gateways/hps.rb', line 28

def initialize(options = {})
  requires!(options, :secret_api_key)
  super
end

Instance Method Details

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



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

def authorize(money, card_or_token, options = {})
  commit('CreditAuth') do |xml|
    add_amount(xml, money)
    add_allow_dup(xml)
    add_card_or_token_customer_data(xml, card_or_token, options)
    add_details(xml, options)
    add_descriptor_name(xml, options)
    add_card_or_token_payment(xml, card_or_token, options)
    add_three_d_secure(xml, card_or_token, options)
    add_stored_credentials(xml, options)
  end
end

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



46
47
48
49
50
51
 
# File 'lib/active_merchant/billing/gateways/hps.rb', line 46

def capture(money, transaction_id, options = {})
  commit('CreditAddToBatch', transaction_id) do |xml|
    add_amount(xml, money)
    add_reference(xml, transaction_id)
  end
end

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



73
74
75
76
77
78
79
80
 
# File 'lib/active_merchant/billing/gateways/hps.rb', line 73

def credit(money, payment_method, options = {})
  commit('CreditReturn') do |xml|
    add_amount(xml, money)
    add_allow_dup(xml)
    add_card_or_token_payment(xml, payment_method, options)
    add_details(xml, options)
  end
end

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



53
54
55
56
57
58
59
60
61
 
# File 'lib/active_merchant/billing/gateways/hps.rb', line 53

def purchase(money, payment_method, options = {})
  if payment_method.is_a?(Check)
    commit_check_sale(money, payment_method, options)
  elsif options.dig(:stored_credential, :reason_type) == 'recurring'
    commit_recurring_billing_sale(money, payment_method, options)
  else
    commit_credit_sale(money, payment_method, options)
  end
end

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



63
64
65
66
67
68
69
70
71
 
# File 'lib/active_merchant/billing/gateways/hps.rb', line 63

def refund(money, transaction_id, options = {})
  commit('CreditReturn') do |xml|
    add_amount(xml, money)
    add_allow_dup(xml)
    add_reference(xml, transaction_id)
    add_card_or_token_customer_data(xml, transaction_id, options)
    add_details(xml, options)
  end
end

#scrub(transcript) ⇒ Object 



106
107
108
109
110
111
112
113
114
 
# File 'lib/active_merchant/billing/gateways/hps.rb', line 106

def scrub(transcript)
  transcript.
    gsub(%r((<hps:CardNbr>)[^<]*(<\/hps:CardNbr>))i, '\1[FILTERED]\2').
    gsub(%r((<hps:CVV2>)[^<]*(<\/hps:CVV2>))i, '\1[FILTERED]\2').
    gsub(%r((<hps:SecretAPIKey>)[^<]*(<\/hps:SecretAPIKey>))i, '\1[FILTERED]\2').
    gsub(%r((<hps:PaymentData>)[^<]*(<\/hps:PaymentData>))i, '\1[FILTERED]\2').
    gsub(%r((<hps:RoutingNumber>)[^<]*(<\/hps:RoutingNumber>))i, '\1[FILTERED]\2').
    gsub(%r((<hps:AccountNumber>)[^<]*(<\/hps:AccountNumber>))i, '\1[FILTERED]\2')
end

#supports_scrubbing? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_scrubbing?
  true
end

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



82
83
84
85
86
87
88
 
# File 'lib/active_merchant/billing/gateways/hps.rb', line 82

def verify(card_or_token, options = {})
  commit('CreditAccountVerify') do |xml|
    add_card_or_token_customer_data(xml, card_or_token, options)
    add_descriptor_name(xml, options)
    add_card_or_token_payment(xml, card_or_token, options)
  end
end

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



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/active_merchant/billing/gateways/hps.rb', line 90

def void(transaction_id, options = {})
  if options[:check_void]
    commit('CheckVoid') do |xml|
      add_reference(xml, transaction_id)
    end
  else
    commit('CreditVoid') do |xml|
      add_reference(xml, transaction_id)
    end
  end
end