Class: Plaid::NumbersACH

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/numbers_ach.rb

Overview

Identifying information for transferring money to or from a US account via ACH or wire transfer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NumbersACH

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
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
122
 
# File 'lib/plaid/models/numbers_ach.rb', line 82

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::NumbersACH` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::NumbersACH`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.key?(:'account')
    self. = attributes[:'account']
  end

  if attributes.key?(:'is_tokenized_account_number')
    self. = attributes[:'is_tokenized_account_number']
  end

  if attributes.key?(:'routing')
    self.routing = attributes[:'routing']
  end

  if attributes.key?(:'wire_routing')
    self.wire_routing = attributes[:'wire_routing']
  end

  if attributes.key?(:'can_transfer_in')
    self.can_transfer_in = attributes[:'can_transfer_in']
  end

  if attributes.key?(:'can_transfer_out')
    self.can_transfer_out = attributes[:'can_transfer_out']
  end
end

Instance Attribute Details

#account ⇒ Object

The ACH account number for the account. At certain institutions, including Chase, PNC, and (coming May 2025) US Bank, you will receive "tokenized" routing and account numbers, which are not the user’s actual account and routing numbers. For important details on how this may impact your integration and on how to avoid fraud, user confusion, and ACH returns, see [Tokenized account numbers](plaid.com/docs/auth/#tokenized-account-numbers).



23
24
25
 
# File 'lib/plaid/models/numbers_ach.rb', line 23

def 
  @account
end

#account_id ⇒ Object

The Plaid account ID associated with the account numbers



20
21
22
 
# File 'lib/plaid/models/numbers_ach.rb', line 20

def 
  @account_id
end

#can_transfer_in ⇒ Object

Whether the account supports ACH transfers into the account



35
36
37
 
# File 'lib/plaid/models/numbers_ach.rb', line 35

def can_transfer_in
  @can_transfer_in
end

#can_transfer_out ⇒ Object

Whether the account supports ACH transfers out of the account



38
39
40
 
# File 'lib/plaid/models/numbers_ach.rb', line 38

def can_transfer_out
  @can_transfer_out
end

#is_tokenized_account_number ⇒ Object

Indicates whether the account number is tokenized by the institution. For important details on how tokenized account numbers may impact your integration, see [Tokenized account numbers](plaid.com/docs/auth/#tokenized-account-numbers).



26
27
28
 
# File 'lib/plaid/models/numbers_ach.rb', line 26

def 
  @is_tokenized_account_number
end

#routing ⇒ Object

The ACH routing number for the account. This may be a tokenized routing number. For more information, see [Tokenized account numbers](plaid.com/docs/auth/#tokenized-account-numbers).



29
30
31
 
# File 'lib/plaid/models/numbers_ach.rb', line 29

def routing
  @routing
end

#wire_routing ⇒ Object

The wire transfer routing number for the account. This field is only populated if the institution is known to use a separate wire transfer routing number. Many institutions do not have a separate wire routing number and use the ACH routing number for wires instead. It is recommended to have the end user manually confirm their wire routing number before sending any wires to their account, especially if this field is ‘null`.



32
33
34
 
# File 'lib/plaid/models/numbers_ach.rb', line 32

def wire_routing
  @wire_routing
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/plaid/models/numbers_ach.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/plaid/models/numbers_ach.rb', line 41

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'account' => :'account',
    :'is_tokenized_account_number' => :'is_tokenized_account_number',
    :'routing' => :'routing',
    :'wire_routing' => :'wire_routing',
    :'can_transfer_in' => :'can_transfer_in',
    :'can_transfer_out' => :'can_transfer_out'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



181
182
183
 
# File 'lib/plaid/models/numbers_ach.rb', line 181

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
76
77
78
 
# File 'lib/plaid/models/numbers_ach.rb', line 72

def self.openapi_nullable
  Set.new([
    :'wire_routing',
    :'can_transfer_in',
    :'can_transfer_out'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/plaid/models/numbers_ach.rb', line 59

def self.openapi_types
  {
    :'account_id' => :'String',
    :'account' => :'String',
    :'is_tokenized_account_number' => :'Boolean',
    :'routing' => :'String',
    :'wire_routing' => :'String',
    :'can_transfer_in' => :'Boolean',
    :'can_transfer_out' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/plaid/models/numbers_ach.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
       == o. &&
      routing == o.routing &&
      wire_routing == o.wire_routing &&
      can_transfer_in == o.can_transfer_in &&
      can_transfer_out == o.can_transfer_out
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/plaid/models/numbers_ach.rb', line 212

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/plaid/models/numbers_ach.rb', line 283

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/plaid/models/numbers_ach.rb', line 188

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/plaid/models/numbers_ach.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/plaid/models/numbers_ach.rb', line 174

def hash
  [, , , routing, wire_routing, can_transfer_in, can_transfer_out].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/plaid/models/numbers_ach.rb', line 126

def list_invalid_properties
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @account.nil?
    invalid_properties.push('invalid value for "account", account cannot be nil.')
  end

  if @routing.nil?
    invalid_properties.push('invalid value for "routing", routing cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



259
260
261
 
# File 'lib/plaid/models/numbers_ach.rb', line 259

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/plaid/models/numbers_ach.rb', line 265

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



253
254
255
 
# File 'lib/plaid/models/numbers_ach.rb', line 253

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



145
146
147
148
149
150
 
# File 'lib/plaid/models/numbers_ach.rb', line 145

def valid?
  return false if @account_id.nil?
  return false if @account.nil?
  return false if @routing.nil?
  true
end