Constructor Detail

Method Detail

• token

   final Account.Builder token(String token)

  Globally unique identifier for the account. This is the same as the account_token returned by the enroll endpoint. If using this parameter, do not include pagination.

• token

   final Account.Builder token(JsonField<String> token)

  Sets Builder.token to an arbitrary JSON value.

  You should usually call Builder.token with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• created

   final Account.Builder created(OffsetDateTime created)

  Timestamp of when the account was created.

• created

   final Account.Builder created(Optional<OffsetDateTime> created)

  Alias for calling Builder.created with created.orElse(null).

• created

   final Account.Builder created(JsonField<OffsetDateTime> created)

  Sets Builder.created to an arbitrary JSON value.

  You should usually call Builder.created with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• spendLimit

   final Account.Builder spendLimit(Account.SpendLimit spendLimit)

  Spend limit information for the user containing the daily, monthly, and lifetime spend limit of the account. Any charges to a card owned by this account will be declined once their transaction volume has surpassed the value in the applicable time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit feature is disabled.

• spendLimit

   final Account.Builder spendLimit(JsonField<Account.SpendLimit> spendLimit)

  Sets Builder.spendLimit to an arbitrary JSON value.

  You should usually call Builder.spendLimit with a well-typed SpendLimit value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• state

   final Account.Builder state(Account.State state)

  Account state:

  • ACTIVE - Account is able to transact and create new cards.

  • PAUSED - Account will not be able to transact or create new cards. It can be set back to ACTIVE.

  • CLOSED - Account will not be able to transact or create new cards. CLOSED accounts are unable to be transitioned to ACTIVE or PAUSED states. Accounts can be manually set to CLOSED, or this can be done by Lithic due to failure to pass KYB/KYC or for risk/compliance reasons. Please contact [email protected] if you believe this was done by mistake.

• state

   final Account.Builder state(JsonField<Account.State> state)

  Sets Builder.state to an arbitrary JSON value.

  You should usually call Builder.state with a well-typed State value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• accountHolder

   final Account.Builder accountHolder(Account.AccountHolder accountHolder)

• accountHolder

   final Account.Builder accountHolder(JsonField<Account.AccountHolder> accountHolder)

  Sets Builder.accountHolder to an arbitrary JSON value.

  You should usually call Builder.accountHolder with a well-typed AccountHolder value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• authRuleTokens

  @Deprecated(message = "deprecated") final Account.Builder authRuleTokens(List<String> authRuleTokens)

  List of identifiers for the Auth Rule(s) that are applied on the account. This field is deprecated and will no longer be populated in the account_holder object. The key will be removed from the schema in a future release. Use the /auth_rules endpoints to fetch Auth Rule information instead.

• authRuleTokens

  @Deprecated(message = "deprecated") final Account.Builder authRuleTokens(JsonField<List<String>> authRuleTokens)

  Sets Builder.authRuleTokens to an arbitrary JSON value.

  You should usually call Builder.authRuleTokens with a well-typed List<String> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addAuthRuleToken

  @Deprecated(message = "deprecated") final Account.Builder addAuthRuleToken(String authRuleToken)

  Adds a single String to authRuleTokens.

• cardholderCurrency

   final Account.Builder cardholderCurrency(String cardholderCurrency)

  3-character alphabetic ISO 4217 code for the currency of the cardholder.

• cardholderCurrency

   final Account.Builder cardholderCurrency(JsonField<String> cardholderCurrency)

  Sets Builder.cardholderCurrency to an arbitrary JSON value.

  You should usually call Builder.cardholderCurrency with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• comment

   final Account.Builder comment(String comment)

  Additional context or information related to the account.

• comment

   final Account.Builder comment(JsonField<String> comment)

  Sets Builder.comment to an arbitrary JSON value.

  You should usually call Builder.comment with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• substatus

   final Account.Builder substatus(Account.Substatus substatus)

  Account state substatus values:

  • FRAUD_IDENTIFIED - The account has been recognized as being created or used with stolen or fabricated identity information, encompassing both true identity theft and synthetic identities.

  • SUSPICIOUS_ACTIVITY - The account has exhibited suspicious behavior, such as unauthorized access or fraudulent transactions, necessitating further investigation.

  • RISK_VIOLATION - The account has been involved in deliberate misuse by the legitimate account holder. Examples include disputing valid transactions without cause, falsely claiming non-receipt of goods, or engaging in intentional bust-out schemes to exploit account services.

  • END_USER_REQUEST - The account holder has voluntarily requested the closure of the account for personal reasons. This encompasses situations such as bankruptcy, other financial considerations, or the account holder's death.

  • ISSUER_REQUEST - The issuer has initiated the closure of the account due to business strategy, risk management, inactivity, product changes, regulatory concerns, or violations of terms and conditions.

  • NOT_ACTIVE - The account has not had any transactions or payment activity within a specified period. This status applies to accounts that are paused or closed due to inactivity.

  • INTERNAL_REVIEW - The account is temporarily paused pending further internal review. In future implementations, this status may prevent clients from activating the account via APIs until the review is completed.

  • OTHER - The reason for the account's current status does not fall into any of the above categories. A comment should be provided to specify the particular reason.

• substatus

   final Account.Builder substatus(JsonField<Account.Substatus> substatus)

  Sets Builder.substatus to an arbitrary JSON value.

  You should usually call Builder.substatus with a well-typed Substatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• verificationAddress

  @Deprecated(message = "deprecated") final Account.Builder verificationAddress(Account.VerificationAddress verificationAddress)

• verificationAddress

  @Deprecated(message = "deprecated") final Account.Builder verificationAddress(JsonField<Account.VerificationAddress> verificationAddress)

  Sets Builder.verificationAddress to an arbitrary JSON value.

  You should usually call Builder.verificationAddress with a well-typed VerificationAddress value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final Account.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final Account.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final Account.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final Account.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final Account.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final Account build()

  Returns an immutable instance of Account.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .token()
  .created()
  .spendLimit()
  .state()