Class: ModernTreasury::Models::PaymentOrders::ReversalCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::PaymentOrders::ReversalCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/payment_orders/reversal_create_params.rb

Overview

See Also:

• Resources::PaymentOrders::Reversals#create

Defined Under Namespace

Modules: Reason

Instance Attribute Summary

• #ledger_transaction ⇒ ModernTreasury::Models::LedgerTransactionCreateRequest^?

  Specifies a ledger transaction object that will be created with the reversal.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional data represented as key-value pairs.

• #reason ⇒ Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::Reason

  The reason for the reversal.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(reason: , ledger_transaction: nil, metadata: nil, request_options: {}) ⇒ Object constructor

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

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(reason: , ledger_transaction: nil, metadata: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::PaymentOrders::ReversalCreateParams for more details.

Parameters:

• reason (Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::Reason) (defaults to: ) —

  The reason for the reversal. Must be one of ‘duplicate`, `incorrect_amount`, `in

• ledger_transaction (ModernTreasury::Models::LedgerTransactionCreateRequest) (defaults to: nil) —

  Specifies a ledger transaction object that will be created with the reversal. If

• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  Additional data represented as key-value pairs. Both the key and value must be s

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

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

Instance Attribute Details

#ledger_transaction ⇒ ModernTreasury::Models::LedgerTransactionCreateRequest^?

Specifies a ledger transaction object that will be created with the reversal. If the ledger transaction cannot be created, then the reversal creation will fail. The resulting ledger transaction will mirror the status of the reversal.

Returns:

• (ModernTreasury::Models::LedgerTransactionCreateRequest, nil)

# File 'lib/modern_treasury/models/payment_orders/reversal_create_params.rb', line 25

optional :ledger_transaction, -> { ModernTreasury::LedgerTransactionCreateRequest }

#metadata ⇒ Hash{Symbol=>String}^?

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/modern_treasury/models/payment_orders/reversal_create_params.rb', line 32

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#reason ⇒ Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::Reason

The reason for the reversal. Must be one of ‘duplicate`, `incorrect_amount`, `incorrect_receiving_account`, `date_earlier_than_intended`, `date_later_than_intended`.

Returns:

• (Symbol, ModernTreasury::Models::PaymentOrders::ReversalCreateParams::Reason)

# File 'lib/modern_treasury/models/payment_orders/reversal_create_params.rb', line 17

required :reason, enum: -> { ModernTreasury::PaymentOrders::ReversalCreateParams::Reason }