Class: Stripe::PaymentIntentApplyCustomerBalanceParams

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, currency: nil, expand: nil) ⇒ PaymentIntentApplyCustomerBalanceParams

Returns a new instance of PaymentIntentApplyCustomerBalanceParams.



17
18
19
20
21
 
# File 'lib/stripe/params/payment_intent_apply_customer_balance_params.rb', line 17

def initialize(amount: nil, currency: nil, expand: nil)
  @amount = amount
  @currency = currency
  @expand = expand
end

Instance Attribute Details

#amount ⇒ Object

Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter.

A positive integer representing how much to charge in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent.

When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.



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

def amount
  @amount
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



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

def currency
  @currency
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



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

def expand
  @expand
end