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(allowed_payment_method_types: nil, 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.



5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5784

def initialize(
  allowed_payment_method_types: nil,
  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
)
  @allowed_payment_method_types = allowed_payment_method_types
  @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

#allowed_payment_method_types ⇒ Object

The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the payment_method_types field of the response, based on the other PaymentIntent parameters, such as currency, amount, and customer.



5719
5720
5721
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5719

def allowed_payment_method_types
  @allowed_payment_method_types
end

#amount_details ⇒ Object

Provides industry-specific information about the amount.



5721
5722
5723
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5721

def amount_details
  @amount_details
end

#amount_to_confirm ⇒ Object

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



5723
5724
5725
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5723

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.



5725
5726
5727
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5725

def application_fee_amount
  @application_fee_amount
end

#capture_method ⇒ Object

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



5727
5728
5729
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5727

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.



5731
5732
5733
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5731

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.



5733
5734
5735
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5733

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.



5735
5736
5737
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5735

def excluded_payment_method_types
  @excluded_payment_method_types
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



5737
5738
5739
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5737

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.



5739
5740
5741
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5739

def fx_quote
  @fx_quote
end

#hooks ⇒ Object

Automations to be run during the PaymentIntent lifecycle



5741
5742
5743
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5741

def hooks
  @hooks
end

#mandate ⇒ Object

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



5743
5744
5745
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5743

def mandate
  @mandate
end

#mandate_data ⇒ Object

Attribute for param field mandate_data



5745
5746
5747
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5745

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 payment method details and charge them later.



5747
5748
5749
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5747

def off_session
  @off_session
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.



5749
5750
5751
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5749

def payment_details
  @payment_details
end

#payment_method ⇒ Object

ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If the payment method is attached to a Customer, it must match the customer that is set on this PaymentIntent.



5752
5753
5754
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5752

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 property on the PaymentIntent.



5756
5757
5758
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5756

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this PaymentIntent.



5758
5759
5760
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5758

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. If you don't provide this, Stripe will dynamically show relevant payment methods from your payment method settings. A list of valid payment method types can be found here.



5760
5761
5762
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5760

def payment_method_types
  @payment_method_types
end

#radar_options ⇒ Object

Options to configure Radar. Learn more about Radar Sessions.



5762
5763
5764
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5762

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.



5764
5765
5766
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5764

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.



5768
5769
5770
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5768

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

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.



5778
5779
5780
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5778

def setup_future_usage
  @setup_future_usage
end

#shipping ⇒ Object

Shipping information for this PaymentIntent.



5780
5781
5782
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5780

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.



5782
5783
5784
 
# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 5782

def use_stripe_sdk
  @use_stripe_sdk
end