Class: Increase::Models::Transaction::Source::ACHTransferReturn

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

Defined Under Namespace

Modules: ReturnReasonCode

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_information:, created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:) ⇒ Object

An ACH Transfer Return object. This field will be present in the JSON response if and only if category is equal to ach_transfer_return. An ACH Transfer Return is created when an ACH Transfer is returned by the receiving bank. It offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within the first two business days after the transfer is initiated, but can occur much later. The return appears as a new posted Transaction; no Pending Transaction is created.

Parameters:

  • addenda_information (String, nil) —

    Additional free-form information included by the receiving bank in the return's addenda record. This is raw, uninterpreted text whose presence and format are not guaranteed. For a file_record_edit_criteria (R17) return the receiving bank may set this to QUESTIONABLE (optionally followed by more text) to indicate it believes the transfer was initiated under questionable circumstances.

  • created_at (Time) —

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

  • raw_return_reason_code (String) —

    The three character ACH return code, in the range R01 to R85.

  • return_reason_code (Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode) —

    Why the ACH Transfer was returned. This reason code is sent by the receiving bank back to Increase.

  • trace_number (String) —

    A 15 digit number that was generated by the bank that initiated the return. The trace number of the return is different than that of the original transfer. ACH trace numbers are not unique, but along with the amount and date this number can be used to identify the ACH return at the bank that initiated it.

  • transaction_id (String) —

    The identifier of the Transaction associated with this return.

  • transfer_id (String) —

    The identifier of the ACH Transfer associated with this return. This matches the original Transaction's source.ach_transfer_intention.transfer_id.




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

Instance Attribute Details

#addenda_information ⇒ String?

Additional free-form information included by the receiving bank in the return's addenda record. This is raw, uninterpreted text whose presence and format are not guaranteed. For a file_record_edit_criteria (R17) return the receiving bank may set this to QUESTIONABLE (optionally followed by more text) to indicate it believes the transfer was initiated under questionable circumstances.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :addenda_information, String, nil?: true

#created_at ⇒ Time

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

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#raw_return_reason_code ⇒ String

The three character ACH return code, in the range R01 to R85.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :raw_return_reason_code, String

#return_reason_code ⇒ Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode

Why the ACH Transfer was returned. This reason code is sent by the receiving bank back to Increase.

Parameters:

  • value (Increase::Models::Transaction::Source::ACHTransferReturn::return_reason_code)

Returns:



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

required :return_reason_code,
enum: -> { Increase::Transaction::Source::ACHTransferReturn::ReturnReasonCode }

#trace_number ⇒ String

A 15 digit number that was generated by the bank that initiated the return. The trace number of the return is different than that of the original transfer. ACH trace numbers are not unique, but along with the amount and date this number can be used to identify the ACH return at the bank that initiated it.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :trace_number, String

#transaction_id ⇒ String

The identifier of the Transaction associated with this return.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :transaction_id, String

#transfer_id ⇒ String

The identifier of the ACH Transfer associated with this return. This matches the original Transaction's source.ach_transfer_intention.transfer_id.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :transfer_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {