Class: Increase::Models::Simulations::CardSettlementCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/simulations/card_settlement_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, 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(card_id: , pending_transaction_id: , amount: nil, request_options: {}) ⇒ Object

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

Parameters:

  • card_id (String) (defaults to: ) —

    The identifier of the Card to create a settlement on.

  • pending_transaction_id (String) (defaults to: ) —

    The identifier of the Pending Transaction for the Card Authorization you wish to

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

    The amount to be settled. This defaults to the amount of the Pending Transaction

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



# File 'lib/increase/models/simulations/card_settlement_create_params.rb', line 31

Instance Attribute Details

#amount ⇒ Integer?

The amount to be settled. This defaults to the amount of the Pending Transaction being settled.

Returns:

  • (Integer, nil) 


29
 
# File 'lib/increase/models/simulations/card_settlement_create_params.rb', line 29

optional :amount, Integer

#card_id ⇒ String

The identifier of the Card to create a settlement on.

Returns:

  • (String) 


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

required :card_id, String

#pending_transaction_id ⇒ String

The identifier of the Pending Transaction for the Card Authorization you wish to settle.

Returns:

  • (String) 


22
 
# File 'lib/increase/models/simulations/card_settlement_create_params.rb', line 22

required :pending_transaction_id, String