Struct AccountBase 

pub struct AccountBase {
    pub account_id: String,
    pub balances: AccountBalance,
    pub holder_category: Option<AccountHolderCategory>,
    pub mask: Option<String>,
    pub name: String,
    pub official_name: Option<String>,
    pub persistent_account_id: Option<String>,
    pub subtype: Option<AccountSubtype>,
    pub type_: AccountType,
    pub verification_insights: Option<AccountVerificationInsights>,
    pub verification_status: Option<String>,
}

A single account at a financial institution.

Fields

account_id: String

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.

balances: AccountBalance

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

holder_category: Option<AccountHolderCategory>

Indicates the account’s categorization as either a personal or a business account. This field is currently in beta; to request access, contact your account manager.

mask: Option<String>

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.

name: String

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

official_name: Option<String>

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

persistent_account_id: Option<String>

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). 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 may be populated for any account; in Production, it will only be populated for accounts at applicable institutions.

subtype: Option<AccountSubtype>

See the Account type schema for a full listing of account types and corresponding subtypes.

type_: AccountType

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.

credit: Credit card

depository: Depository account

loan: Loan account

other: Non-specified account type

See the Account type schema for a full listing of account types and corresponding subtypes.

verification_insights: Option<AccountVerificationInsights>

Insights from performing database verification for the account. Only returned for Auth Items created via Database Insights.

verification_status: Option<String>

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.

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 and have strong signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

database_insights_pass_with_caution: The Item’s numbers have been verified using Plaid’s data sources and have some signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

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. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.

Trait Implementations

impl Clone for AccountBase

fn clone(&self) -> AccountBase

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AccountBase

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AccountBase

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AccountBase

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for AccountBase

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.