Class Account

  • All Implemented Interfaces:

    
    public final class Account
    
                        
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class Account.Builder

      A builder for Account.

      public final class Account.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.

      public final class Account.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.

      public final class Account.AccountHolder
      public final class Account.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.

      public final class Account.VerificationAddress
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Constructor Detail

    • Method Detail

      • token

         final 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.

      • spendLimit

         final 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.

      • state

         final 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.

      • authRuleTokens

        @Deprecated(message = "deprecated") final Optional<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.

      • substatus

         final Optional<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.

      • _token

         final JsonField<String> _token()

        Returns the raw JSON value of token.

        Unlike token, this method doesn't throw if the JSON field has an unexpected type.

      • builder

         final static Account.Builder builder()

        Returns a mutable builder for constructing an instance of Account.

        The following fields are required:

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