Class: Increase::Models::ACHPrenotificationCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/ach_prenotification_create_params.rb

Overview

Defined Under Namespace

Modules: CreditDebitIndicator, StandardEntryClassCode

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(account_id: , account_number: , routing_number: , addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {}) ⇒ Object

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

Parameters:

  • account_id (String) (defaults to: )

    The Increase identifier for the account that will send the ACH Prenotification.

  • account_number (String) (defaults to: )

    The account number for the destination account.

  • routing_number (String) (defaults to: )

    The American Bankers’ Association (ABA) Routing Transit Number (RTN) for the des

  • addendum (String) (defaults to: nil)

    Additional information that will be sent to the recipient.

  • company_descriptive_date (String) (defaults to: nil)

    The description of the date of the ACH Prenotification.

  • company_discretionary_data (String) (defaults to: nil)

    The data you choose to associate with the ACH Prenotification.

  • company_entry_description (String) (defaults to: nil)

    The description you wish to be shown to the recipient.

  • company_name (String) (defaults to: nil)

    The name by which the recipient knows you.

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

    Whether the Prenotification is for a future debit or credit.

  • effective_date (Date) (defaults to: nil)

    The ACH Prenotification effective date in [ISO 8601](en.wikipedia.org/wi

  • individual_id (String) (defaults to: nil)

    Your identifier for the recipient.

  • individual_name (String) (defaults to: nil)

    The name of therecipient. This value is informational and not verified by the re

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

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

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/increase/models/ach_prenotification_create_params.rb', line 93

Instance Attribute Details

#account_idString

The Increase identifier for the account that will send the ACH Prenotification.

Returns:

  • (String)


14
# File 'lib/increase/models/ach_prenotification_create_params.rb', line 14

required :account_id, String

#account_numberString

The account number for the destination account.

Returns:

  • (String)


20
# File 'lib/increase/models/ach_prenotification_create_params.rb', line 20

required :account_number, String

#addendumString?

Additional information that will be sent to the recipient.

Returns:

  • (String, nil)


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

optional :addendum, String

#company_descriptive_dateString?

The description of the date of the ACH Prenotification.

Returns:

  • (String, nil)


39
# File 'lib/increase/models/ach_prenotification_create_params.rb', line 39

optional :company_descriptive_date, String

#company_discretionary_dataString?

The data you choose to associate with the ACH Prenotification.

Returns:

  • (String, nil)


45
# File 'lib/increase/models/ach_prenotification_create_params.rb', line 45

optional :company_discretionary_data, String

#company_entry_descriptionString?

The description you wish to be shown to the recipient.

Returns:

  • (String, nil)


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

optional :company_entry_description, String

#company_nameString?

The name by which the recipient knows you.

Returns:

  • (String, nil)


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

optional :company_name, String

#credit_debit_indicatorSymbol, ...

Whether the Prenotification is for a future debit or credit.



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

optional :credit_debit_indicator,
enum: -> { Increase::ACHPrenotificationCreateParams::CreditDebitIndicator }

#effective_dateDate?

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

Returns:

  • (Date, nil)


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

optional :effective_date, Date

#individual_idString?

Your identifier for the recipient.

Returns:

  • (String, nil)


77
# File 'lib/increase/models/ach_prenotification_create_params.rb', line 77

optional :individual_id, String

#individual_nameString?

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

Returns:

  • (String, nil)


84
# File 'lib/increase/models/ach_prenotification_create_params.rb', line 84

optional :individual_name, String

#routing_numberString

The American Bankers’ Association (ABA) Routing Transit Number (RTN) for the destination account.

Returns:

  • (String)


27
# File 'lib/increase/models/ach_prenotification_create_params.rb', line 27

required :routing_number, String

#standard_entry_class_codeSymbol, ...

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



90
91
# File 'lib/increase/models/ach_prenotification_create_params.rb', line 90

optional :standard_entry_class_code,
enum: -> { Increase::ACHPrenotificationCreateParams::StandardEntryClassCode }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/increase/models/ach_prenotification_create_params.rb', line 135