Class: Increase::Models::Transaction::Source::InboundACHTransfer

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

Overview

See Also:

Defined Under Namespace

Classes: Addenda

Instance Attribute 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(addenda:, amount:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, receiver_id_number:, receiver_name:, trace_number:, transfer_id:) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Transaction::Source::InboundACHTransfer for more details.

An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `inbound_ach_transfer`. An Inbound ACH Transfer Intention is created when an ACH transfer is initiated at another bank and received by Increase.

Parameters:

  • addenda (Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil) —

    Additional information sent from the originator.

  • amount (Integer) —

    The transfer amount in USD cents.

  • originator_company_descriptive_date (String, nil) —

    The description of the date of the transfer, usually in the format ‘YYMMDD`.

  • originator_company_discretionary_data (String, nil) —

    Data set by the originator.

  • originator_company_entry_description (String) —

    An informational description of the transfer.

  • originator_company_id (String) —

    An identifier for the originating company. This is generally, but not always, a

  • originator_company_name (String) —

    A name set by the originator to identify themselves.

  • receiver_id_number (String, nil) —

    The originator’s identifier for the transfer recipient.

  • receiver_name (String, nil) —

    The name of the transfer recipient. This value is informational and not verified

  • trace_number (String) —

    A 15 digit number recorded in the Nacha file and available to both the originati

  • transfer_id (String) —

    The Inbound ACH Transfer’s identifier.




# File 'lib/increase/models/transaction.rb', line 6043

Instance Attribute Details

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

Additional information sent from the originator.

Returns:



5975
 
# File 'lib/increase/models/transaction.rb', line 5975

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

#amount ⇒ Integer

The transfer amount in USD cents.

Returns:

  • (Integer) 


5981
 
# File 'lib/increase/models/transaction.rb', line 5981

required :amount, Integer

#originator_company_descriptive_date ⇒ String?

The description of the date of the transfer, usually in the format ‘YYMMDD`.

Returns:

  • (String, nil) 


5987
 
# File 'lib/increase/models/transaction.rb', line 5987

required :originator_company_descriptive_date, String, nil?: true

#originator_company_discretionary_data ⇒ String?

Data set by the originator.

Returns:

  • (String, nil) 


5993
 
# File 'lib/increase/models/transaction.rb', line 5993

required :originator_company_discretionary_data, String, nil?: true

#originator_company_entry_description ⇒ String

An informational description of the transfer.

Returns:

  • (String) 


5999
 
# File 'lib/increase/models/transaction.rb', line 5999

required :originator_company_entry_description, String

#originator_company_id ⇒ String

An identifier for the originating company. This is generally, but not always, a stable identifier across multiple transfers.

Returns:

  • (String) 


6006
 
# File 'lib/increase/models/transaction.rb', line 6006

required :originator_company_id, String

#originator_company_name ⇒ String

A name set by the originator to identify themselves.

Returns:

  • (String) 


6012
 
# File 'lib/increase/models/transaction.rb', line 6012

required :originator_company_name, String

#receiver_id_number ⇒ String?

The originator’s identifier for the transfer recipient.

Returns:

  • (String, nil) 


6018
 
# File 'lib/increase/models/transaction.rb', line 6018

required :receiver_id_number, String, nil?: true

#receiver_name ⇒ String?

The name of the transfer recipient. This value is informational and not verified by Increase.

Returns:

  • (String, nil) 


6025
 
# File 'lib/increase/models/transaction.rb', line 6025

required :receiver_name, String, nil?: true

#trace_number ⇒ String

A 15 digit number recorded in the Nacha file and available to both the originating and receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer at either bank. ACH trace numbers are not unique, but are [used to correlate returns](increase.com/documentation/ach-returns#ach-returns).

Returns:

  • (String) 


6035
 
# File 'lib/increase/models/transaction.rb', line 6035

required :trace_number, String

#transfer_id ⇒ String

The Inbound ACH Transfer’s identifier.

Returns:

  • (String) 


6041
 
# File 'lib/increase/models/transaction.rb', line 6041

required :transfer_id, String