Class: Stripe::SetupIntentConfirmParams

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

Defined Under Namespace

Classes: MandateData, PaymentMethodData, PaymentMethodOptions, SetupDetails

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, setup_details: nil, use_stripe_sdk: nil) ⇒ SetupIntentConfirmParams

Returns a new instance of SetupIntentConfirmParams.



1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1382

def initialize(
  confirmation_token: nil,
  expand: nil,
  mandate_data: nil,
  payment_method: nil,
  payment_method_data: nil,
  payment_method_options: nil,
  return_url: nil,
  setup_details: 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
  @setup_details = setup_details
  @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.



1361
1362
1363
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1361

def confirmation_token
  @confirmation_token
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1363
1364
1365
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1363

def expand
  @expand
end

#mandate_data ⇒ Object

Attribute for param field mandate_data



1365
1366
1367
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1365

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.



1367
1368
1369
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1367

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.



1370
1371
1372
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1370

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this SetupIntent.



1372
1373
1374
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1372

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.



1376
1377
1378
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1376

def return_url
  @return_url
end

#setup_details ⇒ Object

Provides industry-specific information about the SetupIntent.



1378
1379
1380
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1378

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



1380
1381
1382
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1380

def use_stripe_sdk
  @use_stripe_sdk
end