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

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

Overview

See Also:

  • Increase::Models::Transaction::Source#inbound_ach_transfer

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

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 stable identifier across multiple transfers.

  • 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 by Increase.

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

  • transfer_id (String) —

    The Inbound ACH Transfer's identifier.




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

Instance Attribute Details

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

Additional information sent from the originator.

Parameters:

  • value (Increase::Transaction::Source::InboundACHTransfer::Addenda, nil)

Returns:



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

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

#amount ⇒ Integer

The transfer amount in USD cents.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :amount, Integer

#originator_company_descriptive_date ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :originator_company_descriptive_date, String, nil?: true

#originator_company_discretionary_data ⇒ String?

Data set by the originator.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :originator_company_discretionary_data, String, nil?: true

#originator_company_entry_description ⇒ String

An informational description of the transfer.

Parameters:

  • value (String)

Returns:

  • (String) 


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

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.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :originator_company_id, String

#originator_company_name ⇒ String

A name set by the originator to identify themselves.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :originator_company_name, String

#receiver_id_number ⇒ String?

The originator's identifier for the transfer recipient.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :trace_number, String

#transfer_id ⇒ String

The Inbound ACH Transfer's identifier.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :transfer_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


5164
 
# File 'sig/increase/models/transaction.rbs', line 5164

def to_hash: -> {