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](api.stripe.com#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](api.stripe.com#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](api.stripe.com#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, LastSetupError, ManagedPayments, NextAction, PaymentMethodConfigurationDetails, PaymentMethodOptions

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

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #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.



746
747
748
 
# File 'lib/stripe/resources/setup_intent.rb', line 746

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.



750
751
752
 
# File 'lib/stripe/resources/setup_intent.rb', line 750

def attach_to_self
  @attach_to_self
end

#automatic_payment_methods ⇒ Object (readonly)

Settings for dynamic payment methods compatible with this Setup Intent



752
753
754
 
# File 'lib/stripe/resources/setup_intent.rb', line 752

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



754
755
756
 
# File 'lib/stripe/resources/setup_intent.rb', line 754

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.



758
759
760
 
# File 'lib/stripe/resources/setup_intent.rb', line 758

def client_secret
  @client_secret
end

#created ⇒ Object (readonly)

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



760
761
762
 
# File 'lib/stripe/resources/setup_intent.rb', line 760

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.



764
765
766
 
# File 'lib/stripe/resources/setup_intent.rb', line 764

def customer
  @customer
end

#customer_account ⇒ Object (readonly)

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

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



768
769
770
 
# File 'lib/stripe/resources/setup_intent.rb', line 768

def 
  @customer_account
end

#description ⇒ Object (readonly)

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



770
771
772
 
# File 'lib/stripe/resources/setup_intent.rb', line 770

def description
  @description
end

#excluded_payment_method_types ⇒ Object (readonly)

Payment method types that are excluded from this SetupIntent.



772
773
774
 
# File 'lib/stripe/resources/setup_intent.rb', line 772

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



776
777
778
 
# File 'lib/stripe/resources/setup_intent.rb', line 776

def flow_directions
  @flow_directions
end

#id ⇒ Object (readonly)

Unique identifier for the object.



778
779
780
 
# File 'lib/stripe/resources/setup_intent.rb', line 778

def id
  @id
end

#last_setup_error ⇒ Object (readonly)

The error encountered in the previous SetupIntent confirmation.



780
781
782
 
# File 'lib/stripe/resources/setup_intent.rb', line 780

def last_setup_error
  @last_setup_error
end

#latest_attempt ⇒ Object (readonly)

The most recent SetupAttempt for this SetupIntent.



782
783
784
 
# File 'lib/stripe/resources/setup_intent.rb', line 782

def latest_attempt
  @latest_attempt
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



784
785
786
 
# File 'lib/stripe/resources/setup_intent.rb', line 784

def livemode
  @livemode
end

#managed_payments ⇒ Object (readonly)

Attribute for field managed_payments



786
787
788
 
# File 'lib/stripe/resources/setup_intent.rb', line 786

def managed_payments
  @managed_payments
end

#mandate ⇒ Object (readonly)

ID of the multi use Mandate generated by the SetupIntent.



788
789
790
 
# File 'lib/stripe/resources/setup_intent.rb', line 788

def mandate
  @mandate
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



790
791
792
 
# File 'lib/stripe/resources/setup_intent.rb', line 790

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.



792
793
794
 
# File 'lib/stripe/resources/setup_intent.rb', line 792

def next_action
  @next_action
end

#object ⇒ Object (readonly)

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



794
795
796
 
# File 'lib/stripe/resources/setup_intent.rb', line 794

def object
  @object
end

#on_behalf_of ⇒ Object (readonly)

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



796
797
798
 
# File 'lib/stripe/resources/setup_intent.rb', line 796

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.



798
799
800
 
# File 'lib/stripe/resources/setup_intent.rb', line 798

def payment_method
  @payment_method
end

#payment_method_configuration_details ⇒ Object (readonly)

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



800
801
802
 
# File 'lib/stripe/resources/setup_intent.rb', line 800

def payment_method_configuration_details
  @payment_method_configuration_details
end

#payment_method_options ⇒ Object (readonly)

Payment method-specific configuration for this SetupIntent.



802
803
804
 
# File 'lib/stripe/resources/setup_intent.rb', line 802

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. A list of valid payment method types can be found [here](docs.stripe.com/api/payment_methods/object#payment_method_object-type).



804
805
806
 
# File 'lib/stripe/resources/setup_intent.rb', line 804

def payment_method_types
  @payment_method_types
end

#single_use_mandate ⇒ Object (readonly)

ID of the single_use Mandate generated by the SetupIntent.



806
807
808
 
# File 'lib/stripe/resources/setup_intent.rb', line 806

def single_use_mandate
  @single_use_mandate
end

#status ⇒ Object (readonly)

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



808
809
810
 
# File 'lib/stripe/resources/setup_intent.rb', line 808

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



812
813
814
 
# File 'lib/stripe/resources/setup_intent.rb', line 812

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.



829
830
831
832
833
834
835
836
 
# File 'lib/stripe/resources/setup_intent.rb', line 829

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.



875
876
877
878
879
880
881
882
 
# File 'lib/stripe/resources/setup_intent.rb', line 875

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.



888
889
890
 
# File 'lib/stripe/resources/setup_intent.rb', line 888

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

.field_remappings ⇒ Object 



938
939
940
 
# File 'lib/stripe/resources/setup_intent.rb', line 938

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



927
928
929
930
931
932
933
934
935
936
 
# File 'lib/stripe/resources/setup_intent.rb', line 927

def self.inner_class_types
  @inner_class_types = {
    automatic_payment_methods: AutomaticPaymentMethods,
    last_setup_error: LastSetupError,
    managed_payments: ManagedPayments,
    next_action: NextAction,
    payment_method_configuration_details: PaymentMethodConfigurationDetails,
    payment_method_options: PaymentMethodOptions,
  }
end

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

Returns a list of SetupIntents.



893
894
895
 
# File 'lib/stripe/resources/setup_intent.rb', line 893

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.



898
899
900
901
902
903
904
905
 
# File 'lib/stripe/resources/setup_intent.rb', line 898

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.



918
919
920
921
922
923
924
925
 
# File 'lib/stripe/resources/setup_intent.rb', line 918

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.



817
818
819
820
821
822
823
824
 
# File 'lib/stripe/resources/setup_intent.rb', line 817

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.



852
853
854
855
856
857
858
859
 
# File 'lib/stripe/resources/setup_intent.rb', line 852

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.



908
909
910
911
912
913
914
915
 
# File 'lib/stripe/resources/setup_intent.rb', line 908

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