Class: Increase::Models::IntrafiExclusion

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

Overview

See Also:

Defined Under Namespace

Modules: 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(id: , bank_name: , created_at: , entity_id: , excluded_at: , fdic_certificate_number: , idempotency_key: , status: , submitted_at: , type: ) ⇒ Object

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

Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.

Parameters:

  • id (String) (defaults to: ) —

    The identifier of this exclusion request.

  • bank_name (String) (defaults to: ) —

    The name of the excluded institution.

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

  • entity_id (String) (defaults to: ) —

    The entity for which this institution is excluded.

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

    When this was exclusion was confirmed by IntraFi.

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

    The Federal Deposit Insurance Corporation’s certificate number for the instituti

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

    The idempotency key you chose for this object. This value is unique across Incre

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

    The status of the exclusion request.

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

    When this was exclusion was submitted to IntraFi by Increase.

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

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




# File 'lib/increase/models/intrafi_exclusion.rb', line 72

Instance Attribute Details

#bank_name ⇒ String

The name of the excluded institution.

Returns:

  • (String) 


17
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 17

required :bank_name, String

#created_at ⇒ Time

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

Returns:

  • (Time) 


24
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 24

required :created_at, Time

#entity_id ⇒ String

The entity for which this institution is excluded.

Returns:

  • (String) 


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

required :entity_id, String

#excluded_at ⇒ Time?

When this was exclusion was confirmed by IntraFi.

Returns:

  • (Time, nil) 


36
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 36

required :excluded_at, Time, nil?: true

#fdic_certificate_number ⇒ String?

The Federal Deposit Insurance Corporation’s certificate number for the institution.

Returns:

  • (String, nil) 


43
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 43

required :fdic_certificate_number, String, nil?: true

#id ⇒ String

The identifier of this exclusion request.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 11

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


51
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 51

required :idempotency_key, String, nil?: true

#status ⇒ Symbol, Increase::Models::IntrafiExclusion::Status

The status of the exclusion request.

Returns:



57
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 57

required :status, enum: -> { Increase::IntrafiExclusion::Status }

#submitted_at ⇒ Time?

When this was exclusion was submitted to IntraFi by Increase.

Returns:

  • (Time, nil) 


63
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 63

required :submitted_at, Time, nil?: true

#type ⇒ Symbol, Increase::Models::IntrafiExclusion::Type

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

Returns:



70
 
# File 'lib/increase/models/intrafi_exclusion.rb', line 70

required :type, enum: -> { Increase::IntrafiExclusion::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/intrafi_exclusion.rb', line 116