Class: Stripe::SetupIntentConfirmParams

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

Defined Under Namespace

Classes: MandateData, PaymentMethodData, PaymentMethodOptions

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(confirmation_token: nil, expand: nil, mandate_data: nil, payment_method: nil, payment_method_data: nil, payment_method_options: nil, return_url: nil, use_stripe_sdk: nil) ⇒ SetupIntentConfirmParams

Returns a new instance of SetupIntentConfirmParams.



1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1337

def initialize(
  confirmation_token: nil,
  expand: nil,
  mandate_data: nil,
  payment_method: nil,
  payment_method_data: nil,
  payment_method_options: nil,
  return_url: nil,
  use_stripe_sdk: nil
)
  @confirmation_token = confirmation_token
  @expand = expand
  @mandate_data = mandate_data
  @payment_method = payment_method
  @payment_method_data = payment_method_data
  @payment_method_options = payment_method_options
  @return_url = return_url
  @use_stripe_sdk = use_stripe_sdk
end

Instance Attribute Details

#confirmation_token ⇒ Object

ID of the ConfirmationToken used to confirm this SetupIntent.

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.



1318
1319
1320
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1318

def confirmation_token
  @confirmation_token
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1320
1321
1322
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1320

def expand
  @expand
end

#mandate_data ⇒ Object

Attribute for param field mandate_data



1322
1323
1324
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1322

def mandate_data
  @mandate_data
end

#payment_method ⇒ Object

ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.



1324
1325
1326
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1324

def payment_method
  @payment_method
end

#payment_method_data ⇒ Object

When included, this hash creates a PaymentMethod that is set as the [‘payment_method`](docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent.



1327
1328
1329
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1327

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this SetupIntent.



1329
1330
1331
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1329

def payment_method_options
  @payment_method_options
end

#return_url ⇒ Object

The URL to redirect your customer back to after they authenticate 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.



1333
1334
1335
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1333

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



1335
1336
1337
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1335

def use_stripe_sdk
  @use_stripe_sdk
end