Class: Stripe::PaymentIntentConfirmParams

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::PaymentIntentConfirmParams

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

• #amount_details ⇒ Object

  Provides industry-specific information about the amount.

• #amount_to_confirm ⇒ Object

  Amount to confirm on the PaymentIntent.

• #capture_method ⇒ Object

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

• #confirmation_token ⇒ Object

  ID of the ConfirmationToken used to confirm this PaymentIntent.

• #error_on_requires_action ⇒ Object

  Set to ‘true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`.

• #excluded_payment_method_types ⇒ Object

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

• #expand ⇒ Object

  Specifies which fields in the response should be expanded.

• #hooks ⇒ Object

  Automations to be run during the PaymentIntent lifecycle.

• #mandate ⇒ Object

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

• #mandate_data ⇒ Object

  Attribute for param field mandate_data.

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

• #payment_details ⇒ Object

  Provides industry-specific information about the charge.

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

• #payment_method_data ⇒ Object

  If provided, this hash will be used to create a PaymentMethod.

• #payment_method_options ⇒ Object

  Payment method-specific configuration for this PaymentIntent.

• #payment_method_types ⇒ Object

  The list of payment method types (for example, a card) that this PaymentIntent can use.

• #radar_options ⇒ Object

  Options to configure Radar.

• #receipt_email ⇒ Object

  Email address that the receipt for the resulting payment will be sent to.

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

• #setup_future_usage ⇒ Object

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

• #shipping ⇒ Object

  Shipping information for this PaymentIntent.

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

Instance Method Summary

• #initialize(amount_details: nil, amount_to_confirm: nil, capture_method: nil, confirmation_token: nil, error_on_requires_action: nil, excluded_payment_method_types: nil, expand: 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 constructor

  A new instance of PaymentIntentConfirmParams.

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, capture_method: nil, confirmation_token: nil, error_on_requires_action: nil, excluded_payment_method_types: nil, expand: 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.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2795

def initialize(
  amount_details: nil,
  amount_to_confirm: nil,
  capture_method: nil,
  confirmation_token: nil,
  error_on_requires_action: nil,
  excluded_payment_method_types: nil,
  expand: 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
  @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
  @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.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2736

def amount_details
  @amount_details
end

#amount_to_confirm ⇒ Object

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

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2738

def amount_to_confirm
  @amount_to_confirm
end

#capture_method ⇒ Object

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

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2740

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.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2744

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

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2746

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.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2748

def excluded_payment_method_types
  @excluded_payment_method_types
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2750

def expand
  @expand
end

#hooks ⇒ Object

Automations to be run during the PaymentIntent lifecycle

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2752

def hooks
  @hooks
end

#mandate ⇒ Object

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

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2754

def mandate
  @mandate
end

#mandate_data ⇒ Object

Attribute for param field mandate_data

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2756

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](docs.stripe.com/payments/save-during-payment).

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2758

def off_session
  @off_session
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2760

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.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2763

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.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2767

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this PaymentIntent.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2769

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

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2771

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

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2773

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

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2775

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.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2779

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

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2789

def setup_future_usage
  @setup_future_usage
end

#shipping ⇒ Object

Shipping information for this PaymentIntent.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2791

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.

# File 'lib/stripe/params/payment_intent_confirm_params.rb', line 2793

def use_stripe_sdk
  @use_stripe_sdk
end