Class: ActiveMerchant::Billing::WorldpayGateway

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

Constant Summary collapse

CARD_CODES = 
{
  'visa'             => 'VISA-SSL',
  'master'           => 'ECMC-SSL',
  'discover'         => 'DISCOVER-SSL',
  'american_express' => 'AMEX-SSL',
  'jcb'              => 'JCB-SSL',
  'maestro'          => 'MAESTRO-SSL',
  'laser'            => 'LASER-SSL',
  'diners_club'      => 'DINERS-SSL',
  'switch'           => 'MAESTRO-SSL'
}

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

Instance Method Summary collapse

Methods inherited from Gateway

#card_brand, card_brand, #generate_unique_id, inherited, supported_countries, #supported_countries, supported_countries=, supports?, #supports_network_tokenization?, #supports_scrubbing?, #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 = {}) ⇒ WorldpayGateway

Returns a new instance of WorldpayGateway.



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

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

Instance Method Details

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



40
41
42
43
 
# File 'lib/active_merchant/billing/gateways/worldpay.rb', line 40

def authorize(money, payment_method, options = {})
  requires!(options, :order_id)
  authorize_request(money, payment_method, options)
end

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



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/active_merchant/billing/gateways/worldpay.rb', line 45

def capture(money, authorization, options = {})
  MultiResponse.run do |r|
    r.process{inquire_request(authorization, options, 'AUTHORISED')} unless options[:authorization_validated]
    if r.params
      authorization_currency = r.params['amount_currency_code']
      options = options.merge(:currency => authorization_currency) if authorization_currency.present?
    end
    r.process{capture_request(money, authorization, options)}
  end
end

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

Credits only function on a Merchant ID/login/profile flagged for Payouts

aka Credit Fund Transfers (CFT), whereas normal purchases, refunds,
and other transactions should be performed on a normal eCom-flagged
merchant ID.



79
80
81
 
# File 'lib/active_merchant/billing/gateways/worldpay.rb', line 79

def credit(money, payment_method, options = {})
  credit_request(money, payment_method, options.merge(:credit => true))
end

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



33
34
35
36
37
38
 
# File 'lib/active_merchant/billing/gateways/worldpay.rb', line 33

def purchase(money, payment_method, options = {})
  MultiResponse.run do |r|
    r.process{authorize(money, payment_method, options)}
    r.process{capture(money, r.authorization, options.merge(:authorization_validated => true))}
  end
end

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



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

def refund(money, authorization, options = {})
  response = MultiResponse.run do |r|
    r.process { inquire_request(authorization, options, 'CAPTURED', 'SETTLED', 'SETTLED_BY_MERCHANT') }
    r.process { refund_request(money, authorization, options) }
  end

  return response if response.success?
  return response unless options[:force_full_refund_if_unsettled]

  void(authorization, options ) if response.params['last_event'] == 'AUTHORISED'
end

#scrub(transcript) ⇒ Object 



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

def scrub(transcript)
  transcript.
    gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
    gsub(%r((<cardNumber>)\d+(</cardNumber>)), '\1[FILTERED]\2').
    gsub(%r((<cvc>)[^<]+(</cvc>)), '\1[FILTERED]\2')
end

#supports_scrubbing ⇒ Object 



90
91
92
 
# File 'lib/active_merchant/billing/gateways/worldpay.rb', line 90

def supports_scrubbing
  true
end

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



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

def verify(credit_card, options={})
  MultiResponse.run(:use_first_response) do |r|
    r.process { authorize(100, credit_card, options) }
    r.process(:ignore_result) { void(r.authorization, options.merge(:authorization_validated => true)) }
  end
end

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



56
57
58
59
60
61
 
# File 'lib/active_merchant/billing/gateways/worldpay.rb', line 56

def void(authorization, options = {})
  MultiResponse.run do |r|
    r.process{inquire_request(authorization, options, 'AUTHORISED')} unless options[:authorization_validated]
    r.process{cancel_request(authorization, options)}
  end
end