Class: ActiveMerchant::Billing::FlowGateway

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

Constant Summary collapse

VERSION = 
File.read(File.expand_path("../../../../.version", File.dirname(__FILE__))).chomp
FORM_TYPES = 
[
  :authorization_copy_form, :direct_authorization_form, :merchant_of_record_authorization_form,
  :paypal_authorization_form, :redirect_authorization_form, :inline_authorization_form,
  :card_authorization_form, :ach_authorization_form
]

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ FlowGateway

Returns a new instance of FlowGateway.

Raises:

  • (ArgumentError) 


26
27
28
29
30
31
32
33
34
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 26

def initialize options = {}
  @flow_api_key      = options[:api_key]      || ENV['FLOW_API_KEY']
  @flow_organization = options[:organization] || ENV['FLOW_ORGANIZATION']

  raise ArgumentError, "Flow token is not defined (:api_key or ENV['FLOW_API_KEY'])" unless @flow_api_key
  raise ArgumentError, "Flow organization is not defined (:organization or ENV['FLOW_ORGANIZATION'])" unless @flow_organization

  super
end

Instance Method Details

#authorize(cc_or_token, order_number, opts = {}) ⇒ Object

Create a new authorization. docs.flow.io/module/payment/resource/authorizations#post-organization-authorizations



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 38

def authorize cc_or_token, order_number, opts={}
  unless opts[:currency]
    return error_response('Currency is a required option')
  end

  unless opts[:discriminator]
    return error_response 'Discriminator is not defined, please choose one [%s]' % FORM_TYPES.join(', ')
  end

  unless FORM_TYPES.include?(opts[:discriminator].to_sym)
    return error_response 'Discriminator [%s] not found, please choose one [%s]' % [opts[:discriminator], FORM_TYPES.join(', ')]
  end

  body = {
    amount:        opts[:amount] || 0.0,
    currency:      opts[:currency],
    discriminator: opts[:discriminator],
    token:         store(cc_or_token),
    order_number:  order_number
  }

  response = flow_instance.authorizations.post @flow_organization, body

  Response.new true, 'Flow authorize - Success', { response: response }, { authorization: response.id }
rescue => exception
  error_response exception
end

#capture(amount, authorization_key, options = {}) ⇒ Object

docs.flow.io/module/payment/resource/captures#post-organization-captures



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 75

def capture amount, authorization_key, options={}
  return error_response('Currency is a required option') unless options[:currency]

  body = {
    authorization_id: authorization_key,
    amount:           amount,
    currency:         options[:currency]
  }

  begin
    capture_form = ::Io::Flow::V0::Models::CaptureForm.new body
    response     = flow_instance.captures.post @flow_organization, capture_form
  rescue => exception
    error_response exception
  end

  if response.try(:id)
    Response.new true, 'Flow capture - Success', { response: response }
  else
    Response.new false, 'Flow capture - Error', { response: response }
  end
rescue Io::Flow::V0::HttpClient::ServerError => exception
  error_response exception
end

#flow_create_order(body, query_string = {}) ⇒ Object

Creates and order docs.flow.io/module/localization/resource/orders#post-organization-orders



195
196
197
198
199
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 195

def flow_create_order body, query_string={}
  flow_instance.orders.post @flow_organization, body, query_string
rescue => exception
  error_response exception
end

#flow_get_authorization(order_number:) ⇒ Object

docs.flow.io/module/payment/resource/authorizations#get-organization-authorizations



67
68
69
70
71
72
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 67

def flow_get_authorization order_number:
  response = flow_instance.authorizations.get @flow_organization, order_number: order_number
  response.last
rescue => exception
  error_response exception
end

#flow_submission_by_number(order_number) ⇒ Object

Submits an order and pushes all subsequent authorizations from status “review” to “authorized” takes ~ 60 seconds



204
205
206
207
208
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 204

def flow_submission_by_number order_number
  flow_instance.orders.put_submissions_by_number @flow_organization, order_number
rescue => exception
  error_response exception
end

#purchase(credit_card, order_number, options = {}) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 100

def purchase credit_card, order_number, options={}
  auth_response = flow_get_authorization order_number: order_number

  if auth_response
    capture options[:amount], auth_response.key, options
  else
    error_response 'No authorization for order: %s' % order_number
  end
rescue Io::Flow::V0::HttpClient::ServerError => exception
  error_response exception
end

#refund(amount, capture_id, options = {}) ⇒ Object

docs.flow.io/module/payment/resource/refunds authorization_id - The Id of the authorization against which to issue the refund. If specified, we will look at all captures for this authorization, selecting 1 or more captures against which to issue the refund of the requested amount. capture_id - The Id of the capture against which to issue the refund. If specified, we will only consider this capture. order_number - The order number if specified during authorization. If specified, we will lookup all authorizations made against this order number, and then selecting 1 or more authorizations against which to issue the refund of the requested amount. amount - The amount to refund, in the currency of the associated capture. Defaults to the value of the capture minus any prior refunds. currency - The ISO 4217-3 code for the currency. Required if amount is specified. Case insensitive. Note you will get an error if the currency does not match the related authrization’s currency. See api.flow.io/reference/currencies rma_key - The RMA key, if available. If specified, this will udpate the RMA status as refunded.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 135

def refund amount, capture_id, options={}
  options[:capture_id] = capture_id if capture_id

  if amount
    options[:amount] = assert_currency options[:currency], amount
  end

  response = flow_instance.refunds.post @flow_organization, options

  if response.try(:id)
    Response.new true, 'Flow refund - Success', { response: response }
  else
    Response.new false, 'Flow refund - Error', { response: response }
  end
rescue Io::Flow::V0::HttpClient::ServerError => exception
  error_response exception
end

#store(input) ⇒ Object

stores credit card and returns credit card Flow token String id



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 154

def store input
  credit_card =
  case input
    when Hash
      # ActiveMerchant::Billing::CreditCard does not support "address" field
      # so we have to capture it manualy
      # format - https://docs.flow.io/type/billing-address
      @address = credit_card.delete(:address)

      ActiveMerchant::Billing::CreditCard.new input
    when ActiveMerchant::Billing::CreditCard
      input
    when String
      # if it is a String then it allready is a token
      return input
    else
      raise 'Unsuported store method input type [%s]' % input.class
  end

  data = {    number: credit_card.number,
                name: '%s %s' % [credit_card.first_name, credit_card.last_name],
                 cvv: credit_card.verification_value,
     expiration_year: credit_card.year.to_i,
    expiration_month: credit_card.month.to_i
  }

  data[:address] = @address if @address

  response  = flow_instance.cards.post @flow_organization, data

  if response.respond_to?(:token)
    response.token
  else
    Response.new false, 'Flow POST /:organization/cards - Failure', { response: response }
  end
rescue Io::Flow::V0::HttpClient::ServerError => exception
  error_response exception
end

#void(amount, authorization_id, options = {}) ⇒ Object

docs.flow.io/module/payment/resource/reversals#post-organization-reversals if amount is not provided, reverse the full or remaining amount



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/active_merchant/billing/gateways/flow.rb', line 114

def void amount, authorization_id, options={}
  options[:authorization_id] = authorization_id

  if amount
    options[:amount] = assert_currency options[:currency], amount
  end

  response = flow_instance.reversals.post @flow_organization, options

  Response.new true, 'void success', { response: response }
rescue Io::Flow::V0::HttpClient::ServerError => exception
  error_response exception
end