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



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1234

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

#allowed_payment_method_types ⇒ Object

The list of payment method types to allow for this SetupIntent. Stripe will only use methods in this list when determining the payment methods to offer. A list of valid payment method types can be found here.



1211
1212
1213
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1211

def allowed_payment_method_types
  @allowed_payment_method_types
end

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



1215
1216
1217
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1215

def confirmation_token
  @confirmation_token
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1217
1218
1219
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1217

def expand
  @expand
end

#mandate_data ⇒ Object

Attribute for param field mandate_data



1219
1220
1221
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1219

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.



1221
1222
1223
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1221

def payment_method
  @payment_method
end

#payment_method_data ⇒ Object

When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.



1224
1225
1226
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1224

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this SetupIntent.



1226
1227
1228
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1226

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.



1230
1231
1232
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1230

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.



1232
1233
1234
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1232

def use_stripe_sdk
  @use_stripe_sdk
end