Class: Increase::Models::InboundACHTransfer

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

Overview

See Also:

Defined Under Namespace

Modules: Direction, ExpectedSettlementSchedule, StandardEntryClassCode, Status, Type Classes: Acceptance, Addenda, Decline, InternationalAddenda, NotificationOfChange, TransferReturn

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, 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(updated_account_number: , updated_routing_number: ) ⇒ Object

If you initiate a notification of change in response to the transfer, this will contain its details.

Parameters:

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

    The new account number provided in the notification of change.

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

    The new account number provided in the notification of change.




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

Instance Attribute Details

#acceptance ⇒ Increase::Models::InboundACHTransfer::Acceptance?

If your transfer is accepted, this will contain details of the acceptance.

Returns:



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

required :acceptance, -> { Increase::InboundACHTransfer::Acceptance }, nil?: true

#account_id ⇒ String

The Account to which the transfer belongs.

Returns:

  • (String) 


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

required :account_id, String

#account_number_id ⇒ String

The identifier of the Account Number to which this transfer was sent.

Returns:

  • (String) 


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

required :account_number_id, String

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

Additional information sent from the originator.

Returns:



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

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

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


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

required :amount, Integer

#automatically_resolves_at ⇒ Time

The time at which the transfer will be automatically resolved.

Returns:

  • (Time) 


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

required :automatically_resolves_at, Time

#created_at ⇒ Time

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

Returns:

  • (Time) 


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

required :created_at, Time

#decline ⇒ Increase::Models::InboundACHTransfer::Decline?

If your transfer is declined, this will contain details of the decline.

Returns:



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

required :decline, -> { Increase::InboundACHTransfer::Decline }, nil?: true

#direction ⇒ Symbol, Increase::Models::InboundACHTransfer::Direction

The direction of the transfer.

Returns:



66
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 66

required :direction, enum: -> { Increase::InboundACHTransfer::Direction }

#effective_date ⇒ Date

The effective date of the transfer. This is sent by the sending bank and is a factor in determining funds availability.

Returns:

  • (Date) 


73
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 73

required :effective_date, Date

#expected_settlement_schedule ⇒ Symbol, Increase::Models::InboundACHTransfer::ExpectedSettlementSchedule

The settlement schedule the transfer is expected to follow.

Returns:



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

required :expected_settlement_schedule,
enum: -> { Increase::InboundACHTransfer::ExpectedSettlementSchedule }

#id ⇒ String

The inbound ACH transfer’s identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 11

required :id, String

#international_addenda ⇒ Increase::Models::InboundACHTransfer::InternationalAddenda?

If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields pertaining to the International ACH Transaction.

Returns:



87
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 87

required :international_addenda, -> { Increase::InboundACHTransfer::InternationalAddenda }, nil?: true

#notification_of_change ⇒ Increase::Models::InboundACHTransfer::NotificationOfChange?

If you initiate a notification of change in response to the transfer, this will contain its details.

Returns:



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

required :notification_of_change, -> { Increase::InboundACHTransfer::NotificationOfChange }, nil?: true

#originator_company_descriptive_date ⇒ String?

The descriptive date of the transfer.

Returns:

  • (String, nil) 


100
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 100

required :originator_company_descriptive_date, String, nil?: true

#originator_company_discretionary_data ⇒ String?

The additional information included with the transfer.

Returns:

  • (String, nil) 


106
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 106

required :originator_company_discretionary_data, String, nil?: true

#originator_company_entry_description ⇒ String

The description of the transfer.

Returns:

  • (String) 


112
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 112

required :originator_company_entry_description, String

#originator_company_id ⇒ String

The id of the company that initiated the transfer.

Returns:

  • (String) 


118
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 118

required :originator_company_id, String

#originator_company_name ⇒ String

The name of the company that initiated the transfer.

Returns:

  • (String) 


124
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 124

required :originator_company_name, String

#originator_routing_number ⇒ String

The American Banking Association (ABA) routing number of the bank originating the transfer.

Returns:

  • (String) 


131
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 131

required :originator_routing_number, String

#receiver_id_number ⇒ String?

The id of the receiver of the transfer.

Returns:

  • (String, nil) 


137
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 137

required :receiver_id_number, String, nil?: true

#receiver_name ⇒ String?

The name of the receiver of the transfer.

Returns:

  • (String, nil) 


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

required :receiver_name, String, nil?: true

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

The Standard Entry Class (SEC) code of the transfer.

Returns:



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

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

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

The status of the transfer.

Returns:



155
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 155

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

#trace_number ⇒ String

A 15 digit number set by the sending bank and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer. ACH trace numbers are not unique, but are [used to correlate returns](increase.com/documentation/ach-returns#ach-returns).

Returns:

  • (String) 


164
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 164

required :trace_number, String

#transfer_return ⇒ Increase::Models::InboundACHTransfer::TransferReturn?

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

Returns:



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

required :transfer_return, -> { Increase::InboundACHTransfer::TransferReturn }, nil?: true

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

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

Returns:



177
 
# File 'lib/increase/models/inbound_ach_transfer.rb', line 177

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/inbound_ach_transfer.rb', line 413