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
PAUSEDstate will not be able to transact or create new cards.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAccountUpdateParams.BuilderA builder for AccountUpdateParams.
public final classAccountUpdateParams.Bodypublic final classAccountUpdateParams.StateAccount states.
public final classAccountUpdateParams.SubstatusAccount 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 classAccountUpdateParams.VerificationAddressAddress 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.
-
Method Summary
Modifier and Type Method Description final Optional<String>accountToken()final Optional<String>comment()Additional context or information related to the account. final Optional<Long>dailySpendLimit()Amount (in cents) for the account's daily spend limit (e.g. final Optional<Long>lifetimeSpendLimit()Amount (in cents) for the account's lifetime spend limit (e.g. final Optional<Long>monthlySpendLimit()Amount (in cents) for the account's monthly spend limit (e.g. final Optional<AccountUpdateParams.State>state()Account states. 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.
final Optional<AccountUpdateParams.VerificationAddress>verificationAddress()Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules. final JsonField<String>_comment()Returns the raw JSON value of comment. final JsonField<Long>_dailySpendLimit()Returns the raw JSON value of dailySpendLimit. final JsonField<Long>_lifetimeSpendLimit()Returns the raw JSON value of lifetimeSpendLimit. final JsonField<Long>_monthlySpendLimit()Returns the raw JSON value of monthlySpendLimit. final JsonField<AccountUpdateParams.State>_state()Returns the raw JSON value of state. final JsonField<AccountUpdateParams.Substatus>_substatus()Returns the raw JSON value of substatus. final JsonField<AccountUpdateParams.VerificationAddress>_verificationAddress()Returns the raw JSON value of verificationAddress. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final AccountUpdateParams.BuildertoBuilder()final AccountUpdateParams.Body_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static AccountUpdateParamsnone()final static AccountUpdateParams.Builderbuilder()Returns a mutable builder for constructing an instance of AccountUpdateParams. -
-
Method Detail
-
accountToken
final Optional<String> accountToken()
-
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.
-
state
final Optional<AccountUpdateParams.State> state()
Account states.
-
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.
-
_comment
final JsonField<String> _comment()
Returns the raw JSON value of comment.
Unlike comment, this method doesn't throw if the JSON field has an unexpected type.
-
_dailySpendLimit
final JsonField<Long> _dailySpendLimit()
Returns the raw JSON value of dailySpendLimit.
Unlike dailySpendLimit, this method doesn't throw if the JSON field has an unexpected type.
-
_lifetimeSpendLimit
final JsonField<Long> _lifetimeSpendLimit()
Returns the raw JSON value of lifetimeSpendLimit.
Unlike lifetimeSpendLimit, this method doesn't throw if the JSON field has an unexpected type.
-
_monthlySpendLimit
final JsonField<Long> _monthlySpendLimit()
Returns the raw JSON value of monthlySpendLimit.
Unlike monthlySpendLimit, this method doesn't throw if the JSON field has an unexpected type.
-
_state
final JsonField<AccountUpdateParams.State> _state()
Returns the raw JSON value of state.
Unlike state, this method doesn't throw if the JSON field has an unexpected type.
-
_substatus
final JsonField<AccountUpdateParams.Substatus> _substatus()
Returns the raw JSON value of substatus.
Unlike substatus, this method doesn't throw if the JSON field has an unexpected type.
-
_verificationAddress
@Deprecated(message = "deprecated") final JsonField<AccountUpdateParams.VerificationAddress> _verificationAddress()
Returns the raw JSON value of verificationAddress.
Unlike verificationAddress, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final AccountUpdateParams.Builder toBuilder()
-
_body
final AccountUpdateParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_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.
-
none
final static AccountUpdateParams none()
-
builder
final static AccountUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of AccountUpdateParams.
-
-
-