Class: Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix

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

Defined Under Namespace

Classes: MandateOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount_includes_iof: nil, expires_after_seconds: nil, expires_at: nil, mandate_options: nil, setup_future_usage: nil) ⇒ Pix

Returns a new instance of Pix.



13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
 
# File 'lib/stripe/resources/payment_intent.rb', line 13560

def initialize(
  amount_includes_iof: nil,
  expires_after_seconds: nil,
  expires_at: nil,
  mandate_options: nil,
  setup_future_usage: nil
)
  @amount_includes_iof = amount_includes_iof
  @expires_after_seconds = expires_after_seconds
  @expires_at = expires_at
  @mandate_options = mandate_options
  @setup_future_usage = setup_future_usage
end

Instance Attribute Details

#amount_includes_iof ⇒ Object

Determines if the amount includes the IOF tax. Defaults to ‘never`.



13542
13543
13544
 
# File 'lib/stripe/resources/payment_intent.rb', line 13542

def amount_includes_iof
  @amount_includes_iof
end

#expires_after_seconds ⇒ Object

The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.



13544
13545
13546
 
# File 'lib/stripe/resources/payment_intent.rb', line 13544

def expires_after_seconds
  @expires_after_seconds
end

#expires_at ⇒ Object

The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.



13546
13547
13548
 
# File 'lib/stripe/resources/payment_intent.rb', line 13546

def expires_at
  @expires_at
end

#mandate_options ⇒ Object

Additional fields for mandate creation. Only applicable when ‘setup_future_usage=off_session`.



13548
13549
13550
 
# File 'lib/stripe/resources/payment_intent.rb', line 13548

def mandate_options
  @mandate_options
end

#setup_future_usage ⇒ Object

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.

If the payment method is ‘card_present` and isn’t a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.

When processing card payments, Stripe uses ‘setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).

If you’ve already set ‘setup_future_usage` and you’re performing a request using a publishable key, you can only update the value from ‘on_session` to `off_session`.



13558
13559
13560
 
# File 'lib/stripe/resources/payment_intent.rb', line 13558

def setup_future_usage
  @setup_future_usage
end