Class: Increase::Models::CheckDeposit::DepositReturn

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/check_deposit.rb

Overview

See Also:

Defined Under Namespace

Modules: Currency, ReturnReason

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(amount: , check_deposit_id: , currency: , return_reason: , returned_at: , transaction_id: ) ⇒ Object

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

If your deposit is returned, this will contain details as to why it was returned.

Parameters:




# File 'lib/increase/models/check_deposit.rb', line 414

Instance Attribute Details

#amount ⇒ Integer

The returned amount in USD cents.

Returns:

  • (Integer) 


378
 
# File 'lib/increase/models/check_deposit.rb', line 378

required :amount, Integer

#check_deposit_id ⇒ String

The identifier of the Check Deposit that was returned.

Returns:

  • (String) 


384
 
# File 'lib/increase/models/check_deposit.rb', line 384

required :check_deposit_id, String

#currency ⇒ Symbol, Increase::Models::CheckDeposit::DepositReturn::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the transaction’s currency.

Returns:



391
 
# File 'lib/increase/models/check_deposit.rb', line 391

required :currency, enum: -> { Increase::CheckDeposit::DepositReturn::Currency }

#return_reason ⇒ Symbol, Increase::Models::CheckDeposit::DepositReturn::ReturnReason

Why this check was returned by the bank holding the account it was drawn against.

Returns:



398
 
# File 'lib/increase/models/check_deposit.rb', line 398

required :return_reason, enum: -> { Increase::CheckDeposit::DepositReturn::ReturnReason }

#returned_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.

Returns:

  • (Time) 


405
 
# File 'lib/increase/models/check_deposit.rb', line 405

required :returned_at, Time

#transaction_id ⇒ String

The identifier of the transaction that reversed the original check deposit transaction.

Returns:

  • (String) 


412
 
# File 'lib/increase/models/check_deposit.rb', line 412

required :transaction_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/check_deposit.rb', line 443