Class: Stripe::SetupAttempt

Inherits:
APIResource show all
Extended by:
APIOperations::List
Defined in:
lib/stripe/resources/setup_attempt.rb

Overview

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

Defined Under Namespace

Classes: PaymentMethodDetails, SetupError

Constant Summary collapse

OBJECT_NAME = 
"setup_attempt"

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

Methods included from APIOperations::List

list

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)

The value of [application](stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.



84
85
86
 
# File 'lib/stripe/resources/setup_attempt.rb', line 84

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.



88
89
90
 
# File 'lib/stripe/resources/setup_attempt.rb', line 88

def attach_to_self
  @attach_to_self
end

#created ⇒ Object (readonly)

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



90
91
92
 
# File 'lib/stripe/resources/setup_attempt.rb', line 90

def created
  @created
end

#customer ⇒ Object (readonly)

The value of [customer](stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.



92
93
94
 
# File 'lib/stripe/resources/setup_attempt.rb', line 92

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



96
97
98
 
# File 'lib/stripe/resources/setup_attempt.rb', line 96

def flow_directions
  @flow_directions
end

#id ⇒ Object (readonly)

Unique identifier for the object.



98
99
100
 
# File 'lib/stripe/resources/setup_attempt.rb', line 98

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



100
101
102
 
# File 'lib/stripe/resources/setup_attempt.rb', line 100

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



102
103
104
 
# File 'lib/stripe/resources/setup_attempt.rb', line 102

def object
  @object
end

#on_behalf_of ⇒ Object (readonly)

The value of [on_behalf_of](stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.



104
105
106
 
# File 'lib/stripe/resources/setup_attempt.rb', line 104

def on_behalf_of
  @on_behalf_of
end

#payment_method ⇒ Object (readonly)

ID of the payment method used with this SetupAttempt.



106
107
108
 
# File 'lib/stripe/resources/setup_attempt.rb', line 106

def payment_method
  @payment_method
end

#payment_method_details ⇒ Object (readonly)

Attribute for field payment_method_details



108
109
110
 
# File 'lib/stripe/resources/setup_attempt.rb', line 108

def payment_method_details
  @payment_method_details
end

#setup_error ⇒ Object (readonly)

The error encountered during this attempt to confirm the SetupIntent, if any.



110
111
112
 
# File 'lib/stripe/resources/setup_attempt.rb', line 110

def setup_error
  @setup_error
end

#setup_intent ⇒ Object (readonly)

ID of the SetupIntent that this attempt belongs to.



112
113
114
 
# File 'lib/stripe/resources/setup_attempt.rb', line 112

def setup_intent
  @setup_intent
end

#status ⇒ Object (readonly)

Status of this SetupAttempt, one of ‘requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.



114
115
116
 
# File 'lib/stripe/resources/setup_attempt.rb', line 114

def status
  @status
end

#usage ⇒ Object (readonly)

The value of [usage](stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of ‘off_session` or `on_session`.



116
117
118
 
# File 'lib/stripe/resources/setup_attempt.rb', line 116

def usage
  @usage
end

Class Method Details

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

Returns a list of SetupAttempts that associate with a provided SetupIntent.



119
120
121
 
# File 'lib/stripe/resources/setup_attempt.rb', line 119

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

.object_name ⇒ Object 



13
14
15
 
# File 'lib/stripe/resources/setup_attempt.rb', line 13

def self.object_name
  "setup_attempt"
end