Class: Stripe::Tax::TransactionCreateReversalParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/tax/transaction_create_reversal_params.rb

Defined Under Namespace

Classes: LineItem, ShippingCost

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(expand: nil, flat_amount: nil, line_items: nil, metadata: nil, mode: nil, original_transaction: nil, reference: nil, shipping_cost: nil) ⇒ TransactionCreateReversalParams 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 66

def initialize(
  expand: nil,
  flat_amount: nil,
  line_items: nil,
  metadata: nil,
  mode: nil,
  original_transaction: nil,
  reference: nil,
  shipping_cost: nil
)
  @expand = expand
  @flat_amount = flat_amount
  @line_items = line_items
  @metadata = metadata
  @mode = mode
  @original_transaction = original_transaction
  @reference = reference
  @shipping_cost = shipping_cost
end

Instance Attribute Details

#expand ⇒ Object

Specifies which fields in the response should be expanded.



50
51
52
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 50

def expand
  @expand
end

#flat_amount ⇒ Object

A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes.



52
53
54
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 52

def flat_amount
  @flat_amount
end

#line_items ⇒ Object

The line item amounts to reverse.



54
55
56
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 54

def line_items
  @line_items
end

#metadata ⇒ Object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.



56
57
58
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 56

def metadata
  @metadata
end

#mode ⇒ Object

If partial, the provided line item or shipping cost amounts are reversed. If full, the original transaction is fully reversed.



58
59
60
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 58

def mode
  @mode
end

#original_transaction ⇒ Object

The ID of the Transaction to partially or fully reverse.



60
61
62
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 60

def original_transaction
  @original_transaction
end

#reference ⇒ Object

A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports.



62
63
64
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 62

def reference
  @reference
end

#shipping_cost ⇒ Object

The shipping cost to reverse.



64
65
66
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 64

def shipping_cost
  @shipping_cost
end