Class: Stripe::Terminal::Reader::RefundPaymentParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/terminal/reader.rb

Defined Under Namespace

Classes: RefundPaymentConfig

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, charge: nil, expand: nil, metadata: nil, payment_intent: nil, refund_application_fee: nil, refund_payment_config: nil, reverse_transfer: nil) ⇒ RefundPaymentParams

Returns a new instance of RefundPaymentParams.



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/stripe/resources/terminal/reader.rb', line 595

def initialize(
  amount: nil,
  charge: nil,
  expand: nil,
  metadata: nil,
  payment_intent: nil,
  refund_application_fee: nil,
  refund_payment_config: nil,
  reverse_transfer: nil
)
  @amount = amount
  @charge = charge
  @expand = expand
  @metadata = metadata
  @payment_intent = payment_intent
  @refund_application_fee = refund_application_fee
  @refund_payment_config = refund_payment_config
  @reverse_transfer = reverse_transfer
end

Instance Attribute Details

#amount ⇒ Object

A positive integer in __cents__ representing how much of this charge to refund.



579
580
581
 
# File 'lib/stripe/resources/terminal/reader.rb', line 579

def amount
  @amount
end

#charge ⇒ Object

ID of the Charge to refund.



581
582
583
 
# File 'lib/stripe/resources/terminal/reader.rb', line 581

def charge
  @charge
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



583
584
585
 
# File 'lib/stripe/resources/terminal/reader.rb', line 583

def expand
  @expand
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) 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`.



585
586
587
 
# File 'lib/stripe/resources/terminal/reader.rb', line 585

def metadata
  @metadata
end

#payment_intent ⇒ Object

ID of the PaymentIntent to refund.



587
588
589
 
# File 'lib/stripe/resources/terminal/reader.rb', line 587

def payment_intent
  @payment_intent
end

#refund_application_fee ⇒ Object

Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.



589
590
591
 
# File 'lib/stripe/resources/terminal/reader.rb', line 589

def refund_application_fee
  @refund_application_fee
end

#refund_payment_config ⇒ Object

Configuration overrides



591
592
593
 
# File 'lib/stripe/resources/terminal/reader.rb', line 591

def refund_payment_config
  @refund_payment_config
end

#reverse_transfer ⇒ Object

Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.



593
594
595
 
# File 'lib/stripe/resources/terminal/reader.rb', line 593

def reverse_transfer
  @reverse_transfer
end