Class: Increase::Models::ACHTransfer

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/ach_transfer.rb

Defined Under Namespace

Classes: Acknowledgement, Addenda, Approval, Cancellation, CreatedBy, NotificationsOfChange, PreferredEffectiveDate, Return, Submission

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#account_id ⇒ String

The Account to which the transfer belongs.

Returns:

  • (String) 


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

required :account_id, String

#account_number ⇒ String

The destination account number.

Returns:

  • (String) 


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

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:



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

required :acknowledgement, -> { Increase::Models::ACHTransfer::Acknowledgement }

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

Additional information that will be sent to the recipient.

Returns:



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

required :addenda, -> { Increase::Models::ACHTransfer::Addenda }

#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) 


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

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:



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

required :approval, -> { Increase::Models::ACHTransfer::Approval }

#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:



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

required :cancellation, -> { Increase::Models::ACHTransfer::Cancellation }

#company_descriptive_date ⇒ String

The description of the date of the transfer.

Returns:

  • (String) 


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

required :company_descriptive_date, String

#company_discretionary_data ⇒ String

The data you chose to associate with the transfer.

Returns:

  • (String) 


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

required :company_discretionary_data, String

#company_entry_description ⇒ String

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

Returns:

  • (String) 


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

required :company_entry_description, String

#company_name ⇒ String

The name by which the recipient knows you.

Returns:

  • (String) 


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

required :company_name, String

#created_at ⇒ String

The ISO 8601 date and time at which the transfer was created.

Returns:

  • (String) 


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

required :created_at, String

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

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

Returns:



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

required :created_by, -> { Increase::Models::ACHTransfer::CreatedBy }

#currency ⇒ Symbol

The ISO 4217 code for the transfer's currency. For ACH transfers this is always equal to usd.

Returns:

  • (Symbol) 


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

required :currency, Increase::Enum.new(:CAD, :CHF, :EUR, :GBP, :JPY, :USD)

#destination_account_holder ⇒ Symbol

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

Returns:

  • (Symbol) 


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

required :destination_account_holder, Increase::Enum.new(:business, :individual, :unknown)

#external_account_id ⇒ String

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

Returns:

  • (String) 


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

required :external_account_id, String

#funding ⇒ Symbol

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

Returns:

  • (Symbol) 


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

required :funding, Increase::Enum.new(:checking, :savings)

#id ⇒ String

The ACH transfer's identifier.

Returns:

  • (String) 


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

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.

Returns:

  • (String) 


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

required :idempotency_key, String

#individual_id ⇒ String

Your identifier for the transfer recipient.

Returns:

  • (String) 


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

required :individual_id, String

#individual_name ⇒ String

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

Returns:

  • (String) 


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

required :individual_name, String

#network ⇒ Symbol

The transfer's network.

Returns:

  • (Symbol) 


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

required :network, Increase::Enum.new(:ach)

#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:



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

required :notifications_of_change,
Increase::ArrayOf.new(-> { Increase::Models::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 by someone else in your organization.

Returns:

  • (String) 


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

required :pending_transaction_id, String

#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 atributes must be set.

Returns:



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

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

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

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

Returns:



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

required :return_, -> { Increase::Models::ACHTransfer::Return }

#routing_number ⇒ String

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

Returns:

  • (String) 


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

required :routing_number, String

#standard_entry_class_code ⇒ Symbol

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

Returns:

  • (Symbol) 


145
146
147
148
149
150
151
 
# File 'lib/increase/models/ach_transfer.rb', line 145

required :standard_entry_class_code,
Increase::Enum.new(
  :corporate_credit_or_debit,
  :corporate_trade_exchange,
  :prearranged_payments_and_deposit,
  :internet_initiated
)

#statement_descriptor ⇒ String

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

Returns:

  • (String) 


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

required :statement_descriptor, String

#status ⇒ Symbol

The lifecycle status of the transfer.

Returns:

  • (Symbol) 


161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/increase/models/ach_transfer.rb', line 161

required :status,
Increase::Enum.new(
  :pending_approval,
  :canceled,
  :pending_reviewing,
  :pending_submission,
  :submitted,
  :returned,
  :requires_attention,
  :rejected
)

#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.

Returns:



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

required :submission, -> { Increase::Models::ACHTransfer::Submission }

#transaction_id ⇒ String

The ID for the transaction funding the transfer.

Returns:

  • (String) 


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

required :transaction_id, String

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


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

required :type, Increase::Enum.new(:ach_transfer)