Class: Lithic::Models::TransactionSimulateVoidParams

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

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(token:, amount: nil, type: nil, request_options: {}) ⇒ Object

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

Parameters:

  • token (String) —

    The transaction token returned from the /v1/simulate/authorize response.

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

    Amount (in cents) to void. Typically this will match the amount in the original

  • type (Symbol, Lithic::Models::TransactionSimulateVoidParams::Type) (defaults to: nil) —

    Type of event to simulate. Defaults to ‘AUTHORIZATION_REVERSAL`.

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



# File 'lib/lithic/models/transaction_simulate_void_params.rb', line 34

Instance Attribute Details

#amount ⇒ Integer?

Amount (in cents) to void. Typically this will match the amount in the original authorization, but can be less. Applies to authorization reversals only. An authorization expiry will always apply to the full pending amount.

Returns:

  • (Integer, nil) 


22
 
# File 'lib/lithic/models/transaction_simulate_void_params.rb', line 22

optional :amount, Integer

#token ⇒ String

The transaction token returned from the /v1/simulate/authorize response.

Returns:

  • (String) 


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

required :token, String

#type ⇒ Symbol, ...

Type of event to simulate. Defaults to ‘AUTHORIZATION_REVERSAL`.

  • ‘AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed by Lithic.

  • ‘AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.

Returns:



32
 
# File 'lib/lithic/models/transaction_simulate_void_params.rb', line 32

optional :type, enum: -> { Lithic::TransactionSimulateVoidParams::Type }