Class: Stripe::SetupIntentService::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/setup_intent_service.rb

Defined Under Namespace

Classes: AutomaticPaymentMethods, MandateData, PaymentMethodData, PaymentMethodOptions, SingleUse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(attach_to_self: nil, automatic_payment_methods: nil, confirm: nil, confirmation_token: nil, customer: nil, description: nil, expand: nil, flow_directions: nil, mandate_data: nil, metadata: nil, on_behalf_of: nil, payment_method: nil, payment_method_configuration: nil, payment_method_data: nil, payment_method_options: nil, payment_method_types: nil, return_url: nil, single_use: nil, usage: nil, use_stripe_sdk: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1370

def initialize(
  attach_to_self: nil,
  automatic_payment_methods: nil,
  confirm: nil,
  confirmation_token: nil,
  customer: nil,
  description: nil,
  expand: nil,
  flow_directions: nil,
  mandate_data: nil,
  metadata: nil,
  on_behalf_of: nil,
  payment_method: nil,
  payment_method_configuration: nil,
  payment_method_data: nil,
  payment_method_options: nil,
  payment_method_types: nil,
  return_url: nil,
  single_use: nil,
  usage: nil,
  use_stripe_sdk: nil
)
  @attach_to_self = attach_to_self
  @automatic_payment_methods = automatic_payment_methods
  @confirm = confirm
  @confirmation_token = confirmation_token
  @customer = customer
  @description = description
  @expand = expand
  @flow_directions = flow_directions
  @mandate_data = mandate_data
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @payment_method = payment_method
  @payment_method_configuration = payment_method_configuration
  @payment_method_data = payment_method_data
  @payment_method_options = payment_method_options
  @payment_method_types = payment_method_types
  @return_url = return_url
  @single_use = single_use
  @usage = usage
  @use_stripe_sdk = use_stripe_sdk
end

Instance Attribute Details

#attach_to_self ⇒ Object

If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account.

It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.



1304
1305
1306
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1304

def attach_to_self
  @attach_to_self
end

#automatic_payment_methods ⇒ Object

When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.



1307
1308
1309
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1307

def automatic_payment_methods
  @automatic_payment_methods
end

#confirm ⇒ Object

Set to ‘true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.



1310
1311
1312
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1310

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



1315
1316
1317
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1315

def confirmation_token
  @confirmation_token
end

#customer ⇒ Object

ID of the Customer this SetupIntent belongs to, if one exists.

If present, the SetupIntent’s payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.



1320
1321
1322
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1320

def customer
  @customer
end

#description ⇒ Object

An arbitrary string attached to the object. Often useful for displaying to users.



1323
1324
1325
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1323

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1326
1327
1328
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1326

def expand
  @expand
end

#flow_directions ⇒ Object

Indicates the directions of money movement for which this payment method is intended to be used.

Include ‘inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.



1331
1332
1333
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1331

def flow_directions
  @flow_directions
end

#mandate_data ⇒ Object

This hash contains details about the mandate to create. This parameter can only be used with [‘confirm=true`](stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).



1334
1335
1336
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1334

def mandate_data
  @mandate_data
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



1337
1338
1339
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1337

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The Stripe account ID created for this SetupIntent.



1340
1341
1342
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1340

def on_behalf_of
  @on_behalf_of
end

#payment_method ⇒ Object

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



1343
1344
1345
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1343

def payment_method
  @payment_method
end

#payment_method_configuration ⇒ Object

The ID of the [payment method configuration](stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.



1346
1347
1348
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1346

def payment_method_configuration
  @payment_method_configuration
end

#payment_method_data ⇒ Object

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



1350
1351
1352
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1350

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this SetupIntent.



1353
1354
1355
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1353

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object

The list of payment method types (for example, card) that this SetupIntent can use. If you don’t provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](dashboard.stripe.com/settings/payment_methods).



1356
1357
1358
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1356

def payment_method_types
  @payment_method_types
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. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [‘confirm=true`](stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).



1359
1360
1361
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1359

def return_url
  @return_url
end

#single_use ⇒ Object

If you populate this hash, this SetupIntent generates a ‘single_use` mandate after successful completion.



1362
1363
1364
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1362

def single_use
  @single_use
end

#usage ⇒ Object

Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to ‘off_session`.



1365
1366
1367
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1365

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



1368
1369
1370
 
# File 'lib/stripe/services/setup_intent_service.rb', line 1368

def use_stripe_sdk
  @use_stripe_sdk
end