Class: ModernTreasury::Models::ReturnCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/return_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Code, ReconciliationStatus, ReturnableType Classes: Corrections

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(account_number: nil, company_id: nil, company_name: nil, individual_identification_number: nil, routing_number: nil, transaction_code: nil) ⇒ Object

Some parameter documentations has been truncated, see Corrections for more details.

Only relevant for ACH NOC returns. This is an object containing all of the new and corrected information provided by the bank that was previously incorrect on the original outgoing payment.

Parameters:

  • account_number (String, nil) (defaults to: nil) —

    The updated account number that should replace the one originally used on the ou

  • company_id (String, nil) (defaults to: nil) —

    The updated company ID that should replace the one originally used on the outgoi

  • company_name (String, nil) (defaults to: nil) —

    The updated company name that should replace the one originally used on the outg

  • individual_identification_number (String, nil) (defaults to: nil) —

    The updated individual identification number that should replace the one origina

  • routing_number (String, nil) (defaults to: nil) —

    The updated routing number that should replace the one originally used on the ou

  • transaction_code (String, nil) (defaults to: nil) —

    The updated account type code that should replace the one originally used on the




# File 'lib/modern_treasury/models/return_create_params.rb', line 70

Instance Attribute Details

#additional_information ⇒ String?

Some returns may include additional information from the bank. In these cases, this string will be present.

Returns:

  • (String, nil) 


28
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 28

optional :additional_information, String, nil?: true

#code ⇒ Symbol, ...

The return code. For ACH returns, this is the required ACH return code.

Returns:



34
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 34

optional :code, enum: -> { ModernTreasury::ReturnCreateParams::Code }, nil?: true

#corrections ⇒ ModernTreasury::Models::ReturnCreateParams::Corrections?

Only relevant for ACH NOC returns. This is an object containing all of the new and corrected information provided by the bank that was previously incorrect on the original outgoing payment.

Returns:



42
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 42

optional :corrections, -> { ModernTreasury::ReturnCreateParams::Corrections }, nil?: true

#data ⇒ Object?

The raw data from the return file that we get from the bank.

Returns:

  • (Object, nil) 


48
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 48

optional :data, ModernTreasury::Internal::Type::Unknown, nil?: true

#date_of_death ⇒ Date?

If the return code is ‘R14` or `R15` this is the date the deceased counterparty passed away.

Returns:

  • (Date, nil) 


55
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 55

optional :date_of_death, Date, nil?: true

#reason ⇒ String?

An optional description of the reason for the return. This is for internal usage and will not be transmitted to the bank.”

Returns:

  • (String, nil) 


62
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 62

optional :reason, String, nil?: true

#reconciliation_status ⇒ Symbol, ...

One of ‘unreconciled`, `tentatively_reconciled` or `reconciled`.

Returns:



68
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 68

optional :reconciliation_status, enum: -> { ModernTreasury::ReturnCreateParams::ReconciliationStatus }

#returnable_id ⇒ String?

The ID of the object being returned or ‘null`.

Returns:

  • (String, nil) 


14
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 14

required :returnable_id, String, nil?: true

#returnable_type ⇒ Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType

The type of object being returned. Currently, this may only be incoming_payment_detail.

Returns:



21
 
# File 'lib/modern_treasury/models/return_create_params.rb', line 21

required :returnable_type, enum: -> { ModernTreasury::ReturnCreateParams::ReturnableType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/return_create_params.rb', line 101