Class: Increase::Models::Simulations::InboundFundsHoldReleaseResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/simulations/inbound_funds_hold_release_response.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, 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(id: , 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::Simulations::InboundFundsHoldReleaseResponse for more details.

We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution.

Parameters:




# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 73

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) 


19
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 19

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) 


26
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 26

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) 


33
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 33

required :created_at, Time

#currency ⇒ Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency

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

Returns:



40
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 40

required :currency, enum: -> { Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Currency }

#held_transaction_id ⇒ String?

The ID of the Transaction for which funds were held.

Returns:

  • (String, nil) 


46
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 46

required :held_transaction_id, String, nil?: true

#id ⇒ String

The Inbound Funds Hold identifier.

Returns:

  • (String) 


12
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 12

required :id, String

#pending_transaction_id ⇒ String?

The ID of the Pending Transaction representing the held funds.

Returns:

  • (String, nil) 


52
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 52

required :pending_transaction_id, String, nil?: true

#released_at ⇒ Time?

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

Returns:

  • (Time, nil) 


58
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 58

required :released_at, Time, nil?: true

#status ⇒ Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status

The status of the hold.

Returns:



64
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 64

required :status, enum: -> { Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Status }

#type ⇒ Symbol, Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type

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

Returns:



71
 
# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 71

required :type, enum: -> { Increase::Models::Simulations::InboundFundsHoldReleaseResponse::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/simulations/inbound_funds_hold_release_response.rb', line 126