Class: Increase::Models::ACHTransfer

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, DestinationAccountHolder, Funding, Network, StandardEntryClassCode, Status, Type Classes: Acknowledgement, Addenda, Approval, Cancellation, CreatedBy, InboundFundsHold, NotificationsOfChange, PreferredEffectiveDate, Return, Settlement, Submission

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

Some parameter documentations has been truncated, see Settlement for more details.

A subhash containing information about when and how the transfer settled at the Federal Reserve.

Parameters:

  • settled_at (Time) (defaults to: ) —

    When the funds for this transfer have settled at the destination bank at the Fed




# File 'lib/increase/models/ach_transfer.rb', line 250

Instance Attribute Details

#account_id ⇒ String

The Account to which the transfer belongs.

Returns:

  • (String) 


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

required :account_id, String

#account_number ⇒ String

The destination account number.

Returns:

  • (String) 


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

required :account_number, String

#acknowledgement ⇒ Increase::Models::ACHTransfer::Acknowledgement?

After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.

Returns:



31
 
# File 'lib/increase/models/ach_transfer.rb', line 31

required :acknowledgement, -> { Increase::ACHTransfer::Acknowledgement }, nil?: true

#addenda ⇒ Increase::Models::ACHTransfer::Addenda?

Additional information that will be sent to the recipient.

Returns:



37
 
# File 'lib/increase/models/ach_transfer.rb', line 37

required :addenda, -> { Increase::ACHTransfer::Addenda }, nil?: true

#amount ⇒ Integer

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

Returns:

  • (Integer) 


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

required :amount, Integer

#approval ⇒ Increase::Models::ACHTransfer::Approval?

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

Returns:



52
 
# File 'lib/increase/models/ach_transfer.rb', line 52

required :approval, -> { Increase::ACHTransfer::Approval }, nil?: true

#cancellation ⇒ Increase::Models::ACHTransfer::Cancellation?

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

Returns:



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

required :cancellation, -> { Increase::ACHTransfer::Cancellation }, nil?: true

#company_descriptive_date ⇒ String?

The description of the date of the transfer.

Returns:

  • (String, nil) 


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

required :company_descriptive_date, String, nil?: true

#company_discretionary_data ⇒ String?

The data you chose to associate with the transfer.

Returns:

  • (String, nil) 


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

required :company_discretionary_data, String, nil?: true

#company_entry_description ⇒ String?

The description of the transfer you set to be shown to the recipient.

Returns:

  • (String, nil) 


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

required :company_entry_description, String, nil?: true

#company_id ⇒ String

The company ID associated with the transfer.

Returns:

  • (String) 


83
 
# File 'lib/increase/models/ach_transfer.rb', line 83

required :company_id, String

#company_name ⇒ String?

The name by which the recipient knows you.

Returns:

  • (String, nil) 


89
 
# File 'lib/increase/models/ach_transfer.rb', line 89

required :company_name, String, nil?: true

#created_at ⇒ Time

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

Returns:

  • (Time) 


96
 
# File 'lib/increase/models/ach_transfer.rb', line 96

required :created_at, Time

#created_by ⇒ Increase::Models::ACHTransfer::CreatedBy?

What object created the transfer, either via the API or the dashboard.

Returns:



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

required :created_by, -> { Increase::ACHTransfer::CreatedBy }, nil?: true

#currency ⇒ Symbol, Increase::Models::ACHTransfer::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the transfer’s currency. For ACH transfers this is always equal to ‘usd`.

Returns:



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

required :currency, enum: -> { Increase::ACHTransfer::Currency }

#destination_account_holder ⇒ Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder

The type of entity that owns the account to which the ACH Transfer is being sent.

Returns:



116
 
# File 'lib/increase/models/ach_transfer.rb', line 116

required :destination_account_holder, enum: -> { Increase::ACHTransfer::DestinationAccountHolder }

#external_account_id ⇒ String?

The identifier of the External Account the transfer was made to, if any.

Returns:

  • (String, nil) 


122
 
# File 'lib/increase/models/ach_transfer.rb', line 122

required :external_account_id, String, nil?: true

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

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

Returns:



128
 
# File 'lib/increase/models/ach_transfer.rb', line 128

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

#id ⇒ String

The ACH transfer’s identifier.

Returns:

  • (String) 


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


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

required :idempotency_key, String, nil?: true

#inbound_funds_hold ⇒ Increase::Models::ACHTransfer::InboundFundsHold?

Increase will sometimes hold the funds for ACH debit transfers. If funds are held, this sub-object will contain details of the hold.

Returns:



143
 
# File 'lib/increase/models/ach_transfer.rb', line 143

required :inbound_funds_hold, -> { Increase::ACHTransfer::InboundFundsHold }, nil?: true

#individual_id ⇒ String?

Your identifier for the transfer recipient.

Returns:

  • (String, nil) 


149
 
# File 'lib/increase/models/ach_transfer.rb', line 149

required :individual_id, String, nil?: true

#individual_name ⇒ String?

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

Returns:

  • (String, nil) 


156
 
# File 'lib/increase/models/ach_transfer.rb', line 156

required :individual_name, String, nil?: true

#network ⇒ Symbol, Increase::Models::ACHTransfer::Network

The transfer’s network.

Returns:



162
 
# File 'lib/increase/models/ach_transfer.rb', line 162

required :network, enum: -> { Increase::ACHTransfer::Network }

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

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

Returns:



169
170
 
# File 'lib/increase/models/ach_transfer.rb', line 169

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

#pending_transaction_id ⇒ String?

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.

Returns:

  • (String, nil) 


179
 
# File 'lib/increase/models/ach_transfer.rb', line 179

required :pending_transaction_id, String, nil?: true

#preferred_effective_date ⇒ Increase::Models::ACHTransfer::PreferredEffectiveDate

Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a ‘settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be set.

Returns:



188
 
# File 'lib/increase/models/ach_transfer.rb', line 188

required :preferred_effective_date, -> { Increase::ACHTransfer::PreferredEffectiveDate }

#return_ ⇒ Increase::Models::ACHTransfer::Return?

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

Returns:



194
 
# File 'lib/increase/models/ach_transfer.rb', line 194

required :return_, -> { Increase::ACHTransfer::Return }, api_name: :return, nil?: true

#routing_number ⇒ String

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

Returns:

  • (String) 


200
 
# File 'lib/increase/models/ach_transfer.rb', line 200

required :routing_number, String

#settlement ⇒ Increase::Models::ACHTransfer::Settlement?

A subhash containing information about when and how the transfer settled at the Federal Reserve.

Returns:



207
 
# File 'lib/increase/models/ach_transfer.rb', line 207

required :settlement, -> { Increase::ACHTransfer::Settlement }, nil?: true

#standard_entry_class_code ⇒ Symbol, Increase::Models::ACHTransfer::StandardEntryClassCode

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

Returns:



213
 
# File 'lib/increase/models/ach_transfer.rb', line 213

required :standard_entry_class_code, enum: -> { Increase::ACHTransfer::StandardEntryClassCode }

#statement_descriptor ⇒ String

The descriptor that will show on the recipient’s bank statement.

Returns:

  • (String) 


219
 
# File 'lib/increase/models/ach_transfer.rb', line 219

required :statement_descriptor, String

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

The lifecycle status of the transfer.

Returns:



225
 
# File 'lib/increase/models/ach_transfer.rb', line 225

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

#submission ⇒ Increase::Models::ACHTransfer::Submission?

After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their [posted schedule](www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).

Returns:



235
 
# File 'lib/increase/models/ach_transfer.rb', line 235

required :submission, -> { Increase::ACHTransfer::Submission }, nil?: true

#transaction_id ⇒ String?

The ID for the transaction funding the transfer.

Returns:

  • (String, nil) 


241
 
# File 'lib/increase/models/ach_transfer.rb', line 241

required :transaction_id, String, nil?: true

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

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

Returns:



248
 
# File 'lib/increase/models/ach_transfer.rb', line 248

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/ach_transfer.rb', line 637