Class Account
-
- All Implemented Interfaces:
public final class Account
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAccount.BuilderA builder for Account.
public final classAccount.SpendLimitSpend 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 classAccount.StateAccount 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 toACTIVE.CLOSED- Account will not be able to transact or create new cards.CLOSEDaccounts are unable to be transitioned toACTIVEorPAUSEDstates. Accounts can be manually set toCLOSED, 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 classAccount.AccountHolderpublic final classAccount.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 classAccount.VerificationAddress
-
Method Summary
Modifier and Type Method Description final Stringtoken()Globally unique identifier for the account. final Optional<OffsetDateTime>created()Timestamp of when the account was created. final Account.SpendLimitspendLimit()Spend limit information for the user containing the daily, monthly, and lifetime spend limit of the account. final Account.Statestate()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 toACTIVE.CLOSED- Account will not be able to transact or create new cards.CLOSEDaccounts are unable to be transitioned toACTIVEorPAUSEDstates. Accounts can be manually set toCLOSED, 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.
final Optional<Account.AccountHolder>accountHolder()final Optional<List<String>>authRuleTokens()List of identifiers for the Auth Rule(s) that are applied on the account. final Optional<String>cardholderCurrency()3-character alphabetic ISO 4217 code for the currency of the cardholder. final Optional<String>comment()Additional context or information related to the account. 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.
final Optional<Account.VerificationAddress>verificationAddress()final JsonField<String>_token()Returns the raw JSON value of token. final JsonField<OffsetDateTime>_created()Returns the raw JSON value of created. final JsonField<Account.SpendLimit>_spendLimit()Returns the raw JSON value of spendLimit. final JsonField<Account.State>_state()Returns the raw JSON value of state. final JsonField<Account.AccountHolder>_accountHolder()Returns the raw JSON value of accountHolder. final JsonField<List<String>>_authRuleTokens()Returns the raw JSON value of authRuleTokens. final JsonField<String>_cardholderCurrency()Returns the raw JSON value of cardholderCurrency. final JsonField<String>_comment()Returns the raw JSON value of comment. final JsonField<Account.Substatus>_substatus()Returns the raw JSON value of substatus. final JsonField<Account.VerificationAddress>_verificationAddress()Returns the raw JSON value of verificationAddress. final Map<String, JsonValue>_additionalProperties()final Account.BuildertoBuilder()final Accountvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Account.Builderbuilder()Returns a mutable builder for constructing an instance of Account. -
-
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.
-
created
final Optional<OffsetDateTime> created()
Timestamp of when the account was created.
-
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 toACTIVE.CLOSED- Account will not be able to transact or create new cards.CLOSEDaccounts are unable to be transitioned toACTIVEorPAUSEDstates. Accounts can be manually set toCLOSED, 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.
-
accountHolder
final Optional<Account.AccountHolder> accountHolder()
-
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_holderobject. The key will be removed from the schema in a future release. Use the/auth_rulesendpoints to fetch Auth Rule information instead.
-
cardholderCurrency
final Optional<String> cardholderCurrency()
3-character alphabetic ISO 4217 code for the currency of the cardholder.
-
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.
-
verificationAddress
@Deprecated(message = "deprecated") final Optional<Account.VerificationAddress> verificationAddress()
-
_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.
-
_created
final JsonField<OffsetDateTime> _created()
Returns the raw JSON value of created.
Unlike created, this method doesn't throw if the JSON field has an unexpected type.
-
_spendLimit
final JsonField<Account.SpendLimit> _spendLimit()
Returns the raw JSON value of spendLimit.
Unlike spendLimit, this method doesn't throw if the JSON field has an unexpected type.
-
_state
final JsonField<Account.State> _state()
Returns the raw JSON value of state.
Unlike state, this method doesn't throw if the JSON field has an unexpected type.
-
_accountHolder
final JsonField<Account.AccountHolder> _accountHolder()
Returns the raw JSON value of accountHolder.
Unlike accountHolder, this method doesn't throw if the JSON field has an unexpected type.
-
_authRuleTokens
@Deprecated(message = "deprecated") final JsonField<List<String>> _authRuleTokens()
Returns the raw JSON value of authRuleTokens.
Unlike authRuleTokens, this method doesn't throw if the JSON field has an unexpected type.
-
_cardholderCurrency
final JsonField<String> _cardholderCurrency()
Returns the raw JSON value of cardholderCurrency.
Unlike cardholderCurrency, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_substatus
final JsonField<Account.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<Account.VerificationAddress> _verificationAddress()
Returns the raw JSON value of verificationAddress.
Unlike verificationAddress, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Account.Builder toBuilder()
-
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()
-
-
-