Class: Increase::Models::Simulations::InboundACHTransferCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::Simulations::InboundACHTransferCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/simulations/inbound_ach_transfer_create_params.rb

Overview

See Also:

• Resources::Simulations::InboundACHTransfers#create

Defined Under Namespace

Modules: StandardEntryClassCode Classes: Addenda

Instance Attribute Summary

• #account_number_id ⇒ String

  The identifier of the Account Number the inbound ACH Transfer is for.

• #addenda ⇒ Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda^?

  Additional information to include in the transfer.

• #amount ⇒ Integer

  The transfer amount in cents.

• #company_descriptive_date ⇒ String^?

  The description of the date of the transfer.

• #company_discretionary_data ⇒ String^?

  Data associated with the transfer set by the sender.

• #company_entry_description ⇒ String^?

  The description of the transfer set by the sender.

• #company_id ⇒ String^?

  The sender’s company ID.

• #company_name ⇒ String^?

  The name of the sender.

• #receiver_id_number ⇒ String^?

  The ID of the receiver of the transfer.

• #receiver_name ⇒ String^?

  The name of the receiver of the transfer.

• #resolve_at ⇒ Time^?

  The time at which the transfer should be resolved.

• #standard_entry_class_code ⇒ Symbol, ...

  The standard entry class code for the transfer.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(payment_related_information: ) ⇒ Object constructor

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(payment_related_information: ) ⇒ Object

Parameters:

• payment_related_information (String) (defaults to: ) —

  The payment related information passed in the addendum.

# File 'lib/increase/models/simulations/inbound_ach_transfer_create_params.rb', line 172

Instance Attribute Details

#account_number_id ⇒ String

The identifier of the Account Number the inbound ACH Transfer is for.

Returns:

• (String)

# File 'lib/increase/models/simulations/inbound_ach_transfer_create_params.rb', line 15

required :account_number_id, String

#addenda ⇒ Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda^?

Additional information to include in the transfer.

Returns:

• (Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda, nil)

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

optional :addenda, -> { Increase::Simulations::InboundACHTransferCreateParams::Addenda }

#amount ⇒ Integer

The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.

Returns:

• (Integer)

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

required :amount, Integer

#company_descriptive_date ⇒ String^?

The description of the date of the transfer.

Returns:

• (String, nil)

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

optional :company_descriptive_date, String

#company_discretionary_data ⇒ String^?

Data associated with the transfer set by the sender.

Returns:

• (String, nil)

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

optional :company_discretionary_data, String

#company_entry_description ⇒ String^?

The description of the transfer set by the sender.

Returns:

• (String, nil)

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

optional :company_entry_description, String

#company_id ⇒ String^?

The sender’s company ID.

Returns:

• (String, nil)

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

optional :company_id, String

#company_name ⇒ String^?

The name of the sender.

Returns:

• (String, nil)

# File 'lib/increase/models/simulations/inbound_ach_transfer_create_params.rb', line 59

optional :company_name, String

#receiver_id_number ⇒ String^?

The ID of the receiver of the transfer.

Returns:

• (String, nil)

# File 'lib/increase/models/simulations/inbound_ach_transfer_create_params.rb', line 65

optional :receiver_id_number, String

#receiver_name ⇒ String^?

The name of the receiver of the transfer.

Returns:

• (String, nil)

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

optional :receiver_name, String

#resolve_at ⇒ Time^?

The time at which the transfer should be resolved. If not provided will resolve immediately.

Returns:

• (Time, nil)

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

optional :resolve_at, Time

#standard_entry_class_code ⇒ Symbol, ...

The standard entry class code for the transfer.

Returns:

• (Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode, nil)

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

optional :standard_entry_class_code,
enum: -> { Increase::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode }