Class: Lithic::Models::PaymentReturnParams

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

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(financial_account_token:, return_reason_code:, addenda: nil, date_of_death: nil, memo: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::PaymentReturnParams for more details.

Parameters:

  • financial_account_token (String) —

    Globally unique identifier for the financial account

  • return_reason_code (String) —

    ACH return reason code indicating the reason for returning the payment. Supporte

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

    Optional additional information about the return. Limited to 44 characters

  • date_of_death (Date, nil) (defaults to: nil) —

    Date of death in YYYY-MM-DD format. Required when using return codes R14 (re

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

    Optional memo for the return. Limited to 10 characters

  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/lithic/models/payment_return_params.rb', line 45

Instance Attribute Details

#addenda ⇒ String?

Optional additional information about the return. Limited to 44 characters

Returns:

  • (String, nil) 


29
 
# File 'lib/lithic/models/payment_return_params.rb', line 29

optional :addenda, String, nil?: true

#date_of_death ⇒ Date?

Date of death in YYYY-MM-DD format. Required when using return codes R14 (representative payee deceased) or R15 (beneficiary or account holder deceased)

Returns:

  • (Date, nil) 


37
 
# File 'lib/lithic/models/payment_return_params.rb', line 37

optional :date_of_death, Date, nil?: true

#financial_account_token ⇒ String

Globally unique identifier for the financial account

Returns:

  • (String) 


14
 
# File 'lib/lithic/models/payment_return_params.rb', line 14

required :financial_account_token, String

#memo ⇒ String?

Optional memo for the return. Limited to 10 characters

Returns:

  • (String, nil) 


43
 
# File 'lib/lithic/models/payment_return_params.rb', line 43

optional :memo, String, nil?: true

#return_reason_code ⇒ String

ACH return reason code indicating the reason for returning the payment. Supported codes include R01-R53 and R80-R85. For a complete list of return codes and their meanings, see [ACH Return Reasons](docs.lithic.com/docs/ach-overview#ach-return-reasons)

Returns:

  • (String) 


23
 
# File 'lib/lithic/models/payment_return_params.rb', line 23

required :return_reason_code, String