Class AccountUpdateParams

  • All Implemented Interfaces:
    com.lithic.api.core.Params

    
    public final class AccountUpdateParams
     implements Params
                        

    Update account configuration such as state or spend limits. Can only be run on accounts that are part of the program managed by this API key. Accounts that are in the PAUSED state will not be able to transact or create new cards.

    • Nested Class Summary

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

      A builder for AccountUpdateParams.

      public final class AccountUpdateParams.Body
      public final class AccountUpdateParams.State

      Account states.

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

      Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules. This field is deprecated as AVS checks are no longer supported by Auth Rules. The field will be removed from the schema in a future release.

    • 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

      • dailySpendLimit

         final Optional<Long> dailySpendLimit()

        Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a

        $1,000 limit). By default the daily spend limit is set to $

        1,250.

      • lifetimeSpendLimit

         final Optional<Long> lifetimeSpendLimit()

        Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a $1,000 limit). Once this limit is reached, no transactions will be accepted on any card created for this account until the limit is updated. Note that a spend limit of 0 is effectively no limit, and should only be used to reset or remove a prior limit. Only a limit of 1 or above will result in declined transactions due to checks against the account limit. This behavior differs from the daily spend limit and the monthly spend limit.

      • monthlySpendLimit

         final Optional<Long> monthlySpendLimit()

        Amount (in cents) for the account's monthly spend limit (e.g. 100000 would be a

        $1,000 limit). By default the monthly spend limit is set to $

        5,000.

      • substatus

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

      • verificationAddress

        @Deprecated(message = "deprecated") final Optional<AccountUpdateParams.VerificationAddress> verificationAddress()

        Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules. This field is deprecated as AVS checks are no longer supported by Auth Rules. The field will be removed from the schema in a future release.

      • _headers

         Headers _headers()

        The full set of headers in the parameters, including both fixed and additional headers.

      • _queryParams

         QueryParams _queryParams()

        The full set of query params in the parameters, including both fixed and additional query params.