Class: Increase::Models::ExternalAccount

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

Overview

See Also:

Defined Under Namespace

Modules: AccountHolder, Funding, 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: , account_holder: , account_number: , created_at: , description: , funding: , idempotency_key: , routing_number: , status: , type: ) ⇒ Object

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

External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.

Parameters:

  • id (String) (defaults to: ) —

    The External Account’s identifier.

  • account_holder (Symbol, Increase::Models::ExternalAccount::AccountHolder) (defaults to: ) —

    The type of entity that owns the External Account.

  • account_number (String) (defaults to: ) —

    The destination account number.

  • created_at (Time) (defaults to: ) —

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

  • description (String) (defaults to: ) —

    The External Account’s description for display purposes.

  • funding (Symbol, Increase::Models::ExternalAccount::Funding) (defaults to: ) —

    The type of the account to which the transfer will be sent.

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

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

  • routing_number (String) (defaults to: ) —

    The American Bankers’ Association (ABA) Routing Transit Number (RTN).

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

    The External Account’s status.

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

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




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

Instance Attribute Details

#account_holder ⇒ Symbol, Increase::Models::ExternalAccount::AccountHolder

The type of entity that owns the External Account.

Returns:



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

required :account_holder, enum: -> { Increase::ExternalAccount::AccountHolder }

#account_number ⇒ String

The destination account number.

Returns:

  • (String) 


23
 
# File 'lib/increase/models/external_account.rb', line 23

required :account_number, String

#created_at ⇒ Time

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

Returns:

  • (Time) 


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

required :created_at, Time

#description ⇒ String

The External Account’s description for display purposes.

Returns:

  • (String) 


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

required :description, String

#funding ⇒ Symbol, Increase::Models::ExternalAccount::Funding

The type of the account to which the transfer will be sent.

Returns:



42
 
# File 'lib/increase/models/external_account.rb', line 42

required :funding, enum: -> { Increase::ExternalAccount::Funding }

#id ⇒ String

The External Account’s identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/external_account.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) 


50
 
# File 'lib/increase/models/external_account.rb', line 50

required :idempotency_key, String, nil?: true

#routing_number ⇒ String

The American Bankers’ Association (ABA) Routing Transit Number (RTN).

Returns:

  • (String) 


56
 
# File 'lib/increase/models/external_account.rb', line 56

required :routing_number, String

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

The External Account’s status.

Returns:



62
 
# File 'lib/increase/models/external_account.rb', line 62

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

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

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

Returns:



69
 
# File 'lib/increase/models/external_account.rb', line 69

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/external_account.rb', line 113