class Plaid::LinkSessionSuccessMetadataAccount
An account attached to the connected Item
.
Attributes
If micro-deposit verification was being used, indicates the user’s selection when asked if the account being verified is a ‘business` or `personal` account. This field is deprecated as Plaid
no longer collects this information during the micro-deposit flow. To see whether an account is business or personal, use the `holder_category` field instead.
The last 2-4 alphanumeric characters of an account’s official account number. Note that the mask may be non-unique between an Item’s accounts. It may also not match the mask that the bank displays to the user.
The official account name
The account subtype. See the [Account schema](/docs/api/accounts#account-type-schema) for a full list of possible values
The account type. See the [Account schema](/docs/api/accounts#account-type-schema) for a full list of possible values
Indicates an Item’s micro-deposit-based verification or database verification status. This field is only populated when using Auth and falling back to micro-deposit or database verification. Possible values are: ‘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 code. `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_insights_pending`: The Database Auth result is pending and will be available upon Auth request. `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. ‘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_matched`: (deprecated) The Item
has successfully been verified using Plaid’s data sources. Only returned for Auth Items created via Database Match. ‘null` or empty string: Neither micro-deposit-based verification nor database verification are being used for the Item
.
Public Class Methods
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 54 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 41 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'mask' => :'mask', :'type' => :'type', :'subtype' => :'subtype', :'verification_status' => :'verification_status', :'class_type' => :'class_type' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 166 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 82 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::LinkSessionSuccessMetadataAccount` 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::LinkSessionSuccessMetadataAccount`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'mask') self.mask = attributes[:'mask'] 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?(:'class_type') self.class_type = attributes[:'class_type'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 72 def self.openapi_nullable Set.new([ :'mask', :'verification_status', :'class_type' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 59 def self.openapi_types { :'id' => :'String', :'name' => :'String', :'mask' => :'String', :'type' => :'String', :'subtype' => :'String', :'verification_status' => :'String', :'class_type' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 139 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && mask == o.mask && type == o.type && subtype == o.subtype && verification_status == o.verification_status && class_type == o.class_type end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 197 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 268 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 173 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 153 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 159 def hash [id, name, mask, type, subtype, verification_status, class_type].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 126 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 250 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 238 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/link_session_success_metadata_account.rb, line 133 def valid? true end
Check to see if the all the properties in the model are valid @return true if the model is valid