Class: Increase::Models::ACHPrenotification

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

Overview

See Also:

Defined Under Namespace

Modules: CreditDebitIndicator, StandardEntryClassCode, Status, Type Classes: NotificationsOfChange, PrenotificationReturn

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: , addendum: , company_descriptive_date: , company_discretionary_data: , company_entry_description: , company_name: , created_at: , credit_debit_indicator: , effective_date: , idempotency_key: , individual_id: , individual_name: , notifications_of_change: , prenotification_return: , routing_number: , standard_entry_class_code: , status: , type: ) ⇒ Object

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

ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).

Parameters:

  • id (String) (defaults to: ) —

    The ACH Prenotification’s identifier.

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

    The account that sent the ACH Prenotification.

  • account_number (String) (defaults to: ) —

    The destination account number.

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

    Additional information for the recipient.

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

    The description of the date of the notification.

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

    Optional data associated with the notification.

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

    The description of the notification.

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

    The name by which you know the company.

  • created_at (Time) (defaults to: ) —

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

  • credit_debit_indicator (Symbol, Increase::Models::ACHPrenotification::CreditDebitIndicator, nil) (defaults to: ) —

    If the notification is for a future credit or debit.

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

    The effective date in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

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

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

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

    Your identifier for the recipient.

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

    The name of the recipient. This value is informational and not verified by the r

  • notifications_of_change (Array<Increase::Models::ACHPrenotification::NotificationsOfChange>) (defaults to: ) —

    If the receiving bank notifies that future transfers should use different detail

  • prenotification_return (Increase::Models::ACHPrenotification::PrenotificationReturn, nil) (defaults to: ) —

    If your prenotification is returned, this will contain details of the return.

  • routing_number (String) (defaults to: ) —

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

  • standard_entry_class_code (Symbol, Increase::Models::ACHPrenotification::StandardEntryClassCode, nil) (defaults to: ) —

    The Standard Entry Class (SEC) code to use for the ACH Prenotification.

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

    The lifecycle status of the ACH Prenotification.

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

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




# File 'lib/increase/models/ach_prenotification.rb', line 138

Instance Attribute Details

#account_id ⇒ String?

The account that sent the ACH Prenotification.

Returns:

  • (String, nil) 


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

required :account_id, String, nil?: true

#account_number ⇒ String

The destination account number.

Returns:

  • (String) 


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

required :account_number, String

#addendum ⇒ String?

Additional information for the recipient.

Returns:

  • (String, nil) 


29
 
# File 'lib/increase/models/ach_prenotification.rb', line 29

required :addendum, String, nil?: true

#company_descriptive_date ⇒ String?

The description of the date of the notification.

Returns:

  • (String, nil) 


35
 
# File 'lib/increase/models/ach_prenotification.rb', line 35

required :company_descriptive_date, String, nil?: true

#company_discretionary_data ⇒ String?

Optional data associated with the notification.

Returns:

  • (String, nil) 


41
 
# File 'lib/increase/models/ach_prenotification.rb', line 41

required :company_discretionary_data, String, nil?: true

#company_entry_description ⇒ String?

The description of the notification.

Returns:

  • (String, nil) 


47
 
# File 'lib/increase/models/ach_prenotification.rb', line 47

required :company_entry_description, String, nil?: true

#company_name ⇒ String?

The name by which you know the company.

Returns:

  • (String, nil) 


53
 
# File 'lib/increase/models/ach_prenotification.rb', line 53

required :company_name, String, nil?: true

#created_at ⇒ Time

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

Returns:

  • (Time) 


60
 
# File 'lib/increase/models/ach_prenotification.rb', line 60

required :created_at, Time

#credit_debit_indicator ⇒ Symbol, ...

If the notification is for a future credit or debit.

Returns:



66
67
68
 
# File 'lib/increase/models/ach_prenotification.rb', line 66

required :credit_debit_indicator,
enum: -> { Increase::ACHPrenotification::CreditDebitIndicator },
nil?: true

#effective_date ⇒ Time?

The effective date in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:

  • (Time, nil) 


74
 
# File 'lib/increase/models/ach_prenotification.rb', line 74

required :effective_date, Time, nil?: true

#id ⇒ String

The ACH Prenotification’s identifier.

Returns:

  • (String) 


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


82
 
# File 'lib/increase/models/ach_prenotification.rb', line 82

required :idempotency_key, String, nil?: true

#individual_id ⇒ String?

Your identifier for the recipient.

Returns:

  • (String, nil) 


88
 
# File 'lib/increase/models/ach_prenotification.rb', line 88

required :individual_id, String, nil?: true

#individual_name ⇒ String?

The name of the recipient. This value is informational and not verified by the recipient’s bank.

Returns:

  • (String, nil) 


95
 
# File 'lib/increase/models/ach_prenotification.rb', line 95

required :individual_name, String, nil?: true

#notifications_of_change ⇒ Array<Increase::Models::ACHPrenotification::NotificationsOfChange>

If the receiving bank notifies that future transfers should use different details, this will contain those details.

Returns:



102
103
 
# File 'lib/increase/models/ach_prenotification.rb', line 102

required :notifications_of_change,
-> { Increase::Internal::Type::ArrayOf[Increase::ACHPrenotification::NotificationsOfChange] }

#prenotification_return ⇒ Increase::Models::ACHPrenotification::PrenotificationReturn?

If your prenotification is returned, this will contain details of the return.

Returns:



109
 
# File 'lib/increase/models/ach_prenotification.rb', line 109

required :prenotification_return, -> { Increase::ACHPrenotification::PrenotificationReturn }, nil?: true

#routing_number ⇒ String

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

Returns:

  • (String) 


115
 
# File 'lib/increase/models/ach_prenotification.rb', line 115

required :routing_number, String

#standard_entry_class_code ⇒ Symbol, ...

The Standard Entry Class (SEC) code to use for the ACH Prenotification.

Returns:



121
122
123
 
# File 'lib/increase/models/ach_prenotification.rb', line 121

required :standard_entry_class_code,
enum: -> { Increase::ACHPrenotification::StandardEntryClassCode },
nil?: true

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

The lifecycle status of the ACH Prenotification.

Returns:



129
 
# File 'lib/increase/models/ach_prenotification.rb', line 129

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

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

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

Returns:



136
 
# File 'lib/increase/models/ach_prenotification.rb', line 136

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/ach_prenotification.rb', line 197