Class: Stripe::PaymentIntentConfirmParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/payment_intent_confirm_params.rb

Defined Under Namespace

Classes: AmountDetails, Hooks, MandateData, PaymentDetails, PaymentMethodData, PaymentMethodOptions, RadarOptions, Shipping

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(amount_details: nil, amount_to_confirm: nil, application_fee_amount: nil, capture_method: nil, confirmation_token: nil, error_on_requires_action: nil, excluded_payment_method_types: nil, expand: nil, fx_quote: nil, hooks: nil, mandate: nil, mandate_data: nil, off_session: nil, payment_details: nil, payment_method: nil, payment_method_data: nil, payment_method_options: nil, payment_method_types: nil, radar_options: nil, receipt_email: nil, return_url: nil, setup_future_usage: nil, shipping: nil, use_stripe_sdk: nil) ⇒ PaymentIntentConfirmParams

Returns a new instance of PaymentIntentConfirmParams.



5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5693

def initialize(
  amount_details: nil,
  amount_to_confirm: nil,
  application_fee_amount: nil,
  capture_method: nil,
  confirmation_token: nil,
  error_on_requires_action: nil,
  excluded_payment_method_types: nil,
  expand: nil,
  fx_quote: nil,
  hooks: nil,
  mandate: nil,
  mandate_data: nil,
  off_session: nil,
  payment_details: nil,
  payment_method: nil,
  payment_method_data: nil,
  payment_method_options: nil,
  payment_method_types: nil,
  radar_options: nil,
  receipt_email: nil,
  return_url: nil,
  setup_future_usage: nil,
  shipping: nil,
  use_stripe_sdk: nil
)
  @amount_details = amount_details
  @amount_to_confirm = amount_to_confirm
  @application_fee_amount = application_fee_amount
  @capture_method = capture_method
  @confirmation_token = confirmation_token
  @error_on_requires_action = error_on_requires_action
  @excluded_payment_method_types = excluded_payment_method_types
  @expand = expand
  @fx_quote = fx_quote
  @hooks = hooks
  @mandate = mandate
  @mandate_data = mandate_data
  @off_session = off_session
  @payment_details = payment_details
  @payment_method = payment_method
  @payment_method_data = payment_method_data
  @payment_method_options = payment_method_options
  @payment_method_types = payment_method_types
  @radar_options = radar_options
  @receipt_email = receipt_email
  @return_url = return_url
  @setup_future_usage = setup_future_usage
  @shipping = shipping
  @use_stripe_sdk = use_stripe_sdk
end

Instance Attribute Details

#amount_details ⇒ Object

Provides industry-specific information about the amount.



5630
5631
5632
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5630

def amount_details
  @amount_details
end

#amount_to_confirm ⇒ Object

Amount to confirm on the PaymentIntent. Defaults to ‘amount` if not provided.



5632
5633
5634
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5632

def amount_to_confirm
  @amount_to_confirm
end

#application_fee_amount ⇒ Object

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](docs.stripe.com/payments/connected-accounts).



5634
5635
5636
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5634

def application_fee_amount
  @application_fee_amount
end

#capture_method ⇒ Object

Controls when the funds will be captured from the customer’s account.



5636
5637
5638
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5636

def capture_method
  @capture_method
end

#confirmation_token ⇒ Object

ID of the ConfirmationToken used to confirm this PaymentIntent.

If the provided ConfirmationToken contains properties that are also being provided in this request, such as ‘payment_method`, then the values in this request will take precedence.



5640
5641
5642
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5640

def confirmation_token
  @confirmation_token
end

#error_on_requires_action ⇒ Object

Set to ‘true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](docs.stripe.com/payments/save-card-without-authentication).



5642
5643
5644
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5642

def error_on_requires_action
  @error_on_requires_action
end

#excluded_payment_method_types ⇒ Object

The list of payment method types to exclude from use with this payment.



5644
5645
5646
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5644

def excluded_payment_method_types
  @excluded_payment_method_types
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



5646
5647
5648
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5646

def expand
  @expand
end

#fx_quote ⇒ Object

The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.



5648
5649
5650
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5648

def fx_quote
  @fx_quote
end

#hooks ⇒ Object

Automations to be run during the PaymentIntent lifecycle



5650
5651
5652
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5650

def hooks
  @hooks
end

#mandate ⇒ Object

ID of the mandate that’s used for this payment.



5652
5653
5654
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5652

def mandate
  @mandate
end

#mandate_data ⇒ Object

Attribute for param field mandate_data



5654
5655
5656
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5654

def mandate_data
  @mandate_data
end

#off_session ⇒ Object

Set to ‘true` to indicate that the customer isn’t in your checkout flow during this payment attempt and can’t authenticate. Use this parameter in scenarios where you collect card details and [charge them later](docs.stripe.com/payments/cards/charging-saved-cards).



5656
5657
5658
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5656

def off_session
  @off_session
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.



5658
5659
5660
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5658

def payment_details
  @payment_details
end

#payment_method ⇒ Object

ID of the payment method (a PaymentMethod, Card, or [compatible Source](docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. If the payment method is attached to a Customer, it must match the [customer](api.stripe.com#create_payment_intent-customer) that is set on this PaymentIntent.



5661
5662
5663
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5661

def payment_method
  @payment_method
end

#payment_method_data ⇒ Object

If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent.



5665
5666
5667
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5665

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this PaymentIntent.



5667
5668
5669
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5667

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object

The list of payment method types (for example, a card) that this PaymentIntent can use. Use ‘automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](docs.stripe.com/api/payment_methods/object#payment_method_object-type).



5669
5670
5671
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5669

def payment_method_types
  @payment_method_types
end

#radar_options ⇒ Object

Options to configure Radar. Learn more about [Radar Sessions](docs.stripe.com/radar/radar-session).



5671
5672
5673
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5671

def radar_options
  @radar_options
end

#receipt_email ⇒ Object

Email address that the receipt for the resulting payment will be sent to. If ‘receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](dashboard.stripe.com/account/emails).



5673
5674
5675
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5673

def receipt_email
  @receipt_email
end

#return_url ⇒ Object

The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.



5677
5678
5679
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5677

def return_url
  @return_url
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`.



5687
5688
5689
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5687

def setup_future_usage
  @setup_future_usage
end

#shipping ⇒ Object

Shipping information for this PaymentIntent.



5689
5690
5691
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5689

def shipping
  @shipping
end

#use_stripe_sdk ⇒ Object

Set to ‘true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.



5691
5692
5693
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5691

def use_stripe_sdk
  @use_stripe_sdk
end