Class: Increase::Models::ACHPrenotification

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

Defined Under Namespace

Classes: NotificationsOfChange, PrenotificationReturn

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

Instance Attribute Details

#account_number ⇒ String

The destination account number.

Returns:

  • (String) 


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

required :account_number, String

#addendum ⇒ String

Additional information for the recipient.

Returns:

  • (String) 


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

required :addendum, String

#company_descriptive_date ⇒ String

The description of the date of the notification.

Returns:

  • (String) 


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

required :company_descriptive_date, String

#company_discretionary_data ⇒ String

Optional data associated with the notification.

Returns:

  • (String) 


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

required :company_discretionary_data, String

#company_entry_description ⇒ String

The description of the notification.

Returns:

  • (String) 


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

required :company_entry_description, String

#company_name ⇒ String

The name by which you know the company.

Returns:

  • (String) 


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

required :company_name, String

#created_at ⇒ String

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

Returns:

  • (String) 


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

required :created_at, String

#credit_debit_indicator ⇒ Symbol

If the notification is for a future credit or debit.

Returns:

  • (Symbol) 


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

required :credit_debit_indicator, Increase::Enum.new(:credit, :debit)

#effective_date ⇒ String

The effective date in ISO 8601 format.

Returns:

  • (String) 


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

required :effective_date, String

#id ⇒ String

The ACH Prenotification's identifier.

Returns:

  • (String) 


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


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

required :idempotency_key, String

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

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

Returns:



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

required :notifications_of_change,
Increase::ArrayOf.new(-> { Increase::Models::ACHPrenotification::NotificationsOfChange })

#prenotification_return ⇒ Increase::Models::ACHPrenotification::PrenotificationReturn

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

Returns:



70
 
# File 'lib/increase/models/ach_prenotification.rb', line 70

required :prenotification_return, -> { Increase::Models::ACHPrenotification::PrenotificationReturn }

#routing_number ⇒ String

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

Returns:

  • (String) 


75
 
# File 'lib/increase/models/ach_prenotification.rb', line 75

required :routing_number, String

#status ⇒ Symbol

The lifecycle status of the ACH Prenotification.

Returns:

  • (Symbol) 


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

required :status, Increase::Enum.new(:pending_submitting, :requires_attention, :returned, :submitted)

#type ⇒ Symbol

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

Returns:

  • (Symbol) 


85
 
# File 'lib/increase/models/ach_prenotification.rb', line 85

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