Class: Lithic::Models::Fraud::TransactionReportParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/fraud/transaction_report_params.rb,
sig/lithic/models/fraud/transaction_report_params.rbs

Overview

See Also:

  • Lithic::Resources::Fraud::Transactions#report

Defined Under Namespace

Modules: FraudStatus, FraudType

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(transaction_token:, fraud_status:, comment: nil, fraud_type: nil, request_options: {}) ⇒ Object

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

Parameters:




# File 'lib/lithic/models/fraud/transaction_report_params.rb', line 65

Instance Attribute Details

#comment ⇒ String?

Optional field providing additional information or context about why the transaction is considered fraudulent.

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/lithic/models/fraud/transaction_report_params.rb', line 37

optional :comment, String

#fraud_status ⇒ Symbol, Lithic::Models::Fraud::TransactionReportParams::FraudStatus

The fraud status of the transaction, string (enum) supporting the following values:

  • SUSPECTED_FRAUD: The transaction is suspected to be fraudulent, but this hasn’t been confirmed.
  • FRAUDULENT: The transaction is confirmed to be fraudulent. A transaction may immediately be moved into this state, or be graduated into this state from the SUSPECTED_FRAUD state.
  • NOT_FRAUDULENT: The transaction is (explicitly) marked as not fraudulent. A transaction may immediately be moved into this state, or be graduated into this state from the SUSPECTED_FRAUD state.

Parameters:

  • value (Lithic::Models::Fraud::TransactionReportParams::fraud_status)

Returns:



30
 
# File 'lib/lithic/models/fraud/transaction_report_params.rb', line 30

required :fraud_status, enum: -> { Lithic::Fraud::TransactionReportParams::FraudStatus }

#fraud_type ⇒ Symbol, ...

Specifies the type or category of fraud that the transaction is suspected or confirmed to involve, string (enum) supporting the following values:

  • FIRST_PARTY_FRAUD: First-party fraud occurs when a legitimate account or cardholder intentionally misuses financial services for personal gain. This includes actions such as disputing legitimate transactions to obtain a refund, abusing return policies, or defaulting on credit obligations without intent to repay.
  • ACCOUNT_TAKEOVER: Account takeover fraud occurs when a fraudster gains unauthorized access to an existing account, modifies account settings, and carries out fraudulent transactions.
  • CARD_COMPROMISED: Card compromised fraud occurs when a fraudster gains access to card details without taking over the account, such as through physical card theft, cloning, or online data breaches.
  • IDENTITY_THEFT: Identity theft fraud occurs when a fraudster uses stolen personal information, such as Social Security numbers or addresses, to open accounts, apply for loans, or conduct financial transactions in someone's name.
  • CARDHOLDER_MANIPULATION: This type of fraud occurs when a fraudster manipulates or coerces a legitimate cardholder into unauthorized transactions, often through social engineering tactics.

Returns:



63
 
# File 'lib/lithic/models/fraud/transaction_report_params.rb', line 63

optional :fraud_type, enum: -> { Lithic::Fraud::TransactionReportParams::FraudType }

#transaction_token ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :transaction_token, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/fraud/transaction_report_params.rb', line 97

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/lithic/models/fraud/transaction_report_params.rbs', line 39

def to_hash: -> {