Class: Stripe::InvoicePayParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/invoice_pay_params.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) ⇒ InvoicePayParams

Returns a new instance of InvoicePayParams.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/stripe/params/invoice_pay_params.rb', line 23

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.



7
8
9
 
# File 'lib/stripe/params/invoice_pay_params.rb', line 7

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`.



11
12
13
 
# File 'lib/stripe/params/invoice_pay_params.rb', line 11

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.



13
14
15
 
# File 'lib/stripe/params/invoice_pay_params.rb', line 13

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).



15
16
17
 
# File 'lib/stripe/params/invoice_pay_params.rb', line 15

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`.



17
18
19
 
# File 'lib/stripe/params/invoice_pay_params.rb', line 17

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.



19
20
21
 
# File 'lib/stripe/params/invoice_pay_params.rb', line 19

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.



21
22
23
 
# File 'lib/stripe/params/invoice_pay_params.rb', line 21

def source
  @source
end