Class: Braintree::TransactionGateway

Inherits:
Object
  • Object
show all
Includes:
BaseModule
Defined in:
lib/braintree/transaction_gateway.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseModule

included

Methods included from BaseModule::Methods

#copy_instance_variables_from_object, #return_object_or_raise, #set_instance_variables_from_hash, #singleton_class

Constructor Details

#initialize(gateway) ⇒ TransactionGateway

Returns a new instance of TransactionGateway.



5
6
7
8
9
 
# File 'lib/braintree/transaction_gateway.rb', line 5

def initialize(gateway)
  @gateway = gateway
  @config = gateway.config
  @config.assert_has_access_token_or_keys
end

Class Method Details

._adjust_authorization_signature ⇒ Object 



322
323
324
325
326
 
# File 'lib/braintree/transaction_gateway.rb', line 322

def self._adjust_authorization_signature
  [
    :amount
  ]
end

._clone_signature ⇒ Object 



188
189
190
 
# File 'lib/braintree/transaction_gateway.rb', line 188

def self._clone_signature
  [:amount, :channel, {:options => [:submit_for_settlement]}]
end

._create_signature ⇒ Object

NEXT_MAJOR_VERSION Remove venmo_sdk_payment_method_code, venmo_sdk_session, and three_d_secure_token The old venmo SDK class has been deprecated three_d_secure_token has been deprecated in favor of three_d_secure_authentication_id



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/braintree/transaction_gateway.rb', line 195

def self._create_signature
  [
    :amount, :billing_address_id, :channel, :currency_iso_code, :customer_id, :device_data,
    :discount_amount, :exchange_rate_quote_id, :foreign_retailer,
    :merchant_account_id, :order_id, :payment_method_nonce, :payment_method_token,
    :product_sku, :purchase_order_number, :service_fee_amount, :shared_billing_address_id,
    :shared_customer_id, :shared_payment_method_nonce, :shared_payment_method_token,
    :shared_shipping_address_id, :shipping_address_id, :shipping_amount, :shipping_tax_amount,
    :ships_from_postal_code, :tax_amount, :tax_exempt, :three_d_secure_authentication_id,:three_d_secure_token, #Deprecated
    :transaction_source, :type, :venmo_sdk_payment_method_code, # Deprecated
    :sca_exemption,
    {:apple_pay_card => [:number, :cardholder_name, :cryptogram, :expiration_month, :expiration_year, :eci_indicator]},
    {
      :billing => AddressGateway._shared_signature
    },
    {:credit_card => [:token, :cardholder_name, :cvv, :expiration_date, :expiration_month, :expiration_year, :number, {:payment_reader_card_details => [:encrypted_card_data, :key_serial_number]}, {:network_tokenization_attributes => [:cryptogram, :ecommerce_indicator, :token_requestor_id]}]},
    {:customer => [:id, :company, :email, :fax, :first_name, :last_name, :phone, :website]},
    {:custom_fields => :_any_key_},
    {:descriptor => [:name, :phone, :url]},
    {:external_vault => [
      :status,
      :previous_network_transaction_id,
    ]},
    {:google_pay_card => [:number, :cryptogram, :google_transaction_id, :expiration_month, :expiration_year, :source_card_type, :source_card_last_four, :eci_indicator]},
    {:industry => [
      :industry_type,
      {:data => [
        :country_code, :date_of_birth, :folio_number, :check_in_date, :check_out_date, :travel_package, :lodging_check_in_date, :lodging_check_out_date, :departure_date, :lodging_name, :room_rate, :room_tax,
        :passenger_first_name, :passenger_last_name, :passenger_middle_initial, :passenger_title, :issued_date, :travel_agency_name, :travel_agency_code, :ticket_number,
        :issuing_carrier_code, :customer_code, :fare_amount, :fee_amount, :tax_amount, :restricted_ticket, :no_show, :advanced_deposit, :fire_safe, :property_phone, :ticket_issuer_address, :arrival_date,
        {:legs => [
          :conjunction_ticket, :exchange_ticket, :coupon_number, :service_class, :carrier_code, :fare_basis_code, :flight_number, :departure_date, :departure_airport_code, :departure_time,
          :arrival_airport_code, :arrival_time, :stopover_permitted, :fare_amount, :fee_amount, :tax_amount, :endorsement_or_restrictions,
        ]},
        {:additional_charges => [
          :kind, :amount,
        ]},
      ]},
    ]},
    {:installments => [:count]},
    {:line_items => [:commodity_code, :description, :discount_amount, :image_url, :kind, :name, :product_code, :quantity, :tax_amount, :total_amount, :unit_amount, :unit_of_measure, :unit_tax_amount, :upc_code, :upc_type, :url]},
    {:options => [
      :add_billing_address_to_payment_method,
      {:amex_rewards => [:request_id, :points, :currency_amount, :currency_iso_code]},
      {:credit_card => [:account_type, :process_debit_as_credit]},
      :hold_in_escrow,
      :payee_id,
      :payee_email,
      {:paypal => [:custom_field, :description, :payee_id, :payee_email, :recipient_email,  {:recipient_phone => [:country_code, :national_number]}, {:supplementary_data => :_any_key_}]},
      {:processing_overrides => [:customer_email, :customer_first_name, :customer_last_name, :customer_tax_identifier]},
      :skip_advanced_fraud_checking,
      :skip_avs,
      :skip_cvv,
      :store_in_vault,
      :store_in_vault_on_success,
      :store_shipping_address_in_vault,
      :submit_for_settlement,
      {:three_d_secure => [:required]},
      {:venmo => [:profile_id]},
      :venmo_sdk_session, # Deprecated
    ]
    },
    {:paypal_account => [:email, :token, :paypal_data, :payee_id, :payee_email, :payer_id, :payment_id]},
    {:payment_facilitator => [
      :payment_facilitator_id,
      {:sub_merchant => [:reference_number, :tax_id, :legal_name,
        {:address => [ :street_address, :locality, :region, :country_code_alpha2, :postal_code,
          {:international_phone => [:country_code, :national_number
          ]}
        ]}
      ]}
    ]},
    {:risk_data => [:customer_browser, :customer_device_id, :customer_ip, :customer_location_zip, :customer_tenure]},
    {
      :shipping => AddressGateway._shared_signature + [:shipping_method],
    },
    {
      :three_d_secure_pass_thru => [
        :eci_flag,
        :cavv,
        :xid,
        :three_d_secure_version,
        :authentication_response,
        :directory_response,
        :cavv_algorithm,
        :ds_transaction_id,
      ]
    },
  ]
end

._package_tracking_request_signature ⇒ Object 



180
181
182
183
184
185
186
 
# File 'lib/braintree/transaction_gateway.rb', line 180

def self._package_tracking_request_signature
  [
    :carrier,
    {:line_items => [:commodity_code, :description, :discount_amount, :image_url, :kind, :name, :product_code, :quantity, :tax_amount, :total_amount, :unit_amount, :unit_of_measure, :unit_tax_amount, :upc_code, :upc_type, :url]},
    :notify_payer, :tracking_number,
  ]
end

._refund_signature ⇒ Object 



336
337
338
339
340
341
342
 
# File 'lib/braintree/transaction_gateway.rb', line 336

def self._refund_signature
  [
    :amount,
    :merchant_account_id,
    :order_id,
  ]
end

._submit_for_partial_settlement_signature ⇒ Object 



316
317
318
319
320
 
# File 'lib/braintree/transaction_gateway.rb', line 316

def self._submit_for_partial_settlement_signature
  _submit_for_settlement_signature + [
    :final_capture
  ]
end

._submit_for_settlement_signature ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/braintree/transaction_gateway.rb', line 286

def self._submit_for_settlement_signature
  [
    :order_id,
    {:descriptor => [:name, :phone, :url]},
    {:industry => [
      :industry_type,
      {:data => [
        :country_code, :date_of_birth, :folio_number, :check_in_date, :check_out_date, :travel_package, :lodging_check_in_date, :lodging_check_out_date, :departure_date, :lodging_name, :room_rate, :room_tax,
        :passenger_first_name, :passenger_last_name, :passenger_middle_initial, :passenger_title, :issued_date, :travel_agency_name, :travel_agency_code, :ticket_number,
        :issuing_carrier_code, :customer_code, :fare_amount, :fee_amount, :tax_amount, :restricted_ticket, :no_show, :advanced_deposit, :fire_safe, :property_phone, :ticket_issuer_address, :arrival_date,
        {:legs => [
          :conjunction_ticket, :exchange_ticket, :coupon_number, :service_class, :carrier_code, :fare_basis_code, :flight_number, :departure_date, :departure_airport_code, :departure_time,
          :arrival_airport_code, :arrival_time, :stopover_permitted, :fare_amount, :fee_amount, :tax_amount, :endorsement_or_restrictions,
        ]},
        {:additional_charges => [
          :kind, :amount,
        ]},
      ]},
    ]},
    :purchase_order_number,
    :tax_amount,
    :tax_exempt,
    :discount_amount,
    :shipping_amount,
    :shipping_tax_amount,
    :ships_from_postal_code,
    :line_items => [:commodity_code, :description, :discount_amount, :image_url, :kind, :name, :product_code, :quantity, :tax_amount, :total_amount, :unit_amount, :unit_of_measure, :unit_tax_amount, :upc_code, :upc_type, :url],
  ]
end

._update_details_signature ⇒ Object 



328
329
330
331
332
333
334
 
# File 'lib/braintree/transaction_gateway.rb', line 328

def self._update_details_signature
  [
    :amount,
    :order_id,
    {:descriptor => [:name, :phone, :url]},
  ]
end

Instance Method Details

#_do_create(path, params = nil) ⇒ Object 



344
345
346
347
348
349
350
 
# File 'lib/braintree/transaction_gateway.rb', line 344

def _do_create(path, params=nil)
  if !params.nil?
    params = Util.replace_key(params, :google_pay_card, :android_pay_card)
  end
  response = @config.http.post("#{@config.base_merchant_path}#{path}", params)
  _handle_transaction_response(response)
end

#_fetch_transactions(search, ids) ⇒ Object 



352
353
354
355
356
357
 
# File 'lib/braintree/transaction_gateway.rb', line 352

def _fetch_transactions(search, ids)
  search.ids.in ids
  response = @config.http.post("#{@config.base_merchant_path}/transactions/advanced_search", {:search => search.to_hash})
  attributes = response[:credit_card_transactions]
  Util.extract_attribute_as_array(attributes, :transaction).map { |attrs| Transaction._new(@gateway, attrs) }
end

#_handle_transaction_response(response) ⇒ Object 



34
35
36
37
38
39
40
41
42
 
# File 'lib/braintree/transaction_gateway.rb', line 34

def _handle_transaction_response(response)
  if response[:transaction]
    SuccessfulResult.new(:transaction => Transaction._new(@gateway, response[:transaction]))
  elsif response[:api_error_response]
    ErrorResult.new(@gateway, response[:api_error_response])
  else
    raise UnexpectedError, "expected :transaction or :response"
  end
end

#adjust_authorization(transaction_id, amount) ⇒ Object

Raises:

  • (ArgumentError) 


140
141
142
143
144
145
146
 
# File 'lib/braintree/transaction_gateway.rb', line 140

def adjust_authorization(transaction_id, amount)
  raise ArgumentError, "transaction_id is invalid" unless transaction_id =~ /\A[0-9a-z]+\z/
  Util.verify_keys(TransactionGateway._adjust_authorization_signature, {})
  transaction_params = {:amount => amount}
  response = @config.http.put("#{@config.base_merchant_path}/transactions/#{transaction_id}/adjust_authorization", :transaction => transaction_params)
  _handle_transaction_response(response)
end

#adjust_authorization!(*args) ⇒ Object 



148
149
150
 
# File 'lib/braintree/transaction_gateway.rb', line 148

def adjust_authorization!(*args)
  return_object_or_raise(:transaction) { adjust_authorization(*args) }
end

#cancel_release(transaction_id) ⇒ Object

Raises:

  • (ArgumentError) 


24
25
26
27
28
 
# File 'lib/braintree/transaction_gateway.rb', line 24

def cancel_release(transaction_id)
  raise ArgumentError, "transaction_id is invalid" unless transaction_id =~ /\A[0-9a-z]+\z/
  response = @config.http.put("#{@config.base_merchant_path}/transactions/#{transaction_id}/cancel_release")
  _handle_transaction_response(response)
end

#cancel_release!(*args) ⇒ Object 



30
31
32
 
# File 'lib/braintree/transaction_gateway.rb', line 30

def cancel_release!(*args)
  return_object_or_raise(:transaction) { cancel_release(*args) }
end

#clone_transaction(transaction_id, attributes) ⇒ Object 



44
45
46
47
 
# File 'lib/braintree/transaction_gateway.rb', line 44

def clone_transaction(transaction_id, attributes)
  Util.verify_keys(TransactionGateway._clone_signature, attributes)
  _do_create "/transactions/#{transaction_id}/clone", :transaction_clone => attributes
end

#clone_transaction!(*args) ⇒ Object 



49
50
51
 
# File 'lib/braintree/transaction_gateway.rb', line 49

def clone_transaction!(*args)
  return_object_or_raise(:transaction) { clone_transaction(*args) }
end

#create(attributes) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/braintree/transaction_gateway.rb', line 11

def create(attributes)
  # NEXT_MAJOR_VERSION remove this check
  if attributes.has_key?(:venmo_sdk_payment_method_code) || attributes.has_key?(:venmo_sdk_session)
    warn "[DEPRECATED] The Venmo SDK integration is Unsupported. Please update your integration to use Pay with Venmo instead."
  end
  # NEXT_MAJOR_VERSION remove this check
  if attributes.has_key?(:three_d_secure_token)
    warn "[DEPRECATED] Passing :three_d_secure_token to create is deprecated. Please use :three_d_secure_authentication_id"
  end
  Util.verify_keys(TransactionGateway._create_signature, attributes)
  _do_create "/transactions", :transaction => attributes
end

#credit(attributes) ⇒ Object 



53
54
55
 
# File 'lib/braintree/transaction_gateway.rb', line 53

def credit(attributes)
  create(attributes.merge(:type => "credit"))
end

#credit!(*args) ⇒ Object 



57
58
59
 
# File 'lib/braintree/transaction_gateway.rb', line 57

def credit!(*args)
  return_object_or_raise(:transaction) { credit(*args) }
end

#find(id) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/braintree/transaction_gateway.rb', line 61

def find(id)
  raise ArgumentError, "id can not be empty" if id.nil? || id.strip.to_s == ""
  response = @config.http.get("#{@config.base_merchant_path}/transactions/#{id}")
  Transaction._new(@gateway, response[:transaction])
rescue NotFoundError
  raise NotFoundError, "transaction with id #{id.inspect} not found"
end

#package_tracking(transaction_id, package_tracking_request) ⇒ Object

Raises:

  • (ArgumentError) 


105
106
107
108
109
 
# File 'lib/braintree/transaction_gateway.rb', line 105

def package_tracking(transaction_id, package_tracking_request)
  raise ArgumentError, "transaction_id is invalid" unless transaction_id =~ /\A[0-9a-z]+\z/
  Util.verify_keys(TransactionGateway._package_tracking_request_signature, package_tracking_request)
  _do_create "/transactions/#{transaction_id}/shipments", :shipment => package_tracking_request
end

#package_tracking!(*args) ⇒ Object 



111
112
113
 
# File 'lib/braintree/transaction_gateway.rb', line 111

def package_tracking!(*args)
  return_object_or_raise(:transaction) { package_tracking(*args) }
end

#refund(transaction_id, amount_or_options = nil) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/braintree/transaction_gateway.rb', line 69

def refund(transaction_id, amount_or_options = nil)
  options = if amount_or_options.is_a?(Hash)
              amount_or_options
            else
              {:amount => amount_or_options}
            end

  Util.verify_keys(TransactionGateway._refund_signature, options)
  response = @config.http.post("#{@config.base_merchant_path}/transactions/#{transaction_id}/refund", :transaction => options)
  _handle_transaction_response(response)
end

#refund!(*args) ⇒ Object 



81
82
83
 
# File 'lib/braintree/transaction_gateway.rb', line 81

def refund!(*args)
  return_object_or_raise(:transaction) { refund(*args) }
end

#retry_subscription_charge(subscription_id, amount = nil, submit_for_settlement = false) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/braintree/transaction_gateway.rb', line 85

def retry_subscription_charge(subscription_id, amount=nil, submit_for_settlement=false)
  attributes = {
    :amount => amount,
    :subscription_id => subscription_id,
    :type => Transaction::Type::Sale,
    :options => {
      :submit_for_settlement => submit_for_settlement
    }
  }
  _do_create "/transactions", :transaction => attributes
end

#sale(attributes) ⇒ Object 



97
98
99
 
# File 'lib/braintree/transaction_gateway.rb', line 97

def sale(attributes)
  create(attributes.merge(:type => "sale"))
end

#sale!(*args) ⇒ Object 



101
102
103
 
# File 'lib/braintree/transaction_gateway.rb', line 101

def sale!(*args)
  return_object_or_raise(:transaction) { sale(*args) }
end

#search(&block) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/braintree/transaction_gateway.rb', line 115

def search(&block)
  search = TransactionSearch.new
  block.call(search) if block

  response = @config.http.post("#{@config.base_merchant_path}/transactions/advanced_search_ids", {:search => search.to_hash})

  if response.has_key?(:search_results)
    ResourceCollection.new(response) { |ids| _fetch_transactions(search, ids) }
  else
    raise UnexpectedError, "expected :search_results"
  end
end

#submit_for_partial_settlement(authorized_transaction_id, amount = nil, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


159
160
161
162
163
164
165
 
# File 'lib/braintree/transaction_gateway.rb', line 159

def submit_for_partial_settlement(authorized_transaction_id, amount = nil, options = {})
  raise ArgumentError, "authorized_transaction_id is invalid" unless authorized_transaction_id =~ /\A[0-9a-z]+\z/
  Util.verify_keys(TransactionGateway._submit_for_partial_settlement_signature, options)
  transaction_params = {:amount => amount}.merge(options)
  response = @config.http.post("#{@config.base_merchant_path}/transactions/#{authorized_transaction_id}/submit_for_partial_settlement", :transaction => transaction_params)
  _handle_transaction_response(response)
end

#submit_for_partial_settlement!(*args) ⇒ Object 



167
168
169
 
# File 'lib/braintree/transaction_gateway.rb', line 167

def submit_for_partial_settlement!(*args)
  return_object_or_raise(:transaction) { submit_for_partial_settlement(*args) }
end

#submit_for_settlement(transaction_id, amount = nil, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


128
129
130
131
132
133
134
 
# File 'lib/braintree/transaction_gateway.rb', line 128

def submit_for_settlement(transaction_id, amount = nil, options = {})
  raise ArgumentError, "transaction_id is invalid" unless transaction_id =~ /\A[0-9a-z]+\z/
  Util.verify_keys(TransactionGateway._submit_for_settlement_signature, options)
  transaction_params = {:amount => amount}.merge(options)
  response = @config.http.put("#{@config.base_merchant_path}/transactions/#{transaction_id}/submit_for_settlement", :transaction => transaction_params)
  _handle_transaction_response(response)
end

#submit_for_settlement!(*args) ⇒ Object 



136
137
138
 
# File 'lib/braintree/transaction_gateway.rb', line 136

def submit_for_settlement!(*args)
  return_object_or_raise(:transaction) { submit_for_settlement(*args) }
end

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

Raises:

  • (ArgumentError) 


152
153
154
155
156
157
 
# File 'lib/braintree/transaction_gateway.rb', line 152

def update_details(transaction_id, options = {})
  raise ArgumentError, "transaction_id is invalid" unless transaction_id =~ /\A[0-9a-z]+\z/
  Util.verify_keys(TransactionGateway._update_details_signature, options)
  response = @config.http.put("#{@config.base_merchant_path}/transactions/#{transaction_id}/update_details", :transaction => options)
  _handle_transaction_response(response)
end

#void(transaction_id) ⇒ Object 



171
172
173
174
 
# File 'lib/braintree/transaction_gateway.rb', line 171

def void(transaction_id)
  response = @config.http.put("#{@config.base_merchant_path}/transactions/#{transaction_id}/void")
  _handle_transaction_response(response)
end

#void!(*args) ⇒ Object 



176
177
178
 
# File 'lib/braintree/transaction_gateway.rb', line 176

def void!(*args)
  return_object_or_raise(:transaction) { void(*args) }
end