Class: ActiveMerchant::Billing::SagePayGateway

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

Constant Summary

APPROVED =
'OK'
TRANSACTIONS =
{
  :purchase => 'PAYMENT',
  :credit => 'REFUND',
  :authorization => 'DEFERRED',
  :capture => 'RELEASE',
  :void => 'VOID',
  :abort => 'ABORT'
}
CREDIT_CARDS =
{
  :visa => "VISA",
  :master => "MC",
  :delta => "DELTA",
  :solo => "SOLO",
  :switch => "MAESTRO",
  :maestro => "MAESTRO",
  :american_express => "AMEX",
  :electron => "UKE",
  :diners_club => "DC",
  :jcb => "JCB"
}
ELECTRON =
/^(424519|42496[23]|450875|48440[6-8]|4844[1-5][1-5]|4917[3-5][0-9]|491880)\d{10}(\d{3})?$/
AVS_CVV_CODE =
{
  "NOTPROVIDED" => nil,
  "NOTCHECKED" => 'X',
  "MATCHED" => 'Y',
  "NOTMATCHED" => 'N'
}

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::CURRENCIES_WITHOUT_FRACTIONS, Gateway::DEBIT_CARDS

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary (collapse)

Methods inherited from Gateway

card_brand, #card_brand, inherited, supports?, #test?

Methods included from CreditCardFormatting

#format

Constructor Details

- (SagePayGateway) initialize(options = {})

Returns a new instance of SagePayGateway



53
54
55
56
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 53

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

Instance Method Details

- (Object) authorize(money, credit_card, options = {})



73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 73

def authorize(money, credit_card, options = {})
  requires!(options, :order_id)

  post = {}

  add_amount(post, money, options)
  add_invoice(post, options)
  add_credit_card(post, credit_card)
  add_address(post, options)
  add_customer_data(post, options)
  add_optional_data(post, options)

  commit(:authorization, post)
end

- (Object) capture(money, identification, options = {})

You can only capture a transaction once, even if you didn't capture the full amount the first time.



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

def capture(money, identification, options = {})
  post = {}

  add_reference(post, identification)
  add_release_amount(post, money, options)

  commit(:capture, post)
end

- (Object) credit(money, identification, options = {})



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

def credit(money, identification, options = {})
  deprecated CREDIT_DEPRECATION_MESSAGE
  refund(money, identification, options)
end

- (Object) purchase(money, credit_card, options = {})



58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 58

def purchase(money, credit_card, options = {})
  requires!(options, :order_id)

  post = {}

  add_amount(post, money, options)
  add_invoice(post, options)
  add_credit_card(post, credit_card)
  add_address(post, options)
  add_customer_data(post, options)
  add_optional_data(post, options)

  commit(:purchase, post)
end

- (Object) refund(money, identification, options = {})

Refunding requires a new order_id to passed in, as well as a description



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

def refund(money, identification, options = {})
  requires!(options, :order_id, :description)

  post = {}

  add_credit_reference(post, identification)
  add_amount(post, money, options)
  add_invoice(post, options)

  commit(:credit, post)
end

- (Object) void(identification, options = {})



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

def void(identification, options = {})
  post = {}

  add_reference(post, identification)
  action = abort_or_void_from(identification)

  commit(action, post)
end