class

Plaid::AccountBase

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A single account at a financial institution.

Constants

ERROR_MESSAGE_FOR_VERIFICATION_STATUS = "invalid value for \"verification_status\", must be one of [automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched]."
VALID_VALUES_FOR_VERIFICATION_STATUS = String.static_array("automatically_verified", "pending_automatic_verification", "pending_manual_verification", "manually_verified", "verification_expired", "verification_failed", "database_matched")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account_id : String | Nil = nil, balances : AccountBalance | Nil = nil, mask : String | Nil = nil, name : String | Nil = nil, official_name : String | Nil = nil, _type : Plaid::AccountType | Nil = nil, subtype : Plaid::AccountSubtype | Nil = nil, verification_status : String | Nil = nil, persistent_account_id : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_type
Source
_type=(new_value : Plaid::AccountType | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

Source
account_id

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.

Source
account_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] account_id Object to be assigned

Source
balances
Source
balances=(new_value : AccountBalance | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] balances Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
mask

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, and it may also not match the mask that the bank displays to the user.

Source
mask=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] mask Object to be assigned

Source
name

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

Source
name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned

Source
official_name

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

Source
official_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] official_name Object to be assigned

Source
persistent_account_id

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 is currently an opt-in field and only supported for Chase Items.

Source
persistent_account_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] persistent_account_id Object to be assigned

Source
subtype
Source
subtype=(new_value : Plaid::AccountSubtype | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] subtype Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source
verification_status

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. 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. database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.

Source
verification_status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] verification_status Object to be assigned

Source