Class: Increase::Models::Simulations::CardRefundCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/simulations/card_refund_create_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(amount: nil, pending_transaction_id: nil, transaction_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Simulations::CardRefundCreateParams for more details.

Parameters:

  • amount (Integer) (defaults to: nil) —

    The refund amount in cents. Pulled off the ‘pending_transaction` or the `transac

  • pending_transaction_id (String) (defaults to: nil) —

    The identifier of the Pending Transaction for the refund authorization. If this

  • transaction_id (String) (defaults to: nil) —

    The identifier for the Transaction to refund. The Transaction’s source must have

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



# File 'lib/increase/models/simulations/card_refund_create_params.rb', line 33

Instance Attribute Details

#amount ⇒ Integer?

The refund amount in cents. Pulled off the ‘pending_transaction` or the `transaction` if not provided.

Returns:

  • (Integer, nil) 


16
 
# File 'lib/increase/models/simulations/card_refund_create_params.rb', line 16

optional :amount, Integer

#pending_transaction_id ⇒ String?

The identifier of the Pending Transaction for the refund authorization. If this is provided, ‘transaction` must not be provided as a refund with a refund authorized can not be linked to a regular transaction.

Returns:

  • (String, nil) 


24
 
# File 'lib/increase/models/simulations/card_refund_create_params.rb', line 24

optional :pending_transaction_id, String

#transaction_id ⇒ String?

The identifier for the Transaction to refund. The Transaction’s source must have a category of card_settlement.

Returns:

  • (String, nil) 


31
 
# File 'lib/increase/models/simulations/card_refund_create_params.rb', line 31

optional :transaction_id, String