Class: Stripe::SetupIntent

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/setup_intent.rb

Overview

A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer’s card without immediately collecting a payment. Later, you can use [PaymentIntents](stripe.com/docs/api#payment_intents) to drive the payment flow.

Create a SetupIntent when you’re ready to collect your customer’s payment credentials. Don’t maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process.

Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](stripe.com/docs/api#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](stripe.com/docs/api#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: [Setup Intents API](docs.stripe.com/payments/setup-intents)

Defined Under Namespace

Classes: AutomaticPaymentMethods, CancelParams, ConfirmParams, CreateParams, LastSetupError, ListParams, NextAction, PaymentMethodConfigurationDetails, PaymentMethodOptions, UpdateParams, VerifyMicrodepositsParams

Constant Summary collapse

OBJECT_NAME = 
"setup_intent"

Constants inherited from StripeObject

Stripe::StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#application ⇒ Object (readonly)

ID of the Connect application that created the SetupIntent.



3288
3289
3290
 
# File 'lib/stripe/resources/setup_intent.rb', line 3288

def application
  @application
end

#attach_to_self ⇒ Object (readonly)

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.



3292
3293
3294
 
# File 'lib/stripe/resources/setup_intent.rb', line 3292

def attach_to_self
  @attach_to_self
end

#automatic_payment_methods ⇒ Object (readonly)

Settings for dynamic payment methods compatible with this Setup Intent



3294
3295
3296
 
# File 'lib/stripe/resources/setup_intent.rb', line 3294

def automatic_payment_methods
  @automatic_payment_methods
end

#cancellation_reason ⇒ Object (readonly)

Reason for cancellation of this SetupIntent, one of ‘abandoned`, `requested_by_customer`, or `duplicate`.



3296
3297
3298
 
# File 'lib/stripe/resources/setup_intent.rb', line 3296

def cancellation_reason
  @cancellation_reason
end

#client_secret ⇒ Object (readonly)

The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.



3300
3301
3302
 
# File 'lib/stripe/resources/setup_intent.rb', line 3300

def client_secret
  @client_secret
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



3302
3303
3304
 
# File 'lib/stripe/resources/setup_intent.rb', line 3302

def created
  @created
end

#customer ⇒ Object (readonly)

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.



3306
3307
3308
 
# File 'lib/stripe/resources/setup_intent.rb', line 3306

def customer
  @customer
end

#description ⇒ Object (readonly)

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



3308
3309
3310
 
# File 'lib/stripe/resources/setup_intent.rb', line 3308

def description
  @description
end

#flow_directions ⇒ Object (readonly)

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.



3312
3313
3314
 
# File 'lib/stripe/resources/setup_intent.rb', line 3312

def flow_directions
  @flow_directions
end

#id ⇒ Object (readonly)

Unique identifier for the object.



3314
3315
3316
 
# File 'lib/stripe/resources/setup_intent.rb', line 3314

def id
  @id
end

#last_setup_error ⇒ Object (readonly)

The error encountered in the previous SetupIntent confirmation.



3316
3317
3318
 
# File 'lib/stripe/resources/setup_intent.rb', line 3316

def last_setup_error
  @last_setup_error
end

#latest_attempt ⇒ Object (readonly)

The most recent SetupAttempt for this SetupIntent.



3318
3319
3320
 
# File 'lib/stripe/resources/setup_intent.rb', line 3318

def latest_attempt
  @latest_attempt
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



3320
3321
3322
 
# File 'lib/stripe/resources/setup_intent.rb', line 3320

def livemode
  @livemode
end

#mandate ⇒ Object (readonly)

ID of the multi use Mandate generated by the SetupIntent.



3322
3323
3324
 
# File 'lib/stripe/resources/setup_intent.rb', line 3322

def mandate
  @mandate
end

#metadata ⇒ Object (readonly)

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.



3324
3325
3326
 
# File 'lib/stripe/resources/setup_intent.rb', line 3324

def metadata
  @metadata
end

#next_action ⇒ Object (readonly)

If present, this property tells you what actions you need to take in order for your customer to continue payment setup.



3326
3327
3328
 
# File 'lib/stripe/resources/setup_intent.rb', line 3326

def next_action
  @next_action
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



3328
3329
3330
 
# File 'lib/stripe/resources/setup_intent.rb', line 3328

def object
  @object
end

#on_behalf_of ⇒ Object (readonly)

The account (if any) for which the setup is intended.



3330
3331
3332
 
# File 'lib/stripe/resources/setup_intent.rb', line 3330

def on_behalf_of
  @on_behalf_of
end

#payment_method ⇒ Object (readonly)

ID of the payment method used with this SetupIntent. If the payment method is ‘card_present` and isn’t a digital wallet, then the [generated_card](docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the ‘latest_attempt` is attached to the Customer instead.



3332
3333
3334
 
# File 'lib/stripe/resources/setup_intent.rb', line 3332

def payment_method
  @payment_method
end

#payment_method_configuration_details ⇒ Object (readonly)

Information about the [payment method configuration](stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.



3334
3335
3336
 
# File 'lib/stripe/resources/setup_intent.rb', line 3334

def payment_method_configuration_details
  @payment_method_configuration_details
end

#payment_method_options ⇒ Object (readonly)

Payment method-specific configuration for this SetupIntent.



3336
3337
3338
 
# File 'lib/stripe/resources/setup_intent.rb', line 3336

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object (readonly)

The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.



3338
3339
3340
 
# File 'lib/stripe/resources/setup_intent.rb', line 3338

def payment_method_types
  @payment_method_types
end

#single_use_mandate ⇒ Object (readonly)

ID of the single_use Mandate generated by the SetupIntent.



3340
3341
3342
 
# File 'lib/stripe/resources/setup_intent.rb', line 3340

def single_use_mandate
  @single_use_mandate
end

#status ⇒ Object (readonly)

[Status](stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of ‘requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.



3342
3343
3344
 
# File 'lib/stripe/resources/setup_intent.rb', line 3342

def status
  @status
end

#usage ⇒ Object (readonly)

Indicates how the payment method is intended to be used in the future.

Use ‘on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.



3346
3347
3348
 
# File 'lib/stripe/resources/setup_intent.rb', line 3346

def usage
  @usage
end

Class Method Details

.cancel(intent, params = {}, opts = {}) ⇒ Object

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](docs.stripe.com/docs/api/checkout/sessions/expire) instead.



3363
3364
3365
3366
3367
3368
3369
3370
 
# File 'lib/stripe/resources/setup_intent.rb', line 3363

def self.cancel(intent, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/setup_intents/%<intent>s/cancel", { intent: CGI.escape(intent) }),
    params: params,
    opts: opts
  )
end

.confirm(intent, params = {}, opts = {}) ⇒ Object

Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.



3409
3410
3411
3412
3413
3414
3415
3416
 
# File 'lib/stripe/resources/setup_intent.rb', line 3409

def self.confirm(intent, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/setup_intents/%<intent>s/confirm", { intent: CGI.escape(intent) }),
    params: params,
    opts: opts
  )
end

.create(params = {}, opts = {}) ⇒ Object

Creates a SetupIntent object.

After you create the SetupIntent, attach a payment method and [confirm](docs.stripe.com/docs/api/setup_intents/confirm) it to collect any required permissions to charge the payment method later.



3422
3423
3424
 
# File 'lib/stripe/resources/setup_intent.rb', line 3422

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/setup_intents", params: params, opts: opts)
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of SetupIntents.



3427
3428
3429
 
# File 'lib/stripe/resources/setup_intent.rb', line 3427

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/setup_intents", params: params, opts: opts)
end

.object_name ⇒ Object 



32
33
34
 
# File 'lib/stripe/resources/setup_intent.rb', line 32

def self.object_name
  "setup_intent"
end

.update(intent, params = {}, opts = {}) ⇒ Object

Updates a SetupIntent object.



3432
3433
3434
3435
3436
3437
3438
3439
 
# File 'lib/stripe/resources/setup_intent.rb', line 3432

def self.update(intent, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/setup_intents/%<intent>s", { intent: CGI.escape(intent) }),
    params: params,
    opts: opts
  )
end

.verify_microdeposits(intent, params = {}, opts = {}) ⇒ Object

Verifies microdeposits on a SetupIntent object.



3452
3453
3454
3455
3456
3457
3458
3459
 
# File 'lib/stripe/resources/setup_intent.rb', line 3452

def self.verify_microdeposits(intent, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/setup_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(intent) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#cancel(params = {}, opts = {}) ⇒ Object

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](docs.stripe.com/docs/api/checkout/sessions/expire) instead.



3351
3352
3353
3354
3355
3356
3357
3358
 
# File 'lib/stripe/resources/setup_intent.rb', line 3351

def cancel(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/setup_intents/%<intent>s/cancel", { intent: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#confirm(params = {}, opts = {}) ⇒ Object

Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.



3386
3387
3388
3389
3390
3391
3392
3393
 
# File 'lib/stripe/resources/setup_intent.rb', line 3386

def confirm(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/setup_intents/%<intent>s/confirm", { intent: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#verify_microdeposits(params = {}, opts = {}) ⇒ Object

Verifies microdeposits on a SetupIntent object.



3442
3443
3444
3445
3446
3447
3448
3449
 
# File 'lib/stripe/resources/setup_intent.rb', line 3442

def verify_microdeposits(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/setup_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end