Class: Increase::Models::ACHTransfer::Return

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

Overview

See Also:

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

Some parameter documentations has been truncated, see Increase::Models::ACHTransfer::Return for more details.

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

Parameters:

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

  • raw_return_reason_code (String) (defaults to: ) —

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

  • return_reason_code (Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode) (defaults to: ) —

    Why the ACH Transfer was returned. This reason code is sent by the receiving ban

  • trace_number (String) (defaults to: ) —

    A 15 digit number that was generated by the bank that initiated the return. The

  • transaction_id (String) (defaults to: ) —

    The identifier of the Transaction associated with this return.

  • transfer_id (String) (defaults to: ) —

    The identifier of the ACH Transfer associated with this return.




# File 'lib/increase/models/ach_transfer.rb', line 1025

Instance Attribute Details

#created_at ⇒ Time

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

Returns:

  • (Time) 


989
 
# File 'lib/increase/models/ach_transfer.rb', line 989

required :created_at, Time

#raw_return_reason_code ⇒ String

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

Returns:

  • (String) 


995
 
# File 'lib/increase/models/ach_transfer.rb', line 995

required :raw_return_reason_code, String

#return_reason_code ⇒ Symbol, Increase::Models::ACHTransfer::Return::ReturnReasonCode

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

Returns:



1002
 
# File 'lib/increase/models/ach_transfer.rb', line 1002

required :return_reason_code, enum: -> { Increase::ACHTransfer::Return::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.

Returns:

  • (String) 


1011
 
# File 'lib/increase/models/ach_transfer.rb', line 1011

required :trace_number, String

#transaction_id ⇒ String

The identifier of the Transaction associated with this return.

Returns:

  • (String) 


1017
 
# File 'lib/increase/models/ach_transfer.rb', line 1017

required :transaction_id, String

#transfer_id ⇒ String

The identifier of the ACH Transfer associated with this return.

Returns:

  • (String) 


1023
 
# File 'lib/increase/models/ach_transfer.rb', line 1023

required :transfer_id, String