Class: Plaid::BusinessAccount

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

Overview

Business identity information about an account

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BusinessAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/plaid/models/business_account.rb', line 138

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::BusinessAccount` 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::BusinessAccount`. 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?(:'balances')
    self.balances = attributes[:'balances']
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'owners')
    if (value = attributes[:'owners']).is_a?(Array)
      self.owners = value
    end
  end
end

Instance Attribute Details

#account_id ⇒ Object

Plaid’s unique identifier for the account. This value will not change unless Plaid can’t reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new ‘account_id` will be assigned to the account. The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`. If an account with a specific `account_id` disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API. Like all Plaid identifiers, the `account_id` is case sensitive.



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

def 
  @account_id
end

#balances ⇒ Object

Returns the value of attribute balances.



22
23
24
 
# File 'lib/plaid/models/business_account.rb', line 22

def balances
  @balances
end

#holder_category ⇒ Object

Returns the value of attribute holder_category.



48
49
50
 
# File 'lib/plaid/models/business_account.rb', line 48

def holder_category
  @holder_category
end

#mask ⇒ Object

The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.



25
26
27
 
# File 'lib/plaid/models/business_account.rb', line 25

def mask
  @mask
end

#name ⇒ Object

The name of the account, either assigned by the user or by the financial institution itself



28
29
30
 
# File 'lib/plaid/models/business_account.rb', line 28

def name
  @name
end

#official_name ⇒ Object

The official name of the account as given by the financial institution



31
32
33
 
# File 'lib/plaid/models/business_account.rb', line 31

def official_name
  @official_name
end

#owners ⇒ Object

Data returned by the financial institution about the account owner or owners. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution. Multiple owners on a single account will be represented in the same owner object, not in multiple owner objects within the array.



51
52
53
 
# File 'lib/plaid/models/business_account.rb', line 51

def owners
  @owners
end

#persistent_account_id ⇒ Object

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This field is currently supported only for Items at institutions that use Tokenized Account Numbers (i.e., Chase and PNC, and in May 2025 US Bank). Because these accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify an account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field is populated for TAN-based institutions (‘ins_56`, `ins_13`) as well as the OAuth Sandbox institution (`ins_127287`); in Production, it will only be populated for accounts at applicable institutions.



46
47
48
 
# File 'lib/plaid/models/business_account.rb', line 46

def 
  @persistent_account_id
end

#subtype ⇒ Object

Returns the value of attribute subtype.



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

def subtype
  @subtype
end

#type ⇒ Object

Returns the value of attribute type.



33
34
35
 
# File 'lib/plaid/models/business_account.rb', line 33

def type
  @type
end

#verification_insights ⇒ Object

Returns the value of attribute verification_insights.



43
44
45
 
# File 'lib/plaid/models/business_account.rb', line 43

def verification_insights
  @verification_insights
end

#verification_name ⇒ Object

The account holder name that was used for micro-deposit and/or database verification. Only returned for Auth Items created via micro-deposit or database verification. This name was manually-entered by the user during Link, unless it was otherwise provided via the ‘user.legal_name` request field in `/link/token/create` for the Link session that created the Item.



41
42
43
 
# File 'lib/plaid/models/business_account.rb', line 41

def verification_name
  @verification_name
end

#verification_status ⇒ Object

The current verification status of an Auth Item initiated through micro-deposits or database verification. Returned for Auth Items only. ‘pending_automatic_verification`: The Item is pending automatic verification `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit. `automatically_verified`: The Item has successfully been automatically verified `manually_verified`: The Item has successfully been manually verified `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link. `unsent`: The Item is pending micro-deposit verification, but Plaid has not yet sent the micro-deposit. `database_matched`: The Item has successfully been verified using Plaid’s data sources. Only returned for Auth Items created via Database Match. ‘database_insights_pass`: The Item’s numbers have been verified using Plaid’s data sources: the routing and account number match a routing and account number of an account recognized on the Plaid network, and the account is not known by Plaid to be frozen or closed. Only returned for Auth Items created via Database Auth. ‘database_insights_pass_with_caution`:The Item’s numbers have been verified using Plaid’s data sources and have some signal for being valid: the routing and account number were not recognized on the Plaid network, but the routing number is valid and the account number is a potential valid account number for that routing number. Only returned for Auth Items created via Database Auth. ‘database_insights_fail`: The Item’s numbers have been verified using Plaid’s data sources and have signal for being invalid and/or have no signal for being valid. Typically this indicates that the routing number is invalid, the account number does not match the account number format associated with the routing number, or the account has been reported as closed or frozen. Only returned for Auth Items created via Database Auth.



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

def verification_status
  @verification_status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/plaid/models/business_account.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/plaid/models/business_account.rb', line 76

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'balances' => :'balances',
    :'mask' => :'mask',
    :'name' => :'name',
    :'official_name' => :'official_name',
    :'type' => :'type',
    :'subtype' => :'subtype',
    :'verification_status' => :'verification_status',
    :'verification_name' => :'verification_name',
    :'verification_insights' => :'verification_insights',
    :'persistent_account_id' => :'persistent_account_id',
    :'holder_category' => :'holder_category',
    :'owners' => :'owners'
  }
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



286
287
288
 
# File 'lib/plaid/models/business_account.rb', line 286

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



129
130
131
132
133
134
 
# File 'lib/plaid/models/business_account.rb', line 129

def self.openapi_all_of
  [
  :'AccountBase',
  :'BusinessAccountAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
123
124
125
126
 
# File 'lib/plaid/models/business_account.rb', line 119

def self.openapi_nullable
  Set.new([
    :'mask',
    :'official_name',
    :'subtype',
    :'holder_category',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/plaid/models/business_account.rb', line 100

def self.openapi_types
  {
    :'account_id' => :'String',
    :'balances' => :'AccountBalance',
    :'mask' => :'String',
    :'name' => :'String',
    :'official_name' => :'String',
    :'type' => :'AccountType',
    :'subtype' => :'AccountSubtype',
    :'verification_status' => :'String',
    :'verification_name' => :'String',
    :'verification_insights' => :'AccountVerificationInsights',
    :'persistent_account_id' => :'String',
    :'holder_category' => :'AccountHolderCategory',
    :'owners' => :'Array<Owner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/plaid/models/business_account.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      balances == o.balances &&
      mask == o.mask &&
      name == o.name &&
      official_name == o.official_name &&
      type == o.type &&
      subtype == o.subtype &&
      verification_status == o.verification_status &&
      verification_name == o.verification_name &&
      verification_insights == o.verification_insights &&
       == o. &&
      holder_category == o.holder_category &&
      owners == o.owners
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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/plaid/models/business_account.rb', line 317

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/plaid/models/business_account.rb', line 388

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/plaid/models/business_account.rb', line 293

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


273
274
275
 
# File 'lib/plaid/models/business_account.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



279
280
281
 
# File 'lib/plaid/models/business_account.rb', line 279

def hash
  [, balances, mask, name, official_name, type, subtype, verification_status, verification_name, verification_insights, , holder_category, owners].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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/plaid/models/business_account.rb', line 208

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 @balances.nil?
    invalid_properties.push('invalid value for "balances", balances cannot be nil.')
  end

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

  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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



364
365
366
 
# File 'lib/plaid/models/business_account.rb', line 364

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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/plaid/models/business_account.rb', line 370

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



358
359
360
 
# File 'lib/plaid/models/business_account.rb', line 358

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



231
232
233
234
235
236
237
238
239
 
# File 'lib/plaid/models/business_account.rb', line 231

def valid?
  return false if @account_id.nil?
  return false if @balances.nil?
  return false if @name.nil?
  return false if @type.nil?
  verification_status_validator = EnumAttributeValidator.new('String', ["automatically_verified", "pending_automatic_verification", "pending_manual_verification", "unsent", "manually_verified", "verification_expired", "verification_failed", "database_matched", "database_insights_pass", "database_insights_pass_with_caution", "database_insights_fail"])
  return false unless verification_status_validator.valid?(@verification_status)
  true
end