Class: Increase::Models::AccountNumber

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

Overview

See Also:

Defined Under Namespace

Modules: Status, Type Classes: InboundACH, InboundChecks

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_id: , account_number: , created_at: , idempotency_key: , inbound_ach: , inbound_checks: , name: , routing_number: , status: , type: ) ⇒ Object

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

Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.

Parameters:

  • id (String) (defaults to: ) —

    The Account Number identifier.

  • account_id (String) (defaults to: ) —

    The identifier for the account this Account Number belongs to.

  • account_number (String) (defaults to: ) —

    The account number.

  • created_at (Time) (defaults to: ) —

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

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

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

  • inbound_ach (Increase::Models::AccountNumber::InboundACH) (defaults to: ) —

    Properties related to how this Account Number handles inbound ACH transfers.

  • inbound_checks (Increase::Models::AccountNumber::InboundChecks) (defaults to: ) —

    Properties related to how this Account Number should handle inbound check withdr

  • name (String) (defaults to: ) —

    The name you choose for the Account Number.

  • routing_number (String) (defaults to: ) —

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

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

    This indicates if payments can be made to the Account Number.

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

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




# File 'lib/increase/models/account_number.rb', line 78

Instance Attribute Details

#account_id ⇒ String

The identifier for the account this Account Number belongs to.

Returns:

  • (String) 


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

required :account_id, String

#account_number ⇒ String

The account number.

Returns:

  • (String) 


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

required :account_number, String

#created_at ⇒ Time

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

Returns:

  • (Time) 


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

required :created_at, Time

#id ⇒ String

The Account Number identifier.

Returns:

  • (String) 


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


38
 
# File 'lib/increase/models/account_number.rb', line 38

required :idempotency_key, String, nil?: true

#inbound_ach ⇒ Increase::Models::AccountNumber::InboundACH

Properties related to how this Account Number handles inbound ACH transfers.

Returns:



44
 
# File 'lib/increase/models/account_number.rb', line 44

required :inbound_ach, -> { Increase::AccountNumber::InboundACH }

#inbound_checks ⇒ Increase::Models::AccountNumber::InboundChecks

Properties related to how this Account Number should handle inbound check withdrawals.

Returns:



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

required :inbound_checks, -> { Increase::AccountNumber::InboundChecks }

#name ⇒ String

The name you choose for the Account Number.

Returns:

  • (String) 


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

required :name, String

#routing_number ⇒ String

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

Returns:

  • (String) 


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

required :routing_number, String

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

This indicates if payments can be made to the Account Number.

Returns:



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

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

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

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

Returns:



76
 
# File 'lib/increase/models/account_number.rb', line 76

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/account_number.rb', line 140