Package com.plaid.client.model

Class AccountBase

java.lang.Object
com.plaid.client.model.AccountBase
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class AccountBase
extends java.lang.Object
A single account at a financial institution.

  • Field Details

  • Constructor Details

  • Method Details

    • accountId

      public AccountBase accountId​(java.lang.String accountId)

    • getAccountId

      public java.lang.String getAccountId()
      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.
      Returns:
      accountId

    • setAccountId

      public void setAccountId​(java.lang.String accountId)

    • balances

      public AccountBase balances​(AccountBalance balances)

    • getBalances

      public AccountBalance getBalances()
      Get balances
      Returns:
      balances

    • setBalances

      public void setBalances​(AccountBalance balances)

    • mask

      public AccountBase mask​(java.lang.String mask)

    • getMask

      @Nullable public java.lang.String getMask()
      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.
      Returns:
      mask

    • setMask

      public void setMask​(java.lang.String mask)

    • name

      public AccountBase name​(java.lang.String name)

    • getName

      public java.lang.String getName()
      The name of the account, either assigned by the user or by the financial institution itself
      Returns:
      name

    • setName

      public void setName​(java.lang.String name)

    • officialName

      public AccountBase officialName​(java.lang.String officialName)

    • getOfficialName

      @Nullable public java.lang.String getOfficialName()
      The official name of the account as given by the financial institution
      Returns:
      officialName

    • setOfficialName

      public void setOfficialName​(java.lang.String officialName)

    • type

      public AccountBase type​(AccountType type)

    • getType

      public AccountType getType()
      Get type
      Returns:
      type

    • setType

      public void setType​(AccountType type)

    • subtype

      public AccountBase subtype​(AccountSubtype subtype)

    • getSubtype

      @Nullable public AccountSubtype getSubtype()
      Get subtype
      Returns:
      subtype

    • setSubtype

      public void setSubtype​(AccountSubtype subtype)

    • verificationStatus

      public AccountBase verificationStatus​(AccountBase.VerificationStatusEnum verificationStatus)

    • getVerificationStatus

      @Nullable public AccountBase.VerificationStatusEnum getVerificationStatus()
      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 two amounts. `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.
      Returns:
      verificationStatus

    • setVerificationStatus

      public void setVerificationStatus​(AccountBase.VerificationStatusEnum verificationStatus)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object