Class: ActiveMerchant::Billing::AdyenGateway

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

Constant Summary collapse

PAYMENT_API_VERSION = 
'v68'
RECURRING_API_VERSION = 
'v68'
STANDARD_ERROR_CODE_MAPPING = 
{
  '0' => STANDARD_ERROR_CODE[:processing_error],
  '10' => STANDARD_ERROR_CODE[:config_error],
  '100' => STANDARD_ERROR_CODE[:invalid_amount],
  '101' => STANDARD_ERROR_CODE[:incorrect_number],
  '103' => STANDARD_ERROR_CODE[:invalid_cvc],
  '104' => STANDARD_ERROR_CODE[:incorrect_address],
  '131' => STANDARD_ERROR_CODE[:incorrect_address],
  '132' => STANDARD_ERROR_CODE[:incorrect_address],
  '133' => STANDARD_ERROR_CODE[:incorrect_address],
  '134' => STANDARD_ERROR_CODE[:incorrect_address],
  '135' => STANDARD_ERROR_CODE[:incorrect_address]
}

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

Methods included from CreditCardFormatting

#expdate, #format, #strftime_yyyymm

Methods included from PostsData

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

Constructor Details

#initialize(options = {}) ⇒ AdyenGateway

Returns a new instance of AdyenGateway.



37
38
39
40
41
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 37

def initialize(options = {})
  requires!(options, :username, :password, :merchant_account)
  @username, @password, @merchant_account = options.values_at(:username, :password, :merchant_account)
  super
end

Instance Method Details

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



131
132
133
134
135
136
137
138
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 131

def adjust(money, authorization, options = {})
  post = init_post(options)
  add_invoice_for_modification(post, money, options)
  add_reference(post, authorization, options)
  add_extra_data(post, nil, options)
  add_recurring_detail_reference(post, options)
  commit('adjustAuthorisation', post, options)
end

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 54

def authorize(money, payment, options = {})
  requires!(options, :order_id)
  post = init_post(options)
  add_invoice(post, money, options)
  add_payment(post, payment, options)
  add_extra_data(post, payment, options)
  add_stored_credentials(post, payment, options)
  add_address(post, options)
  add_installments(post, options) if options[:installments]
  add_3ds(post, options)
  add_3ds_authenticated_data(post, options)
  add_splits(post, options)
  add_recurring_contract(post, options, payment)
  add_network_transaction_reference(post, options)
  add_application_info(post, options)
  add_level_2_data(post, options)
  add_level_3_data(post, options)
  add_data_airline(post, options)
  add_data_lodging(post, options)
  add_metadata(post, options)
  add_recurring_detail_reference(post, options)
  commit('authorise', post, options)
end

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



78
79
80
81
82
83
84
85
86
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 78

def capture(money, authorization, options = {})
  post = init_post(options)
  add_invoice_for_modification(post, money, options)
  add_reference(post, authorization, options)
  add_splits(post, options)
  add_network_transaction_reference(post, options)
  add_shopper_statement(post, options)
  commit('capture', post, options)
end

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 97

def credit(money, payment, options = {})
  action = options[:payout] ? 'payout' : 'refundWithData'
  post = init_post(options)
  add_invoice(post, money, options)
  add_payment(post, payment, options, action)
  add_shopper_reference(post, options)
  add_network_transaction_reference(post, options)

  if action == 'payout'
    add_shopper_interaction(post, payment, options)
    add_fraud_offset(post, options)
    add_fund_source(post, options)
    add_recurring_contract(post, options)
    add_shopper_data(post, payment, options)

    if (address = options[:billing_address] || options[:address]) && address[:country]
      add_billing_address(post, options, address)
    end

    post[:dateOfBirth] = options[:date_of_birth] if options[:date_of_birth]
    post[:nationality] = options[:nationality] if options[:nationality]
  end
  add_recurring_detail_reference(post, options)
  commit(action, post, options)
end

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



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 43

def purchase(money, payment, options = {})
  if options[:execute_threed] || options[:threed_dynamic]
    authorize(money, payment, options)
  else
    MultiResponse.run do |r|
      r.process { authorize(money, payment, options) }
      r.process { capture(money, r.authorization, capture_options(options)) }
    end
  end
end

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



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

def refund(money, authorization, options = {})
  post = init_post(options)
  add_invoice_for_modification(post, money, options)
  add_reference(post, authorization, options)
  add_splits(post, options)
  add_network_transaction_reference(post, options)
  commit('refund', post, options)
end

#scrub(transcript) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 191

def scrub(transcript)
  transcript.
    gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
    gsub(%r(("number\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
    gsub(%r(("cvc\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
    gsub(%r(("cavv\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
    gsub(%r(("bankLocationId\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
    gsub(%r(("iban\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]').
    gsub(%r(("bankAccountNumber\\?"\s*:\s*\\?")[^"]*)i, '\1[FILTERED]')
end

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 140

def store(credit_card, options = {})
  requires!(options, :order_id)
  post = init_post(options)
  add_invoice(post, 0, options)
  add_payment(post, credit_card, options)
  add_extra_data(post, credit_card, options)
  add_stored_credentials(post, credit_card, options)
  add_address(post, options)
  add_network_transaction_reference(post, options)
  options[:recurring_contract_type] ||= 'RECURRING'
  add_recurring_contract(post, options)

  action = options[:tokenize_only] ? 'storeToken' : 'authorise'

  initial_response = commit(action, post, options)

  if initial_response.success? && card_not_stored?(initial_response)
    unsupported_failure_response(initial_response)
  else
    initial_response
  end
end

#supports_network_tokenization? ⇒ Boolean

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 187

def supports_network_tokenization?
  true
end

#supports_scrubbing? ⇒ Boolean

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 183

def supports_scrubbing?
  true
end

#unstore(options = {}) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 163

def unstore(options = {})
  requires!(options, :shopper_reference, :recurring_detail_reference)
  post = {}

  add_shopper_reference(post, options)
  (post, options)
  post[:recurringDetailReference] = options[:recurring_detail_reference]

  commit('disable', post, options)
end

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



174
175
176
177
178
179
180
181
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 174

def verify(credit_card, options = {})
  amount = options[:verify_amount]&.to_i || 0
  MultiResponse.run(:use_first_response) do |r|
    r.process { authorize(amount, credit_card, options) }
    options[:idempotency_key] = nil
    r.process(:ignore_result) { void(r.authorization, options) }
  end
end

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



123
124
125
126
127
128
129
 
# File 'lib/active_merchant/billing/gateways/adyen.rb', line 123

def void(authorization, options = {})
  post = init_post(options)
  endpoint = options[:cancel_or_refund] ? 'cancelOrRefund' : 'cancel'
  add_reference(post, authorization, options)
  add_network_transaction_reference(post, options)
  commit(endpoint, post, options)
end