Class: Lithic::Models::AccountUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/account_update_params.rb

Overview

See Also:

Defined Under Namespace

Modules: State, Substatus Classes: VerificationAddress

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(comment: nil, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, substatus: nil, verification_address: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::AccountUpdateParams for more details.

Parameters:

  • comment (String) (defaults to: nil) —

    Additional context or information related to the account.

  • daily_spend_limit (Integer) (defaults to: nil) —

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

  • lifetime_spend_limit (Integer) (defaults to: nil) —

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

  • monthly_spend_limit (Integer) (defaults to: nil) —

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

  • state (Symbol, Lithic::Models::AccountUpdateParams::State) (defaults to: nil) —

    Account states.

  • substatus (Symbol, Lithic::Models::AccountUpdateParams::Substatus) (defaults to: nil) —

    Account state substatus values:

  • verification_address (Lithic::Models::AccountUpdateParams::VerificationAddress) (defaults to: nil) —

    Address used during Address Verification Service (AVS) checks during transaction

  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/lithic/models/account_update_params.rb', line 91

Instance Attribute Details

#comment ⇒ String?

Additional context or information related to the account.

Returns:

  • (String, nil) 


14
 
# File 'lib/lithic/models/account_update_params.rb', line 14

optional :comment, String

#daily_spend_limit ⇒ Integer?

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.

Returns:

  • (Integer, nil) 


21
 
# File 'lib/lithic/models/account_update_params.rb', line 21

optional :daily_spend_limit, Integer

#lifetime_spend_limit ⇒ Integer?

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.

Returns:

  • (Integer, nil) 


33
 
# File 'lib/lithic/models/account_update_params.rb', line 33

optional :lifetime_spend_limit, Integer

#monthly_spend_limit ⇒ Integer?

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.

Returns:

  • (Integer, nil) 


40
 
# File 'lib/lithic/models/account_update_params.rb', line 40

optional :monthly_spend_limit, Integer

#state ⇒ Symbol, ...

Account states.

Returns:



46
 
# File 'lib/lithic/models/account_update_params.rb', line 46

optional :state, enum: -> { Lithic::AccountUpdateParams::State }

#substatus ⇒ Symbol, ...

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.

Returns:



78
 
# File 'lib/lithic/models/account_update_params.rb', line 78

optional :substatus, enum: -> { Lithic::AccountUpdateParams::Substatus }

#verification_address ⇒ Lithic::Models::AccountUpdateParams::VerificationAddress?

Deprecated.

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.

Returns:



89
 
# File 'lib/lithic/models/account_update_params.rb', line 89

optional :verification_address, -> { Lithic::AccountUpdateParams::VerificationAddress }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/account_update_params.rb', line 119