Class: Stripe::InvoiceService::PayParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/invoice_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(expand: nil, forgive: nil, mandate: nil, off_session: nil, paid_out_of_band: nil, payment_method: nil, source: nil) ⇒ PayParams

Returns a new instance of PayParams.



1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
 
# File 'lib/stripe/services/invoice_service.rb', line 1771

def initialize(
  expand: nil,
  forgive: nil,
  mandate: nil,
  off_session: nil,
  paid_out_of_band: nil,
  payment_method: nil,
  source: nil
)
  @expand = expand
  @forgive = forgive
  @mandate = mandate
  @off_session = off_session
  @paid_out_of_band = paid_out_of_band
  @payment_method = payment_method
  @source = source
end

Instance Attribute Details

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1755
1756
1757
 
# File 'lib/stripe/services/invoice_service.rb', line 1755

def expand
  @expand
end

#forgive ⇒ Object

In cases where the source used to pay the invoice has insufficient funds, passing ‘forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.

Passing ‘forgive=false` will fail the charge if the source hasn’t been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to ‘false`.



1759
1760
1761
 
# File 'lib/stripe/services/invoice_service.rb', line 1759

def forgive
  @forgive
end

#mandate ⇒ Object

ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice’s default_payment_method or default_source, if set.



1761
1762
1763
 
# File 'lib/stripe/services/invoice_service.rb', line 1761

def mandate
  @mandate
end

#off_session ⇒ Object

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to ‘true` (off-session).



1763
1764
1765
 
# File 'lib/stripe/services/invoice_service.rb', line 1763

def off_session
  @off_session
end

Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to ‘false`.



1765
1766
1767
 
# File 'lib/stripe/services/invoice_service.rb', line 1765

def paid_out_of_band
  @paid_out_of_band
end

#payment_method ⇒ Object

A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.



1767
1768
1769
 
# File 'lib/stripe/services/invoice_service.rb', line 1767

def payment_method
  @payment_method
end

#source ⇒ Object

A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.



1769
1770
1771
 
# File 'lib/stripe/services/invoice_service.rb', line 1769

def source
  @source
end