Class: ActiveMerchant::Billing::SagePayGateway

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

Constant Summary collapse

APPROVED =
'OK'
TRANSACTIONS =
{
  :purchase => 'PAYMENT',
  :credit => 'REFUND',
  :authorization => 'DEFERRED',
  :capture => 'RELEASE',
  :void => 'VOID',
  :abort => 'ABORT',
  :store => 'TOKEN',
  :unstore => 'REMOVETOKEN',
  :repeat => 'REPEAT'
}
CREDIT_CARDS =
{
  :visa => "VISA",
  :master => "MC",
  :delta => "DELTA",
  :solo => "SOLO",
  :switch => "MAESTRO",
  :maestro => "MAESTRO",
  :american_express => "AMEX",
  :electron => "UKE",
  :diners_club => "DC",
  :jcb => "JCB"
}
AVS_CODE =
{
  "NOTPROVIDED" => nil,
  "NOTCHECKED" => 'X',
  "MATCHED" => 'Y',
  "NOTMATCHED" => 'N'
}
CVV_CODE =
{
  "NOTPROVIDED" => 'S',
  "NOTCHECKED" => 'X',
  "MATCHED" => 'M',
  "NOTMATCHED" => 'N'
}
OPTIONAL_REQUEST_FIELDS =
{
  paypal_callback_url: :PayPalCallbackURL,
  basket: :Basket,
  gift_aid_payment: :GiftAidPayment ,
  apply_avscv2: :ApplyAVSCV2 ,
  apply_3d_secure: :Apply3DSecure,
  account_type: :AccountType,
  billing_agreement: :BillingAgreement,
  basket_xml: :BasketXML,
  customer_xml: :CustomerXML,
  surcharge_xml: :SurchargeXML,
  vendor_data: :VendorData,
  language: :Language,
  website: :Website,
  recipient_account_number: :FIRecipientAcctNumber ,
  recipient_surname: :FIRecipientSurname ,
  recipient_postcode: :FIRecipientPostcode ,
  recipient_dob: :FIRecipientDoB
}

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 = {}) ⇒ SagePayGateway

Returns a new instance of SagePayGateway


81
82
83
84
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 81

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

Instance Method Details

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


101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 101

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

  post = {}

  add_amount(post, money, options)
  add_invoice(post, options)
  add_payment_method(post, payment_method, options)
  add_address(post, options)
  add_customer_data(post, options)
  add_optional_data(post, options)

  commit(:authorization, post)
end

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

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


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

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

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

  commit(:capture, post)
end

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


148
149
150
151
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 148

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

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


86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 86

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

  post = {}

  add_amount(post, money, options)
  add_invoice(post, options)
  add_payment_method(post, payment_method, options)
  add_address(post, options)
  add_customer_data(post, options)
  add_optional_data(post, options)

  commit((past_purchase_reference?(payment_method) ? :repeat : :purchase), post)
end

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

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


136
137
138
139
140
141
142
143
144
145
146
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 136

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

  post = {}

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

  commit(:credit, post)
end

#scrub(transcript) ⇒ Object


178
179
180
181
182
183
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 178

def scrub(transcript)
  transcript.
    gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
    gsub(%r((&?CardNumber=)\d+(&?)), '\1[FILTERED]\2').
    gsub(%r((&?CV2=)\d+(&?)), '\1[FILTERED]\2')
end

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


153
154
155
156
157
158
159
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 153

def store(credit_card, options = {})
  post = {}
  add_credit_card(post, credit_card)
  add_currency(post, 0, options)

  commit(:store, post)
end

#supports_scrubbingObject


174
175
176
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 174

def supports_scrubbing
  true
end

#unstore(token, options = {}) ⇒ Object


161
162
163
164
165
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 161

def unstore(token, options = {})
  post = {}
  add_token(post, token)
  commit(:unstore, post)
end

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


167
168
169
170
171
172
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 167

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) }
  end
end

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


126
127
128
129
130
131
132
133
# File 'lib/active_merchant/billing/gateways/sage_pay.rb', line 126

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

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

  commit(action, post)
end