AccountBase (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.AccountBase

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class AccountBase
extends Object

A single account at a financial institution.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AccountBase.VerificationStatusEnum` The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_BALANCES`
`static String`	`SERIALIZED_NAME_MASK`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_OFFICIAL_NAME`
`static String`	`SERIALIZED_NAME_PERSISTENT_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_SUBTYPE`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_VERIFICATION_STATUS`

Constructor Summary

Constructors
Constructor and Description

AccountBase()

Constructors
Constructor and Description
`AccountBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccountBase`	`accountId(String accountId)`
`AccountBase`	`balances(AccountBalance balances)`
`boolean`	`equals(Object o)`
`String`	`getAccountId()` Plaid’s unique identifier for the account.
`AccountBalance`	`getBalances()` Get balances
`String`	`getMask()` The last 2-4 alphanumeric characters of an account's official account number.
`String`	`getName()` The name of the account, either assigned by the user or by the financial institution itself
`String`	`getOfficialName()` The official name of the account as given by the financial institution
`String`	`getPersistentAccountId()` 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.
`AccountSubtype`	`getSubtype()` Get subtype
`AccountType`	`getType()` Get type
`AccountBase.VerificationStatusEnum`	`getVerificationStatus()` The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.
`int`	`hashCode()`
`AccountBase`	`mask(String mask)`
`AccountBase`	`name(String name)`
`AccountBase`	`officialName(String officialName)`
`AccountBase`	`persistentAccountId(String persistentAccountId)`
`void`	`setAccountId(String accountId)`
`void`	`setBalances(AccountBalance balances)`
`void`	`setMask(String mask)`
`void`	`setName(String name)`
`void`	`setOfficialName(String officialName)`
`void`	`setPersistentAccountId(String persistentAccountId)`
`void`	`setSubtype(AccountSubtype subtype)`
`void`	`setType(AccountType type)`
`void`	`setVerificationStatus(AccountBase.VerificationStatusEnum verificationStatus)`
`AccountBase`	`subtype(AccountSubtype subtype)`
`String`	`toString()`
`AccountBase`	`type(AccountType type)`
`AccountBase`	`verificationStatus(AccountBase.VerificationStatusEnum verificationStatus)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BALANCES
```
public static final String SERIALIZED_NAME_BALANCES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MASK
```
public static final String SERIALIZED_NAME_MASK
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_OFFICIAL_NAME
```
public static final String SERIALIZED_NAME_OFFICIAL_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUBTYPE
```
public static final String SERIALIZED_NAME_SUBTYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VERIFICATION_STATUS
```
public static final String SERIALIZED_NAME_VERIFICATION_STATUS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PERSISTENT_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_PERSISTENT_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AccountBase
```
public AccountBase()
```
- Method Detail
  - accountId
```
public AccountBase accountId(String accountId)
```
  - getAccountId
```
public 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(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(String mask)
```
  - getMask
```
@Nullable
public 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(String mask)
```
  - name
```
public AccountBase name(String name)
```
  - getName
```
public String getName()
```
    The name of the account, either assigned by the user or by the financial institution itself
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - officialName
```
public AccountBase officialName(String officialName)
```
  - getOfficialName
```
@Nullable
public String getOfficialName()
```
    The official name of the account as given by the financial institution
    
    Returns:
    
    officialName
  - setOfficialName
```
public void setOfficialName(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 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.
    
    Returns:
    
    verificationStatus
  - setVerificationStatus
```
public void setVerificationStatus(AccountBase.VerificationStatusEnum verificationStatus)
```
  - persistentAccountId
```
public AccountBase persistentAccountId(String persistentAccountId)
```
  - getPersistentAccountId
```
@Nullable
public String getPersistentAccountId()
```
    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.
    
    Returns:
    
    persistentAccountId
  - setPersistentAccountId
```
public void setPersistentAccountId(String persistentAccountId)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AccountBase

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_BALANCES

SERIALIZED_NAME_MASK

SERIALIZED_NAME_NAME

SERIALIZED_NAME_OFFICIAL_NAME

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_SUBTYPE

SERIALIZED_NAME_VERIFICATION_STATUS

SERIALIZED_NAME_PERSISTENT_ACCOUNT_ID

Constructor Detail

AccountBase

Method Detail

accountId

getAccountId

setAccountId

balances

getBalances

setBalances

mask

getMask

setMask

name

getName

setName

officialName

getOfficialName

setOfficialName

type

getType

setType

subtype

getSubtype

setSubtype

verificationStatus

getVerificationStatus

setVerificationStatus

persistentAccountId

getPersistentAccountId

setPersistentAccountId

equals

hashCode

toString