Class UserCustomPassword

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class UserCustomPassword
extends java.lang.Object
Custom test accounts are configured with a JSON configuration object formulated according to the schema below. All fields are optional. Sending an empty object as a configuration will result in an account configured with random balances and transaction history.
  • Field Details

  • Constructor Details

  • Method Details

    • version

      public UserCustomPassword version​(java.lang.String version)
    • getVersion

      @Nullable public java.lang.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​(java.lang.String version)
    • seed

      public UserCustomPassword seed​(java.lang.String seed)
    • getSeed

      public java.lang.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​(java.lang.String seed)
    • overrideAccounts

      public UserCustomPassword overrideAccounts​(java.util.List<OverrideAccounts> overrideAccounts)
    • addOverrideAccountsItem

      public UserCustomPassword addOverrideAccountsItem​(OverrideAccounts overrideAccountsItem)
    • getOverrideAccounts

      public java.util.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​(java.util.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​(java.lang.String recaptcha)
    • getRecaptcha

      public java.lang.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​(java.lang.String recaptcha)
    • forceError

      public UserCustomPassword forceError​(java.lang.String forceError)
    • getForceError

      public java.lang.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\"` `\"PRODUCTS_NOT_SUPPORTED\"` `\"USER_SETUP_REQUIRED\"`
      Returns:
      forceError
    • setForceError

      public void setForceError​(java.lang.String forceError)
    • 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