Class: Increase::Models::CheckDeposit::InboundFundsHold

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, Status, Type

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: , automatically_releases_at: , created_at: , currency: , held_transaction_id: , pending_transaction_id: , released_at: , status: , type: ) ⇒ Object

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

Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.

Parameters:

  • amount (Integer) (defaults to: ) —

    The held amount in the minor unit of the account’s currency. For dollars, for ex

  • automatically_releases_at (Time) (defaults to: ) —

    When the hold will be released automatically. Certain conditions may cause it to

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the hold wa

  • currency (Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Currency) (defaults to: ) —

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

  • held_transaction_id (String, nil) (defaults to: ) —

    The ID of the Transaction for which funds were held.

  • pending_transaction_id (String, nil) (defaults to: ) —

    The ID of the Pending Transaction representing the held funds.

  • released_at (Time, nil) (defaults to: ) —

    When the hold was released (if it has been released).

  • status (Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status) (defaults to: ) —

    The status of the hold.

  • type (Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type) (defaults to: ) —

    A constant representing the object’s type. For this resource it will always be ‘




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

Instance Attribute Details

#amount ⇒ Integer

The held amount in the minor unit of the account’s currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#automatically_releases_at ⇒ Time

When the hold will be released automatically. Certain conditions may cause it to be released before this time.

Returns:

  • (Time) 


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

required :automatically_releases_at, Time

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the hold was created.

Returns:

  • (Time) 


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

required :created_at, Time

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

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

Returns:



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

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

#held_transaction_id ⇒ String?

The ID of the Transaction for which funds were held.

Returns:

  • (String, nil) 


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

required :held_transaction_id, String, nil?: true

#pending_transaction_id ⇒ String?

The ID of the Pending Transaction representing the held funds.

Returns:

  • (String, nil) 


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

required :pending_transaction_id, String, nil?: true

#released_at ⇒ Time?

When the hold was released (if it has been released).

Returns:

  • (Time, nil) 


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

required :released_at, Time, nil?: true

#status ⇒ Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Status

The status of the hold.

Returns:



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

required :status, enum: -> { Increase::CheckDeposit::InboundFundsHold::Status }

#type ⇒ Symbol, Increase::Models::CheckDeposit::InboundFundsHold::Type

A constant representing the object’s type. For this resource it will always be ‘inbound_funds_hold`.

Returns:



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

required :type, enum: -> { Increase::CheckDeposit::InboundFundsHold::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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