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 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._account_session import AccountSession
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from typing import List, cast
from typing_extensions import NotRequired, TypedDict
class AccountSessionService(StripeService):
class CreateParams(TypedDict):
account: str
"""
The identifier of the account to create an Account Session for.
"""
components: "AccountSessionService.CreateParamsComponents"
"""
Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class CreateParamsComponents(TypedDict):
account_management: NotRequired[
"AccountSessionService.CreateParamsComponentsAccountManagement"
]
"""
Configuration for the account management embedded component.
"""
account_onboarding: NotRequired[
"AccountSessionService.CreateParamsComponentsAccountOnboarding"
]
"""
Configuration for the account onboarding embedded component.
"""
balances: NotRequired[
"AccountSessionService.CreateParamsComponentsBalances"
]
"""
Configuration for the balances embedded component.
"""
documents: NotRequired[
"AccountSessionService.CreateParamsComponentsDocuments"
]
"""
Configuration for the documents embedded component.
"""
financial_account: NotRequired[
"AccountSessionService.CreateParamsComponentsFinancialAccount"
]
"""
Configuration for the financial account embedded component.
"""
financial_account_transactions: NotRequired[
"AccountSessionService.CreateParamsComponentsFinancialAccountTransactions"
]
"""
Configuration for the financial account transactions embedded component.
"""
issuing_card: NotRequired[
"AccountSessionService.CreateParamsComponentsIssuingCard"
]
"""
Configuration for the issuing card embedded component.
"""
issuing_cards_list: NotRequired[
"AccountSessionService.CreateParamsComponentsIssuingCardsList"
]
"""
Configuration for the issuing cards list embedded component.
"""
notification_banner: NotRequired[
"AccountSessionService.CreateParamsComponentsNotificationBanner"
]
"""
Configuration for the notification banner embedded component.
"""
payment_details: NotRequired[
"AccountSessionService.CreateParamsComponentsPaymentDetails"
]
"""
Configuration for the payment details embedded component.
"""
payments: NotRequired[
"AccountSessionService.CreateParamsComponentsPayments"
]
"""
Configuration for the payments embedded component.
"""
payouts: NotRequired[
"AccountSessionService.CreateParamsComponentsPayouts"
]
"""
Configuration for the payouts embedded component.
"""
payouts_list: NotRequired[
"AccountSessionService.CreateParamsComponentsPayoutsList"
]
"""
Configuration for the payouts list embedded component.
"""
tax_registrations: NotRequired[
"AccountSessionService.CreateParamsComponentsTaxRegistrations"
]
"""
Configuration for the tax registrations embedded component.
"""
tax_settings: NotRequired[
"AccountSessionService.CreateParamsComponentsTaxSettings"
]
"""
Configuration for the tax settings embedded component.
"""
class CreateParamsComponentsAccountManagement(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsAccountManagementFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsAccountManagementFeatures(TypedDict):
disable_stripe_user_authentication: NotRequired[bool]
"""
Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
"""
external_account_collection: NotRequired[bool]
"""
Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.
"""
class CreateParamsComponentsAccountOnboarding(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsAccountOnboardingFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsAccountOnboardingFeatures(TypedDict):
disable_stripe_user_authentication: NotRequired[bool]
"""
Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
"""
external_account_collection: NotRequired[bool]
"""
Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.
"""
class CreateParamsComponentsBalances(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsBalancesFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsBalancesFeatures(TypedDict):
disable_stripe_user_authentication: NotRequired[bool]
"""
Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
"""
edit_payout_schedule: NotRequired[bool]
"""
Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
"""
external_account_collection: NotRequired[bool]
"""
Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.
"""
instant_payouts: NotRequired[bool]
"""
Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
"""
standard_payouts: NotRequired[bool]
"""
Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
"""
class CreateParamsComponentsDocuments(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsDocumentsFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsDocumentsFeatures(TypedDict):
pass
class CreateParamsComponentsFinancialAccount(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsFinancialAccountFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsFinancialAccountFeatures(TypedDict):
disable_stripe_user_authentication: NotRequired[bool]
"""
Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
"""
external_account_collection: NotRequired[bool]
"""
Whether to allow external accounts to be linked for money transfer.
"""
send_money: NotRequired[bool]
"""
Whether to allow sending money.
"""
transfer_balance: NotRequired[bool]
"""
Whether to allow transferring balance.
"""
class CreateParamsComponentsFinancialAccountTransactions(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsFinancialAccountTransactionsFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsFinancialAccountTransactionsFeatures(
TypedDict
):
card_spend_dispute_management: NotRequired[bool]
"""
Whether to allow card spend dispute management features.
"""
class CreateParamsComponentsIssuingCard(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsIssuingCardFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsIssuingCardFeatures(TypedDict):
card_management: NotRequired[bool]
"""
Whether to allow card management features.
"""
card_spend_dispute_management: NotRequired[bool]
"""
Whether to allow card spend dispute management features.
"""
cardholder_management: NotRequired[bool]
"""
Whether to allow cardholder management features.
"""
spend_control_management: NotRequired[bool]
"""
Whether to allow spend control management features.
"""
class CreateParamsComponentsIssuingCardsList(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsIssuingCardsListFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsIssuingCardsListFeatures(TypedDict):
card_management: NotRequired[bool]
"""
Whether to allow card management features.
"""
card_spend_dispute_management: NotRequired[bool]
"""
Whether to allow card spend dispute management features.
"""
cardholder_management: NotRequired[bool]
"""
Whether to allow cardholder management features.
"""
disable_stripe_user_authentication: NotRequired[bool]
"""
Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts.
"""
spend_control_management: NotRequired[bool]
"""
Whether to allow spend control management features.
"""
class CreateParamsComponentsNotificationBanner(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsNotificationBannerFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsNotificationBannerFeatures(TypedDict):
disable_stripe_user_authentication: NotRequired[bool]
"""
Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
"""
external_account_collection: NotRequired[bool]
"""
Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.
"""
class CreateParamsComponentsPaymentDetails(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsPaymentDetailsFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsPaymentDetailsFeatures(TypedDict):
capture_payments: NotRequired[bool]
"""
Whether to allow capturing and cancelling payment intents. This is `true` by default.
"""
destination_on_behalf_of_charge_management: NotRequired[bool]
"""
Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.
"""
dispute_management: NotRequired[bool]
"""
Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
"""
refund_management: NotRequired[bool]
"""
Whether to allow sending refunds. This is `true` by default.
"""
class CreateParamsComponentsPayments(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsPaymentsFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsPaymentsFeatures(TypedDict):
capture_payments: NotRequired[bool]
"""
Whether to allow capturing and cancelling payment intents. This is `true` by default.
"""
destination_on_behalf_of_charge_management: NotRequired[bool]
"""
Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.
"""
dispute_management: NotRequired[bool]
"""
Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
"""
refund_management: NotRequired[bool]
"""
Whether to allow sending refunds. This is `true` by default.
"""
class CreateParamsComponentsPayouts(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsPayoutsFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsPayoutsFeatures(TypedDict):
disable_stripe_user_authentication: NotRequired[bool]
"""
Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
"""
edit_payout_schedule: NotRequired[bool]
"""
Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
"""
external_account_collection: NotRequired[bool]
"""
Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.
"""
instant_payouts: NotRequired[bool]
"""
Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
"""
standard_payouts: NotRequired[bool]
"""
Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
"""
class CreateParamsComponentsPayoutsList(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsPayoutsListFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsPayoutsListFeatures(TypedDict):
pass
class CreateParamsComponentsTaxRegistrations(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsTaxRegistrationsFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsTaxRegistrationsFeatures(TypedDict):
pass
class CreateParamsComponentsTaxSettings(TypedDict):
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: NotRequired[
"AccountSessionService.CreateParamsComponentsTaxSettingsFeatures"
]
"""
The list of features enabled in the embedded component.
"""
class CreateParamsComponentsTaxSettingsFeatures(TypedDict):
pass
def create(
self,
params: "AccountSessionService.CreateParams",
options: RequestOptions = {},
) -> AccountSession:
"""
Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
"""
return cast(
AccountSession,
self._request(
"post",
"/v1/account_sessions",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "AccountSessionService.CreateParams",
options: RequestOptions = {},
) -> AccountSession:
"""
Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
"""
return cast(
AccountSession,
await self._request_async(
"post",
"/v1/account_sessions",
base_address="api",
params=params,
options=options,
),
)
|