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

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

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class UserCustomPassword
extends Object
```
Custom test accounts are configured with a JSON configuration object formulated according to the schema below. All top level fields are optional. Sending an empty object as a configuration will result in an account configured with random balances and transaction history.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_FORCE_ERROR`
`static String`	`SERIALIZED_NAME_MFA`
`static String`	`SERIALIZED_NAME_OVERRIDE_ACCOUNTS`
`static String`	`SERIALIZED_NAME_RECAPTCHA`
`static String`	`SERIALIZED_NAME_SEED`
`static String`	`SERIALIZED_NAME_VERSION`

Constructor Summary

Constructors
Constructor and Description

UserCustomPassword()

Constructors
Constructor and Description
`UserCustomPassword()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserCustomPassword`	`addOverrideAccountsItem(OverrideAccounts overrideAccountsItem)`
`boolean`	`equals(Object o)`
`UserCustomPassword`	`forceError(String forceError)`
`String`	`getForceError()` An error code to force on Item creation.
`MFA`	`getMfa()` Get mfa
`List<OverrideAccounts>`	`getOverrideAccounts()` An array of account overrides to configure the accounts for the Item.
`String`	`getRecaptcha()` You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment by using the recaptcha field.
`String`	`getSeed()` A seed, in the form of a string, that will be used to randomly generate account and transaction data, if this data is not specified using the `override_accounts` argument.
`String`	`getVersion()` The version of the password schema to use, possible values are 1 or 2.
`int`	`hashCode()`
`UserCustomPassword`	`mfa(MFA mfa)`
`UserCustomPassword`	`overrideAccounts(List<OverrideAccounts> overrideAccounts)`
`UserCustomPassword`	`recaptcha(String recaptcha)`
`UserCustomPassword`	`seed(String seed)`
`void`	`setForceError(String forceError)`
`void`	`setMfa(MFA mfa)`
`void`	`setOverrideAccounts(List<OverrideAccounts> overrideAccounts)`
`void`	`setRecaptcha(String recaptcha)`
`void`	`setSeed(String seed)`
`void`	`setVersion(String version)`
`String`	`toString()`
`UserCustomPassword`	`version(String version)`

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

- Field Detail
  - SERIALIZED_NAME_VERSION
```
public static final String SERIALIZED_NAME_VERSION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SEED
```
public static final String SERIALIZED_NAME_SEED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_OVERRIDE_ACCOUNTS
```
public static final String SERIALIZED_NAME_OVERRIDE_ACCOUNTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MFA
```
public static final String SERIALIZED_NAME_MFA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RECAPTCHA
```
public static final String SERIALIZED_NAME_RECAPTCHA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FORCE_ERROR
```
public static final String SERIALIZED_NAME_FORCE_ERROR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserCustomPassword
```
public UserCustomPassword()
```
- Method Detail
  - version
```
public UserCustomPassword version(String version)
```
  - getVersion
```
@Nullable
public String getVersion()
```
    The version of the password schema to use, possible values are 1 or 2. The default value is 2. You should only specify 1 if you know it is necessary for your test suite.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(String version)
```
  - seed
```
public UserCustomPassword seed(String seed)
```
  - getSeed
```
public String getSeed()
```
    A seed, in the form of a string, that will be used to randomly generate account and transaction data, if this data is not specified using the `override_accounts` argument. If no seed is specified, the randomly generated data will be different each time. Note that transactions data is generated relative to the Item's creation date. Different Items created on different dates with the same seed for transactions data will have different dates for the transactions. The number of days between each transaction and the Item creation will remain constant. For example, an Item created on December 15 might show a transaction on December 14. An Item created on December 20, using the same seed, would show that same transaction occurring on December 19.
    
    Returns:
    
    seed
  - setSeed
```
public void setSeed(String seed)
```
  - overrideAccounts
```
public UserCustomPassword overrideAccounts(List<OverrideAccounts> overrideAccounts)
```
  - addOverrideAccountsItem
```
public UserCustomPassword addOverrideAccountsItem(OverrideAccounts overrideAccountsItem)
```
  - getOverrideAccounts
```
public List<OverrideAccounts> getOverrideAccounts()
```
    An array of account overrides to configure the accounts for the Item. By default, if no override is specified, transactions and account data will be randomly generated based on the account type and subtype, and other products will have fixed or empty data.
    
    Returns:
    
    overrideAccounts
  - setOverrideAccounts
```
public void setOverrideAccounts(List<OverrideAccounts> overrideAccounts)
```
  - mfa
```
public UserCustomPassword mfa(MFA mfa)
```
  - getMfa
```
public MFA getMfa()
```
    Get mfa
    
    Returns:
    
    mfa
  - setMfa
```
public void setMfa(MFA mfa)
```
  - recaptcha
```
public UserCustomPassword recaptcha(String recaptcha)
```
  - getRecaptcha
```
public String getRecaptcha()
```
    You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment by using the recaptcha field. Possible values are `good` or `bad`. A value of `good` will result in successful Item creation and `bad` will result in a `RECAPTCHA_BAD` error to simulate a failed reCAPTCHA. Both values require the reCAPTCHA to be manually solved within Plaid Link.
    
    Returns:
    
    recaptcha
  - setRecaptcha
```
public void setRecaptcha(String recaptcha)
```
  - forceError
```
public UserCustomPassword forceError(String forceError)
```
  - getForceError
```
public String getForceError()
```
    An error code to force on Item creation. Possible values are: `\"INSTITUTION_NOT_RESPONDING\"` `\"INSTITUTION_NO_LONGER_SUPPORTED\"` `\"INVALID_CREDENTIALS\"` `\"INVALID_MFA\"` `\"ITEM_LOCKED\"` `\"ITEM_LOGIN_REQUIRED\"` `\"ITEM_NOT_SUPPORTED\"` `\"INVALID_LINK_TOKEN\"` `\"MFA_NOT_SUPPORTED\"` `\"NO_ACCOUNTS\"` `\"PLAID_ERROR\"` `\"USER_INPUT_TIMEOUT\"` `\"USER_SETUP_REQUIRED\"`
    
    Returns:
    
    forceError
  - setForceError
```
public void setForceError(String forceError)
```
  - 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 UserCustomPassword

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_VERSION

SERIALIZED_NAME_SEED

SERIALIZED_NAME_OVERRIDE_ACCOUNTS

SERIALIZED_NAME_MFA

SERIALIZED_NAME_RECAPTCHA

SERIALIZED_NAME_FORCE_ERROR

Constructor Detail

UserCustomPassword

Method Detail

version

getVersion

setVersion

seed

getSeed

setSeed

overrideAccounts

addOverrideAccountsItem

getOverrideAccounts

setOverrideAccounts

mfa

getMfa

setMfa

recaptcha

getRecaptcha

setRecaptcha

forceError

getForceError

setForceError

equals

hashCode

toString