1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._account import Account
from stripe._expandable_field import ExpandableField
from stripe._stripe_object import StripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import sanitize_id
from typing import ClassVar, List, Optional
from typing_extensions import Literal
class Capability(UpdateableAPIResource["Capability"]):
"""
This is an object representing a capability for a Stripe account.
Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
"""
OBJECT_NAME: ClassVar[Literal["capability"]] = "capability"
class FutureRequirements(StripeObject):
class Alternative(StripeObject):
alternative_fields_due: List[str]
"""
Fields that can be provided to satisfy all fields in `original_fields_due`.
"""
original_fields_due: List[str]
"""
Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
"""
class Error(StripeObject):
code: Literal[
"information_missing",
"invalid_address_city_state_postal_code",
"invalid_address_highway_contract_box",
"invalid_address_private_mailbox",
"invalid_business_profile_name",
"invalid_business_profile_name_denylisted",
"invalid_company_name_denylisted",
"invalid_dob_age_over_maximum",
"invalid_dob_age_under_18",
"invalid_dob_age_under_minimum",
"invalid_product_description_length",
"invalid_product_description_url_match",
"invalid_representative_country",
"invalid_signator",
"invalid_statement_descriptor_business_mismatch",
"invalid_statement_descriptor_denylisted",
"invalid_statement_descriptor_length",
"invalid_statement_descriptor_prefix_denylisted",
"invalid_statement_descriptor_prefix_mismatch",
"invalid_street_address",
"invalid_tax_id",
"invalid_tax_id_format",
"invalid_tos_acceptance",
"invalid_url_denylisted",
"invalid_url_format",
"invalid_url_length",
"invalid_url_web_presence_detected",
"invalid_url_website_business_information_mismatch",
"invalid_url_website_empty",
"invalid_url_website_inaccessible",
"invalid_url_website_inaccessible_geoblocked",
"invalid_url_website_inaccessible_password_protected",
"invalid_url_website_incomplete",
"invalid_url_website_incomplete_cancellation_policy",
"invalid_url_website_incomplete_customer_service_details",
"invalid_url_website_incomplete_legal_restrictions",
"invalid_url_website_incomplete_refund_policy",
"invalid_url_website_incomplete_return_policy",
"invalid_url_website_incomplete_terms_and_conditions",
"invalid_url_website_incomplete_under_construction",
"invalid_url_website_other",
"invalid_value_other",
"verification_directors_mismatch",
"verification_document_address_mismatch",
"verification_document_address_missing",
"verification_document_corrupt",
"verification_document_country_not_supported",
"verification_document_directors_mismatch",
"verification_document_dob_mismatch",
"verification_document_duplicate_type",
"verification_document_expired",
"verification_document_failed_copy",
"verification_document_failed_greyscale",
"verification_document_failed_other",
"verification_document_failed_test_mode",
"verification_document_fraudulent",
"verification_document_id_number_mismatch",
"verification_document_id_number_missing",
"verification_document_incomplete",
"verification_document_invalid",
"verification_document_issue_or_expiry_date_missing",
"verification_document_manipulated",
"verification_document_missing_back",
"verification_document_missing_front",
"verification_document_name_mismatch",
"verification_document_name_missing",
"verification_document_nationality_mismatch",
"verification_document_not_readable",
"verification_document_not_signed",
"verification_document_not_uploaded",
"verification_document_photo_mismatch",
"verification_document_too_large",
"verification_document_type_not_supported",
"verification_extraneous_directors",
"verification_failed_address_match",
"verification_failed_authorizer_authority",
"verification_failed_business_iec_number",
"verification_failed_document_match",
"verification_failed_id_number_match",
"verification_failed_keyed_identity",
"verification_failed_keyed_match",
"verification_failed_name_match",
"verification_failed_other",
"verification_failed_representative_authority",
"verification_failed_residential_address",
"verification_failed_tax_id_match",
"verification_failed_tax_id_not_issued",
"verification_missing_directors",
"verification_missing_executives",
"verification_missing_owners",
"verification_rejected_ownership_exemption_reason",
"verification_requires_additional_memorandum_of_associations",
"verification_requires_additional_proof_of_registration",
"verification_supportability",
]
"""
The code for the type of error.
"""
reason: str
"""
An informative message that indicates the error type and provides additional details about the error.
"""
requirement: str
"""
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
"""
alternatives: Optional[List[Alternative]]
"""
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
"""
current_deadline: Optional[int]
"""
Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
"""
currently_due: List[str]
"""
Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
"""
disabled_reason: Optional[
Literal[
"other",
"paused.inactivity",
"pending.onboarding",
"pending.review",
"platform_disabled",
"platform_paused",
"rejected.inactivity",
"rejected.other",
"rejected.unsupported_business",
"requirements.fields_needed",
]
]
"""
This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
"""
errors: List[Error]
"""
Fields that are `currently_due` and need to be collected again because validation or verification failed.
"""
eventually_due: List[str]
"""
Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
"""
past_due: List[str]
"""
Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
"""
pending_verification: List[str]
"""
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` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
"""
_inner_class_types = {"alternatives": Alternative, "errors": Error}
class Requirements(StripeObject):
class Alternative(StripeObject):
alternative_fields_due: List[str]
"""
Fields that can be provided to satisfy all fields in `original_fields_due`.
"""
original_fields_due: List[str]
"""
Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
"""
class Error(StripeObject):
code: Literal[
"information_missing",
"invalid_address_city_state_postal_code",
"invalid_address_highway_contract_box",
"invalid_address_private_mailbox",
"invalid_business_profile_name",
"invalid_business_profile_name_denylisted",
"invalid_company_name_denylisted",
"invalid_dob_age_over_maximum",
"invalid_dob_age_under_18",
"invalid_dob_age_under_minimum",
"invalid_product_description_length",
"invalid_product_description_url_match",
"invalid_representative_country",
"invalid_signator",
"invalid_statement_descriptor_business_mismatch",
"invalid_statement_descriptor_denylisted",
"invalid_statement_descriptor_length",
"invalid_statement_descriptor_prefix_denylisted",
"invalid_statement_descriptor_prefix_mismatch",
"invalid_street_address",
"invalid_tax_id",
"invalid_tax_id_format",
"invalid_tos_acceptance",
"invalid_url_denylisted",
"invalid_url_format",
"invalid_url_length",
"invalid_url_web_presence_detected",
"invalid_url_website_business_information_mismatch",
"invalid_url_website_empty",
"invalid_url_website_inaccessible",
"invalid_url_website_inaccessible_geoblocked",
"invalid_url_website_inaccessible_password_protected",
"invalid_url_website_incomplete",
"invalid_url_website_incomplete_cancellation_policy",
"invalid_url_website_incomplete_customer_service_details",
"invalid_url_website_incomplete_legal_restrictions",
"invalid_url_website_incomplete_refund_policy",
"invalid_url_website_incomplete_return_policy",
"invalid_url_website_incomplete_terms_and_conditions",
"invalid_url_website_incomplete_under_construction",
"invalid_url_website_other",
"invalid_value_other",
"verification_directors_mismatch",
"verification_document_address_mismatch",
"verification_document_address_missing",
"verification_document_corrupt",
"verification_document_country_not_supported",
"verification_document_directors_mismatch",
"verification_document_dob_mismatch",
"verification_document_duplicate_type",
"verification_document_expired",
"verification_document_failed_copy",
"verification_document_failed_greyscale",
"verification_document_failed_other",
"verification_document_failed_test_mode",
"verification_document_fraudulent",
"verification_document_id_number_mismatch",
"verification_document_id_number_missing",
"verification_document_incomplete",
"verification_document_invalid",
"verification_document_issue_or_expiry_date_missing",
"verification_document_manipulated",
"verification_document_missing_back",
"verification_document_missing_front",
"verification_document_name_mismatch",
"verification_document_name_missing",
"verification_document_nationality_mismatch",
"verification_document_not_readable",
"verification_document_not_signed",
"verification_document_not_uploaded",
"verification_document_photo_mismatch",
"verification_document_too_large",
"verification_document_type_not_supported",
"verification_extraneous_directors",
"verification_failed_address_match",
"verification_failed_authorizer_authority",
"verification_failed_business_iec_number",
"verification_failed_document_match",
"verification_failed_id_number_match",
"verification_failed_keyed_identity",
"verification_failed_keyed_match",
"verification_failed_name_match",
"verification_failed_other",
"verification_failed_representative_authority",
"verification_failed_residential_address",
"verification_failed_tax_id_match",
"verification_failed_tax_id_not_issued",
"verification_missing_directors",
"verification_missing_executives",
"verification_missing_owners",
"verification_rejected_ownership_exemption_reason",
"verification_requires_additional_memorandum_of_associations",
"verification_requires_additional_proof_of_registration",
"verification_supportability",
]
"""
The code for the type of error.
"""
reason: str
"""
An informative message that indicates the error type and provides additional details about the error.
"""
requirement: str
"""
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
"""
alternatives: Optional[List[Alternative]]
"""
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
"""
current_deadline: Optional[int]
"""
Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.
"""
currently_due: List[str]
"""
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.
"""
disabled_reason: Optional[
Literal[
"other",
"paused.inactivity",
"pending.onboarding",
"pending.review",
"platform_disabled",
"platform_paused",
"rejected.inactivity",
"rejected.other",
"rejected.unsupported_business",
"requirements.fields_needed",
]
]
"""
Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
"""
errors: List[Error]
"""
Fields that are `currently_due` and need to be collected again because validation or verification failed.
"""
eventually_due: List[str]
"""
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.
"""
past_due: List[str]
"""
Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
"""
pending_verification: List[str]
"""
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.
"""
_inner_class_types = {"alternatives": Alternative, "errors": Error}
account: ExpandableField["Account"]
"""
The account for which the capability enables functionality.
"""
future_requirements: Optional[FutureRequirements]
id: str
"""
The identifier for the capability.
"""
object: Literal["capability"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
requested: bool
"""
Whether the capability has been requested.
"""
requested_at: Optional[int]
"""
Time at which the capability was requested. Measured in seconds since the Unix epoch.
"""
requirements: Optional[Requirements]
status: Literal["active", "disabled", "inactive", "pending", "unrequested"]
"""
The status of the capability.
"""
def instance_url(self):
token = self.id
account = self.account
base = Account.class_url()
if isinstance(account, Account):
account = account.id
acct_extn = sanitize_id(account)
extn = sanitize_id(token)
return "%s/%s/capabilities/%s" % (base, acct_extn, extn)
@classmethod
def modify(cls, sid, **params):
raise NotImplementedError(
"Can't update a capability without an account ID. Update a capability using "
"account.modify_capability('acct_123', 'acap_123', params)"
)
@classmethod
def retrieve(cls, id, **params):
raise NotImplementedError(
"Can't retrieve a capability without an account ID. Retrieve a capability using "
"account.retrieve_capability('acct_123', 'acap_123')"
)
_inner_class_types = {
"future_requirements": FutureRequirements,
"requirements": Requirements,
}
|
