Class: Increase::Models::CardDisputeCreateParams

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

Overview

See Also:

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

Some parameter documentations has been truncated, see Increase::Models::CardDisputeCreateParams for more details.

Parameters:

  • disputed_transaction_id (String) (defaults to: ) —

    The Transaction you wish to dispute. This Transaction must have a ‘source_type`

  • explanation (String) (defaults to: ) —

    Why you are disputing this Transaction.

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

    The monetary amount of the part of the transaction that is being disputed. This

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



# File 'lib/increase/models/card_dispute_create_params.rb', line 32

Instance Attribute Details

#amount ⇒ Integer?

The monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction.

Returns:

  • (Integer, nil) 


30
 
# File 'lib/increase/models/card_dispute_create_params.rb', line 30

optional :amount, Integer

#disputed_transaction_id ⇒ String

The Transaction you wish to dispute. This Transaction must have a ‘source_type` of `card_settlement`.

Returns:

  • (String) 


15
 
# File 'lib/increase/models/card_dispute_create_params.rb', line 15

required :disputed_transaction_id, String

#explanation ⇒ String

Why you are disputing this Transaction.

Returns:

  • (String) 


21
 
# File 'lib/increase/models/card_dispute_create_params.rb', line 21

required :explanation, String