Class: Stripe::Capability::Requirements

Inherits:
StripeObject show all
Defined in:
lib/stripe/resources/capability.rb

Defined Under Namespace

Classes: Alternative, Error

Constant Summary

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, 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

#alternatives ⇒ Object (readonly)

Fields that are due and can be satisfied by providing the corresponding alternative fields instead.



107
108
109
 
# File 'lib/stripe/resources/capability.rb', line 107

def alternatives
  @alternatives
end

#current_deadline ⇒ Object (readonly)

The date by which all required account information must be both submitted and verified. This includes fields listed in ‘currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.



109
110
111
 
# File 'lib/stripe/resources/capability.rb', line 109

def current_deadline
  @current_deadline
end

#currently_due ⇒ Object (readonly)

Fields that need to be collected to keep the capability enabled. If not collected by ‘current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.



111
112
113
 
# File 'lib/stripe/resources/capability.rb', line 111

def currently_due
  @currently_due
end

#disabled_reason ⇒ Object (readonly)

Description of why the capability is disabled. [Learn more about handling verification issues](stripe.com/docs/connect/handling-api-verification).



113
114
115
 
# File 'lib/stripe/resources/capability.rb', line 113

def disabled_reason
  @disabled_reason
end

#errors ⇒ Object (readonly)

Fields that are ‘currently_due` and need to be collected again because validation or verification failed.



115
116
117
 
# File 'lib/stripe/resources/capability.rb', line 115

def errors
  @errors
end

#eventually_due ⇒ Object (readonly)

Fields you must collect when all thresholds are reached. As they become required, they appear in ‘currently_due` as well, and `current_deadline` becomes set.



117
118
119
 
# File 'lib/stripe/resources/capability.rb', line 117

def eventually_due
  @eventually_due
end

#past_due ⇒ Object (readonly)

Fields that weren’t collected by ‘current_deadline`. These fields need to be collected to enable the capability on the account.



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

def past_due
  @past_due
end

#pending_verification ⇒ Object (readonly)

Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to ‘eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.



121
122
123
 
# File 'lib/stripe/resources/capability.rb', line 121

def pending_verification
  @pending_verification
end

Class Method Details

.field_remappings ⇒ Object 



127
128
129
 
# File 'lib/stripe/resources/capability.rb', line 127

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



123
124
125
 
# File 'lib/stripe/resources/capability.rb', line 123

def self.inner_class_types
  @inner_class_types = { alternatives: Alternative, errors: Error }
end