# -*- coding: utf-8 -*- # File generated from our OpenAPI spec from stripe import util from stripe.api_resources.abstract import ( CreateableAPIResource, ListableAPIResource, UpdateableAPIResource, ) from stripe.api_resources.expandable_field import ExpandableField from stripe.api_resources.list_object import ListObject from stripe.request_options import RequestOptions from stripe.stripe_object import StripeObject from stripe.util import class_method_variant from typing import Any, ClassVar, Dict, List, Optional, Union, cast, overload from typing_extensions import ( Literal, NotRequired, TypedDict, Unpack, TYPE_CHECKING, ) from urllib.parse import quote_plus if TYPE_CHECKING: from stripe.api_resources.account import Account from stripe.api_resources.application import Application from stripe.api_resources.bank_account import BankAccount from stripe.api_resources.card import Card as CardResource from stripe.api_resources.customer import Customer from stripe.api_resources.mandate import Mandate from stripe.api_resources.payment_intent import PaymentIntent from stripe.api_resources.payment_method import PaymentMethod from stripe.api_resources.setup_attempt import SetupAttempt from stripe.api_resources.source import Source class SetupIntent( CreateableAPIResource["SetupIntent"], ListableAPIResource["SetupIntent"], UpdateableAPIResource["SetupIntent"], ): """ 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](https://stripe.com/docs/api#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](https://stripe.com/docs/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](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents). If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#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](https://stripe.com/docs/api#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](https://stripe.com/docs/payments/setup-intents) """ OBJECT_NAME: ClassVar[Literal["setup_intent"]] = "setup_intent" class AutomaticPaymentMethods(StripeObject): allow_redirects: Optional[Literal["always", "never"]] """ Controls whether this SetupIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. """ enabled: Optional[bool] """ Automatically calculates compatible payment methods """ class LastSetupError(StripeObject): charge: Optional[str] """ For card errors, the ID of the failed charge. """ code: Optional[ Literal[ "account_closed", "account_country_invalid_address", "account_error_country_change_requires_additional_steps", "account_information_mismatch", "account_invalid", "account_number_invalid", "acss_debit_session_incomplete", "alipay_upgrade_required", "amount_too_large", "amount_too_small", "api_key_expired", "application_fees_not_allowed", "authentication_required", "balance_insufficient", "balance_invalid_parameter", "bank_account_bad_routing_numbers", "bank_account_declined", "bank_account_exists", "bank_account_restricted", "bank_account_unusable", "bank_account_unverified", "bank_account_verification_failed", "billing_invalid_mandate", "bitcoin_upgrade_required", "capture_charge_authorization_expired", "capture_unauthorized_payment", "card_decline_rate_limit_exceeded", "card_declined", "cardholder_phone_number_required", "charge_already_captured", "charge_already_refunded", "charge_disputed", "charge_exceeds_source_limit", "charge_expired_for_capture", "charge_invalid_parameter", "charge_not_refundable", "clearing_code_unsupported", "country_code_invalid", "country_unsupported", "coupon_expired", "customer_max_payment_methods", "customer_max_subscriptions", "debit_not_authorized", "email_invalid", "expired_card", "idempotency_key_in_use", "incorrect_address", "incorrect_cvc", "incorrect_number", "incorrect_zip", "instant_payouts_config_disabled", "instant_payouts_currency_disabled", "instant_payouts_limit_exceeded", "instant_payouts_unsupported", "insufficient_funds", "intent_invalid_state", "intent_verification_method_missing", "invalid_card_type", "invalid_characters", "invalid_charge_amount", "invalid_cvc", "invalid_expiry_month", "invalid_expiry_year", "invalid_number", "invalid_source_usage", "invalid_tax_location", "invoice_no_customer_line_items", "invoice_no_payment_method_types", "invoice_no_subscription_line_items", "invoice_not_editable", "invoice_on_behalf_of_not_editable", "invoice_payment_intent_requires_action", "invoice_upcoming_none", "livemode_mismatch", "lock_timeout", "missing", "no_account", "not_allowed_on_standard_account", "out_of_inventory", "ownership_declaration_not_allowed", "parameter_invalid_empty", "parameter_invalid_integer", "parameter_invalid_string_blank", "parameter_invalid_string_empty", "parameter_missing", "parameter_unknown", "parameters_exclusive", "payment_intent_action_required", "payment_intent_authentication_failure", "payment_intent_incompatible_payment_method", "payment_intent_invalid_parameter", "payment_intent_konbini_rejected_confirmation_number", "payment_intent_mandate_invalid", "payment_intent_payment_attempt_expired", "payment_intent_payment_attempt_failed", "payment_intent_unexpected_state", "payment_method_bank_account_already_verified", "payment_method_bank_account_blocked", "payment_method_billing_details_address_missing", "payment_method_configuration_failures", "payment_method_currency_mismatch", "payment_method_customer_decline", "payment_method_invalid_parameter", "payment_method_invalid_parameter_testmode", "payment_method_microdeposit_failed", "payment_method_microdeposit_verification_amounts_invalid", "payment_method_microdeposit_verification_amounts_mismatch", "payment_method_microdeposit_verification_attempts_exceeded", "payment_method_microdeposit_verification_descriptor_code_mismatch", "payment_method_microdeposit_verification_timeout", "payment_method_not_available", "payment_method_provider_decline", "payment_method_provider_timeout", "payment_method_unactivated", "payment_method_unexpected_state", "payment_method_unsupported_type", "payout_reconciliation_not_ready", "payouts_limit_exceeded", "payouts_not_allowed", "platform_account_required", "platform_api_key_expired", "postal_code_invalid", "processing_error", "product_inactive", "progressive_onboarding_limit_exceeded", "rate_limit", "refer_to_customer", "refund_disputed_payment", "resource_already_exists", "resource_missing", "return_intent_already_processed", "routing_number_invalid", "secret_key_required", "sepa_unsupported_account", "setup_attempt_failed", "setup_intent_authentication_failure", "setup_intent_invalid_parameter", "setup_intent_mandate_invalid", "setup_intent_setup_attempt_expired", "setup_intent_unexpected_state", "shipping_calculation_failed", "sku_inactive", "state_unsupported", "status_transition_invalid", "stripe_tax_inactive", "tax_id_invalid", "taxes_calculation_failed", "terminal_location_country_unsupported", "terminal_reader_busy", "terminal_reader_hardware_fault", "terminal_reader_offline", "terminal_reader_timeout", "testmode_charges_only", "tls_version_unsupported", "token_already_used", "token_card_network_invalid", "token_in_use", "transfer_source_balance_parameters_mismatch", "transfers_not_allowed", "url_invalid", ] ] """ For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. """ decline_code: Optional[str] """ For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. """ doc_url: Optional[str] """ A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. """ message: Optional[str] """ A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. """ param: Optional[str] """ If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. """ payment_intent: Optional["PaymentIntent"] """ A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents) """ payment_method: Optional["PaymentMethod"] """ PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). """ payment_method_type: Optional[str] """ If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. """ request_log_url: Optional[str] """ A URL to the request log entry in your dashboard. """ setup_intent: Optional["SetupIntent"] """ 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](https://stripe.com/docs/api#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](https://stripe.com/docs/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](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents). If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#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](https://stripe.com/docs/api#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](https://stripe.com/docs/payments/setup-intents) """ source: Optional[ Union["Account", "BankAccount", "CardResource", "Source"] ] type: Literal[ "api_error", "card_error", "idempotency_error", "invalid_request_error", ] """ The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` """ class NextAction(StripeObject): class CashappHandleRedirectOrDisplayQrCode(StripeObject): class QrCode(StripeObject): expires_at: int """ The date (unix timestamp) when the QR code expires. """ image_url_png: str """ The image_url_png string used to render QR code """ image_url_svg: str """ The image_url_svg string used to render QR code """ hosted_instructions_url: str """ The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration. """ mobile_auth_url: str """ The url for mobile redirect based auth """ qr_code: QrCode _inner_class_types = {"qr_code": QrCode} class RedirectToUrl(StripeObject): return_url: Optional[str] """ If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. """ url: Optional[str] """ The URL you must redirect your customer to in order to authenticate. """ class VerifyWithMicrodeposits(StripeObject): arrival_date: int """ The timestamp when the microdeposits are expected to land. """ hosted_verification_url: str """ The URL for the hosted verification page, which allows customers to verify their bank account. """ microdeposit_type: Optional[Literal["amounts", "descriptor_code"]] """ The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. """ cashapp_handle_redirect_or_display_qr_code: Optional[ CashappHandleRedirectOrDisplayQrCode ] redirect_to_url: Optional[RedirectToUrl] type: str """ Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. """ use_stripe_sdk: Optional[Dict[str, Any]] """ When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. """ verify_with_microdeposits: Optional[VerifyWithMicrodeposits] _inner_class_types = { "cashapp_handle_redirect_or_display_qr_code": CashappHandleRedirectOrDisplayQrCode, "redirect_to_url": RedirectToUrl, "verify_with_microdeposits": VerifyWithMicrodeposits, } class PaymentMethodConfigurationDetails(StripeObject): id: str """ ID of the payment method configuration used. """ parent: Optional[str] """ ID of the parent payment method configuration used. """ class PaymentMethodOptions(StripeObject): class AcssDebit(StripeObject): class MandateOptions(StripeObject): custom_mandate_url: Optional[str] """ A URL for custom mandate text """ default_for: Optional[List[Literal["invoice", "subscription"]]] """ List of Stripe products where this mandate can be selected automatically. """ interval_description: Optional[str] """ Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: Optional[ Literal["combined", "interval", "sporadic"] ] """ Payment schedule for the mandate. """ transaction_type: Optional[Literal["business", "personal"]] """ Transaction type of the mandate. """ currency: Optional[Literal["cad", "usd"]] """ Currency supported by the bank account """ mandate_options: Optional[MandateOptions] verification_method: Optional[ Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. """ _inner_class_types = {"mandate_options": MandateOptions} class Card(StripeObject): class MandateOptions(StripeObject): amount: int """ Amount to be charged for future payments. """ amount_type: Literal["fixed", "maximum"] """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ currency: str """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ description: Optional[str] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ end_date: Optional[int] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ interval: Literal["day", "month", "sporadic", "week", "year"] """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ interval_count: Optional[int] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ reference: str """ Unique identifier for the mandate or subscription. """ start_date: int """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ supported_types: Optional[List[Literal["india"]]] """ Specifies the type of mandates supported. Possible values are `india`. """ mandate_options: Optional[MandateOptions] """ Configuration options for setting up an eMandate for cards issued in India. """ network: Optional[ Literal[ "amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "interac", "jcb", "mastercard", "unionpay", "unknown", "visa", ] ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. """ request_three_d_secure: Optional[ Literal["any", "automatic", "challenge_only"] ] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ _inner_class_types = {"mandate_options": MandateOptions} class Link(StripeObject): persistent_token: Optional[str] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class Paypal(StripeObject): billing_agreement_id: Optional[str] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ class SepaDebit(StripeObject): class MandateOptions(StripeObject): pass mandate_options: Optional[MandateOptions] _inner_class_types = {"mandate_options": MandateOptions} class UsBankAccount(StripeObject): class FinancialConnections(StripeObject): permissions: Optional[ List[ Literal[ "balances", "ownership", "payment_method", "transactions", ] ] ] """ The list of permissions to request. The `payment_method` permission must be included. """ prefetch: Optional[List[Literal["balances"]]] """ Data features requested to be retrieved upon account creation. """ return_url: Optional[str] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ financial_connections: Optional[FinancialConnections] verification_method: Optional[ Literal["automatic", "instant", "microdeposits"] ] """ Bank account verification method. """ _inner_class_types = { "financial_connections": FinancialConnections } acss_debit: Optional[AcssDebit] card: Optional[Card] link: Optional[Link] paypal: Optional[Paypal] sepa_debit: Optional[SepaDebit] us_bank_account: Optional[UsBankAccount] _inner_class_types = { "acss_debit": AcssDebit, "card": Card, "link": Link, "paypal": Paypal, "sepa_debit": SepaDebit, "us_bank_account": UsBankAccount, } if TYPE_CHECKING: class CancelParams(RequestOptions): cancellation_reason: NotRequired[ "Literal['abandoned', 'duplicate', 'requested_by_customer']" ] """ Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate` """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ class ConfirmParams(RequestOptions): expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ mandate_data: NotRequired[ "Literal['']|SetupIntent.ConfirmParamsMandateData|SetupIntent.ConfirmParamsMandateData2" ] payment_method: NotRequired["str"] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ payment_method_data: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodData" ] """ When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. """ payment_method_options: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptions" ] """ Payment method-specific configuration for this SetupIntent. """ return_url: NotRequired["str"] """ The URL to redirect your customer back to after they authenticate on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. """ use_stripe_sdk: NotRequired["bool"] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ class ConfirmParamsPaymentMethodOptions(TypedDict): acss_debit: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsAcssDebit" ] """ If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options. """ card: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsCard" ] """ Configuration for any card setup attempted on this SetupIntent. """ link: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsLink" ] """ If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options. """ paypal: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsPaypal" ] """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ sepa_debit: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsSepaDebit" ] """ If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options. """ us_bank_account: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsUsBankAccount" ] """ If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options. """ class ConfirmParamsPaymentMethodOptionsUsBankAccount(TypedDict): financial_connections: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsUsBankAccountFinancialConnections" ] """ Additional fields for Financial Connections Session creation """ networks: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsUsBankAccountNetworks" ] """ Additional fields for network related functions """ verification_method: NotRequired[ "Literal['automatic', 'instant', 'microdeposits']" ] """ Verification method for the intent """ class ConfirmParamsPaymentMethodOptionsUsBankAccountNetworks( TypedDict ): requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] """ Triggers validations to run across the selected networks """ class ConfirmParamsPaymentMethodOptionsUsBankAccountFinancialConnections( TypedDict, ): permissions: NotRequired[ "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired["List[Literal['balances']]"] """ List of data features that you would like to retrieve upon account creation. """ return_url: NotRequired["str"] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ class ConfirmParamsPaymentMethodOptionsSepaDebit(TypedDict): mandate_options: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsSepaDebitMandateOptions" ] """ Additional fields for Mandate creation """ class ConfirmParamsPaymentMethodOptionsSepaDebitMandateOptions( TypedDict, ): pass class ConfirmParamsPaymentMethodOptionsPaypal(TypedDict): billing_agreement_id: NotRequired["str"] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ class ConfirmParamsPaymentMethodOptionsLink(TypedDict): persistent_token: NotRequired["str"] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class ConfirmParamsPaymentMethodOptionsCard(TypedDict): mandate_options: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsCardMandateOptions" ] """ Configuration options for setting up an eMandate for cards issued in India. """ moto: NotRequired["bool"] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired["Literal['any', 'automatic']"] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ class ConfirmParamsPaymentMethodOptionsCardMandateOptions(TypedDict): amount: int """ Amount to be charged for future payments. """ amount_type: Literal["fixed", "maximum"] """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ currency: str """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ description: NotRequired["str"] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ end_date: NotRequired["int"] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ interval: Literal["day", "month", "sporadic", "week", "year"] """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ interval_count: NotRequired["int"] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ reference: str """ Unique identifier for the mandate or subscription. """ start_date: int """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ supported_types: NotRequired["List[Literal['india']]"] """ Specifies the type of mandates supported. Possible values are `india`. """ class ConfirmParamsPaymentMethodOptionsAcssDebit(TypedDict): currency: NotRequired["Literal['cad', 'usd']"] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ mandate_options: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodOptionsAcssDebitMandateOptions" ] """ Additional fields for Mandate creation """ verification_method: NotRequired[ "Literal['automatic', 'instant', 'microdeposits']" ] """ Verification method for the intent """ class ConfirmParamsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): custom_mandate_url: NotRequired["Literal['']|str"] """ A URL for custom mandate text to render during confirmation step. The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ default_for: NotRequired[ "List[Literal['invoice', 'subscription']]" ] """ List of Stripe products where this mandate can be selected automatically. """ interval_description: NotRequired["str"] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ "Literal['combined', 'interval', 'sporadic']" ] """ Payment schedule for the mandate. """ transaction_type: NotRequired["Literal['business', 'personal']"] """ Transaction type of the mandate. """ class ConfirmParamsPaymentMethodData(TypedDict): acss_debit: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataAcssDebit" ] """ If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. """ affirm: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataAffirm" ] """ If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. """ afterpay_clearpay: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataAfterpayClearpay" ] """ If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. """ alipay: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataAlipay" ] """ If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. """ au_becs_debit: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataAuBecsDebit" ] """ If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. """ bacs_debit: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataBacsDebit" ] """ If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. """ bancontact: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataBancontact" ] """ If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. """ billing_details: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataBillingDetails" ] """ Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. """ blik: NotRequired["SetupIntent.ConfirmParamsPaymentMethodDataBlik"] """ If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method. """ boleto: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataBoleto" ] """ If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. """ cashapp: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataCashapp" ] """ If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. """ customer_balance: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataCustomerBalance" ] """ If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method. """ eps: NotRequired["SetupIntent.ConfirmParamsPaymentMethodDataEps"] """ If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. """ fpx: NotRequired["SetupIntent.ConfirmParamsPaymentMethodDataFpx"] """ If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. """ giropay: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataGiropay" ] """ If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. """ grabpay: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataGrabpay" ] """ If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. """ ideal: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataIdeal" ] """ If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. """ interac_present: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataInteracPresent" ] """ If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. """ klarna: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataKlarna" ] """ If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. """ konbini: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataKonbini" ] """ If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method. """ link: NotRequired["SetupIntent.ConfirmParamsPaymentMethodDataLink"] """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ metadata: NotRequired["Dict[str, str]"] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ oxxo: NotRequired["SetupIntent.ConfirmParamsPaymentMethodDataOxxo"] """ If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. """ p24: NotRequired["SetupIntent.ConfirmParamsPaymentMethodDataP24"] """ If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. """ paynow: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataPaynow" ] """ If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method. """ paypal: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataPaypal" ] """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ pix: NotRequired["SetupIntent.ConfirmParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. """ promptpay: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataPromptpay" ] """ If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method. """ radar_options: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataRadarOptions" ] """ Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataRevolutPay" ] """ If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. """ sepa_debit: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataSepaDebit" ] """ If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. """ sofort: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataSofort" ] """ If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. """ type: Literal[ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "us_bank_account", "wechat_pay", "zip", ] """ The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. """ us_bank_account: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataUsBankAccount" ] """ If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. """ wechat_pay: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataWechatPay" ] """ If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. """ zip: NotRequired["SetupIntent.ConfirmParamsPaymentMethodDataZip"] """ If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method. """ class ConfirmParamsPaymentMethodDataZip(TypedDict): pass class ConfirmParamsPaymentMethodDataWechatPay(TypedDict): pass class ConfirmParamsPaymentMethodDataUsBankAccount(TypedDict): account_holder_type: NotRequired[ "Literal['company', 'individual']" ] """ Account holder type: individual or company. """ account_number: NotRequired["str"] """ Account number of the bank account. """ account_type: NotRequired["Literal['checking', 'savings']"] """ Account type: checkings or savings. Defaults to checking if omitted. """ financial_connections_account: NotRequired["str"] """ The ID of a Financial Connections Account to use as a payment method. """ routing_number: NotRequired["str"] """ Routing number of the bank account. """ class ConfirmParamsPaymentMethodDataSofort(TypedDict): country: Literal["AT", "BE", "DE", "ES", "IT", "NL"] """ Two-letter ISO code representing the country the bank account is located in. """ class ConfirmParamsPaymentMethodDataSepaDebit(TypedDict): iban: str """ IBAN of the bank account. """ class ConfirmParamsPaymentMethodDataRevolutPay(TypedDict): pass class ConfirmParamsPaymentMethodDataRadarOptions(TypedDict): session: NotRequired["str"] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ class ConfirmParamsPaymentMethodDataPromptpay(TypedDict): pass class ConfirmParamsPaymentMethodDataPix(TypedDict): pass class ConfirmParamsPaymentMethodDataPaypal(TypedDict): pass class ConfirmParamsPaymentMethodDataPaynow(TypedDict): pass class ConfirmParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'volkswagen_bank']" ] """ The customer's bank. """ class ConfirmParamsPaymentMethodDataOxxo(TypedDict): pass class ConfirmParamsPaymentMethodDataLink(TypedDict): pass class ConfirmParamsPaymentMethodDataKonbini(TypedDict): pass class ConfirmParamsPaymentMethodDataKlarna(TypedDict): dob: NotRequired[ "SetupIntent.ConfirmParamsPaymentMethodDataKlarnaDob" ] """ Customer's date of birth """ class ConfirmParamsPaymentMethodDataKlarnaDob(TypedDict): day: int """ The day of birth, between 1 and 31. """ month: int """ The month of birth, between 1 and 12. """ year: int """ The four-digit year of birth. """ class ConfirmParamsPaymentMethodDataInteracPresent(TypedDict): pass class ConfirmParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" ] """ The customer's bank. """ class ConfirmParamsPaymentMethodDataGrabpay(TypedDict): pass class ConfirmParamsPaymentMethodDataGiropay(TypedDict): pass class ConfirmParamsPaymentMethodDataFpx(TypedDict): account_holder_type: NotRequired[ "Literal['company', 'individual']" ] """ Account holder type for FPX transaction """ bank: Literal[ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob", ] """ The customer's bank. """ class ConfirmParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" ] """ The customer's bank. """ class ConfirmParamsPaymentMethodDataCustomerBalance(TypedDict): pass class ConfirmParamsPaymentMethodDataCashapp(TypedDict): pass class ConfirmParamsPaymentMethodDataBoleto(TypedDict): tax_id: str """ The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) """ class ConfirmParamsPaymentMethodDataBlik(TypedDict): pass class ConfirmParamsPaymentMethodDataBillingDetails(TypedDict): address: NotRequired[ "Literal['']|SetupIntent.ConfirmParamsPaymentMethodDataBillingDetailsAddress" ] """ Billing address. """ email: NotRequired["Literal['']|str"] """ Email address. """ name: NotRequired["Literal['']|str"] """ Full name. """ phone: NotRequired["Literal['']|str"] """ Billing phone number (including extension). """ class ConfirmParamsPaymentMethodDataBillingDetailsAddress(TypedDict): city: NotRequired["str"] """ City, district, suburb, town, or village. """ country: NotRequired["str"] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ line1: NotRequired["str"] """ Address line 1 (e.g., street, PO Box, or company name). """ line2: NotRequired["str"] """ Address line 2 (e.g., apartment, suite, unit, or building). """ postal_code: NotRequired["str"] """ ZIP or postal code. """ state: NotRequired["str"] """ State, county, province, or region. """ class ConfirmParamsPaymentMethodDataBancontact(TypedDict): pass class ConfirmParamsPaymentMethodDataBacsDebit(TypedDict): account_number: NotRequired["str"] """ Account number of the bank account that the funds will be debited from. """ sort_code: NotRequired["str"] """ Sort code of the bank account. (e.g., `10-20-30`) """ class ConfirmParamsPaymentMethodDataAuBecsDebit(TypedDict): account_number: str """ The account number for the bank account. """ bsb_number: str """ Bank-State-Branch number of the bank account. """ class ConfirmParamsPaymentMethodDataAlipay(TypedDict): pass class ConfirmParamsPaymentMethodDataAfterpayClearpay(TypedDict): pass class ConfirmParamsPaymentMethodDataAffirm(TypedDict): pass class ConfirmParamsPaymentMethodDataAcssDebit(TypedDict): account_number: str """ Customer's bank account number. """ institution_number: str """ Institution number of the customer's bank. """ transit_number: str """ Transit number of the customer's bank. """ class ConfirmParamsMandateData2(TypedDict): customer_acceptance: "SetupIntent.ConfirmParamsMandateDataCustomerAcceptance2" """ This hash contains details about the customer acceptance of the Mandate. """ class ConfirmParamsMandateDataCustomerAcceptance2(TypedDict): online: "SetupIntent.ConfirmParamsMandateDataCustomerAcceptanceOnline2" """ If this is a Mandate accepted online, this hash contains details about the online acceptance. """ type: Literal["online"] """ The type of customer acceptance information included with the Mandate. """ class ConfirmParamsMandateDataCustomerAcceptanceOnline2(TypedDict): ip_address: NotRequired["str"] """ The IP address from which the Mandate was accepted by the customer. """ user_agent: NotRequired["str"] """ The user agent of the browser from which the Mandate was accepted by the customer. """ class ConfirmParamsMandateData(TypedDict): customer_acceptance: "SetupIntent.ConfirmParamsMandateDataCustomerAcceptance" """ This hash contains details about the customer acceptance of the Mandate. """ class ConfirmParamsMandateDataCustomerAcceptance(TypedDict): accepted_at: NotRequired["int"] """ The time at which the customer accepted the Mandate. """ offline: NotRequired[ "SetupIntent.ConfirmParamsMandateDataCustomerAcceptanceOffline" ] """ If this is a Mandate accepted offline, this hash contains details about the offline acceptance. """ online: NotRequired[ "SetupIntent.ConfirmParamsMandateDataCustomerAcceptanceOnline" ] """ If this is a Mandate accepted online, this hash contains details about the online acceptance. """ type: Literal["offline", "online"] """ The type of customer acceptance information included with the Mandate. One of `online` or `offline`. """ class ConfirmParamsMandateDataCustomerAcceptanceOnline(TypedDict): ip_address: str """ The IP address from which the Mandate was accepted by the customer. """ user_agent: str """ The user agent of the browser from which the Mandate was accepted by the customer. """ class ConfirmParamsMandateDataCustomerAcceptanceOffline(TypedDict): pass class CreateParams(RequestOptions): attach_to_self: NotRequired["bool"] """ 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. """ automatic_payment_methods: NotRequired[ "SetupIntent.CreateParamsAutomaticPaymentMethods" ] """ When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters. """ confirm: NotRequired["bool"] """ Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary. """ customer: NotRequired["str"] """ 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. """ description: NotRequired["str"] """ An arbitrary string attached to the object. Often useful for displaying to users. """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ flow_directions: NotRequired[ "List[Literal['inbound', 'outbound']]" ] """ 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. """ mandate_data: NotRequired[ "Literal['']|SetupIntent.CreateParamsMandateData" ] """ This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). """ metadata: NotRequired["Dict[str, str]"] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ on_behalf_of: NotRequired["str"] """ The Stripe account ID created for this SetupIntent. """ payment_method: NotRequired["str"] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ payment_method_configuration: NotRequired["str"] """ The ID of the payment method configuration to use with this SetupIntent. """ payment_method_data: NotRequired[ "SetupIntent.CreateParamsPaymentMethodData" ] """ When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. """ payment_method_options: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptions" ] """ Payment method-specific configuration for this SetupIntent. """ payment_method_types: NotRequired["List[str]"] """ The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to ["card"]. """ return_url: NotRequired["str"] """ The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). """ single_use: NotRequired["SetupIntent.CreateParamsSingleUse"] """ If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion. """ usage: NotRequired["Literal['off_session', 'on_session']"] """ Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`. """ use_stripe_sdk: NotRequired["bool"] """ Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. """ class CreateParamsSingleUse(TypedDict): amount: int """ Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). """ currency: str """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ class CreateParamsPaymentMethodOptions(TypedDict): acss_debit: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsAcssDebit" ] """ If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options. """ card: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsCard" ] """ Configuration for any card setup attempted on this SetupIntent. """ link: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsLink" ] """ If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options. """ paypal: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsPaypal" ] """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ sepa_debit: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsSepaDebit" ] """ If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options. """ us_bank_account: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsUsBankAccount" ] """ If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options. """ class CreateParamsPaymentMethodOptionsUsBankAccount(TypedDict): financial_connections: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsUsBankAccountFinancialConnections" ] """ Additional fields for Financial Connections Session creation """ networks: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsUsBankAccountNetworks" ] """ Additional fields for network related functions """ verification_method: NotRequired[ "Literal['automatic', 'instant', 'microdeposits']" ] """ Verification method for the intent """ class CreateParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] """ Triggers validations to run across the selected networks """ class CreateParamsPaymentMethodOptionsUsBankAccountFinancialConnections( TypedDict, ): permissions: NotRequired[ "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired["List[Literal['balances']]"] """ List of data features that you would like to retrieve upon account creation. """ return_url: NotRequired["str"] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ class CreateParamsPaymentMethodOptionsSepaDebit(TypedDict): mandate_options: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsSepaDebitMandateOptions" ] """ Additional fields for Mandate creation """ class CreateParamsPaymentMethodOptionsSepaDebitMandateOptions( TypedDict, ): pass class CreateParamsPaymentMethodOptionsPaypal(TypedDict): billing_agreement_id: NotRequired["str"] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ class CreateParamsPaymentMethodOptionsLink(TypedDict): persistent_token: NotRequired["str"] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class CreateParamsPaymentMethodOptionsCard(TypedDict): mandate_options: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsCardMandateOptions" ] """ Configuration options for setting up an eMandate for cards issued in India. """ moto: NotRequired["bool"] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired["Literal['any', 'automatic']"] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ class CreateParamsPaymentMethodOptionsCardMandateOptions(TypedDict): amount: int """ Amount to be charged for future payments. """ amount_type: Literal["fixed", "maximum"] """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ currency: str """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ description: NotRequired["str"] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ end_date: NotRequired["int"] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ interval: Literal["day", "month", "sporadic", "week", "year"] """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ interval_count: NotRequired["int"] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ reference: str """ Unique identifier for the mandate or subscription. """ start_date: int """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ supported_types: NotRequired["List[Literal['india']]"] """ Specifies the type of mandates supported. Possible values are `india`. """ class CreateParamsPaymentMethodOptionsAcssDebit(TypedDict): currency: NotRequired["Literal['cad', 'usd']"] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ mandate_options: NotRequired[ "SetupIntent.CreateParamsPaymentMethodOptionsAcssDebitMandateOptions" ] """ Additional fields for Mandate creation """ verification_method: NotRequired[ "Literal['automatic', 'instant', 'microdeposits']" ] """ Verification method for the intent """ class CreateParamsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): custom_mandate_url: NotRequired["Literal['']|str"] """ A URL for custom mandate text to render during confirmation step. The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ default_for: NotRequired[ "List[Literal['invoice', 'subscription']]" ] """ List of Stripe products where this mandate can be selected automatically. """ interval_description: NotRequired["str"] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ "Literal['combined', 'interval', 'sporadic']" ] """ Payment schedule for the mandate. """ transaction_type: NotRequired["Literal['business', 'personal']"] """ Transaction type of the mandate. """ class CreateParamsPaymentMethodData(TypedDict): acss_debit: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataAcssDebit" ] """ If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. """ affirm: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataAffirm" ] """ If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. """ afterpay_clearpay: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataAfterpayClearpay" ] """ If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. """ alipay: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataAlipay" ] """ If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. """ au_becs_debit: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataAuBecsDebit" ] """ If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. """ bacs_debit: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataBacsDebit" ] """ If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. """ bancontact: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataBancontact" ] """ If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. """ billing_details: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataBillingDetails" ] """ Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. """ blik: NotRequired["SetupIntent.CreateParamsPaymentMethodDataBlik"] """ If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method. """ boleto: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataBoleto" ] """ If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. """ cashapp: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataCashapp" ] """ If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. """ customer_balance: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataCustomerBalance" ] """ If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method. """ eps: NotRequired["SetupIntent.CreateParamsPaymentMethodDataEps"] """ If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. """ fpx: NotRequired["SetupIntent.CreateParamsPaymentMethodDataFpx"] """ If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. """ giropay: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataGiropay" ] """ If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. """ grabpay: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataGrabpay" ] """ If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. """ ideal: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataIdeal" ] """ If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. """ interac_present: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataInteracPresent" ] """ If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. """ klarna: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataKlarna" ] """ If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. """ konbini: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataKonbini" ] """ If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method. """ link: NotRequired["SetupIntent.CreateParamsPaymentMethodDataLink"] """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ metadata: NotRequired["Dict[str, str]"] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ oxxo: NotRequired["SetupIntent.CreateParamsPaymentMethodDataOxxo"] """ If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. """ p24: NotRequired["SetupIntent.CreateParamsPaymentMethodDataP24"] """ If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. """ paynow: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataPaynow" ] """ If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method. """ paypal: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataPaypal" ] """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ pix: NotRequired["SetupIntent.CreateParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. """ promptpay: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataPromptpay" ] """ If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method. """ radar_options: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataRadarOptions" ] """ Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataRevolutPay" ] """ If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. """ sepa_debit: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataSepaDebit" ] """ If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. """ sofort: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataSofort" ] """ If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. """ type: Literal[ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "us_bank_account", "wechat_pay", "zip", ] """ The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. """ us_bank_account: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataUsBankAccount" ] """ If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. """ wechat_pay: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataWechatPay" ] """ If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. """ zip: NotRequired["SetupIntent.CreateParamsPaymentMethodDataZip"] """ If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method. """ class CreateParamsPaymentMethodDataZip(TypedDict): pass class CreateParamsPaymentMethodDataWechatPay(TypedDict): pass class CreateParamsPaymentMethodDataUsBankAccount(TypedDict): account_holder_type: NotRequired[ "Literal['company', 'individual']" ] """ Account holder type: individual or company. """ account_number: NotRequired["str"] """ Account number of the bank account. """ account_type: NotRequired["Literal['checking', 'savings']"] """ Account type: checkings or savings. Defaults to checking if omitted. """ financial_connections_account: NotRequired["str"] """ The ID of a Financial Connections Account to use as a payment method. """ routing_number: NotRequired["str"] """ Routing number of the bank account. """ class CreateParamsPaymentMethodDataSofort(TypedDict): country: Literal["AT", "BE", "DE", "ES", "IT", "NL"] """ Two-letter ISO code representing the country the bank account is located in. """ class CreateParamsPaymentMethodDataSepaDebit(TypedDict): iban: str """ IBAN of the bank account. """ class CreateParamsPaymentMethodDataRevolutPay(TypedDict): pass class CreateParamsPaymentMethodDataRadarOptions(TypedDict): session: NotRequired["str"] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ class CreateParamsPaymentMethodDataPromptpay(TypedDict): pass class CreateParamsPaymentMethodDataPix(TypedDict): pass class CreateParamsPaymentMethodDataPaypal(TypedDict): pass class CreateParamsPaymentMethodDataPaynow(TypedDict): pass class CreateParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'volkswagen_bank']" ] """ The customer's bank. """ class CreateParamsPaymentMethodDataOxxo(TypedDict): pass class CreateParamsPaymentMethodDataLink(TypedDict): pass class CreateParamsPaymentMethodDataKonbini(TypedDict): pass class CreateParamsPaymentMethodDataKlarna(TypedDict): dob: NotRequired[ "SetupIntent.CreateParamsPaymentMethodDataKlarnaDob" ] """ Customer's date of birth """ class CreateParamsPaymentMethodDataKlarnaDob(TypedDict): day: int """ The day of birth, between 1 and 31. """ month: int """ The month of birth, between 1 and 12. """ year: int """ The four-digit year of birth. """ class CreateParamsPaymentMethodDataInteracPresent(TypedDict): pass class CreateParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" ] """ The customer's bank. """ class CreateParamsPaymentMethodDataGrabpay(TypedDict): pass class CreateParamsPaymentMethodDataGiropay(TypedDict): pass class CreateParamsPaymentMethodDataFpx(TypedDict): account_holder_type: NotRequired[ "Literal['company', 'individual']" ] """ Account holder type for FPX transaction """ bank: Literal[ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob", ] """ The customer's bank. """ class CreateParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" ] """ The customer's bank. """ class CreateParamsPaymentMethodDataCustomerBalance(TypedDict): pass class CreateParamsPaymentMethodDataCashapp(TypedDict): pass class CreateParamsPaymentMethodDataBoleto(TypedDict): tax_id: str """ The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) """ class CreateParamsPaymentMethodDataBlik(TypedDict): pass class CreateParamsPaymentMethodDataBillingDetails(TypedDict): address: NotRequired[ "Literal['']|SetupIntent.CreateParamsPaymentMethodDataBillingDetailsAddress" ] """ Billing address. """ email: NotRequired["Literal['']|str"] """ Email address. """ name: NotRequired["Literal['']|str"] """ Full name. """ phone: NotRequired["Literal['']|str"] """ Billing phone number (including extension). """ class CreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict): city: NotRequired["str"] """ City, district, suburb, town, or village. """ country: NotRequired["str"] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ line1: NotRequired["str"] """ Address line 1 (e.g., street, PO Box, or company name). """ line2: NotRequired["str"] """ Address line 2 (e.g., apartment, suite, unit, or building). """ postal_code: NotRequired["str"] """ ZIP or postal code. """ state: NotRequired["str"] """ State, county, province, or region. """ class CreateParamsPaymentMethodDataBancontact(TypedDict): pass class CreateParamsPaymentMethodDataBacsDebit(TypedDict): account_number: NotRequired["str"] """ Account number of the bank account that the funds will be debited from. """ sort_code: NotRequired["str"] """ Sort code of the bank account. (e.g., `10-20-30`) """ class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict): account_number: str """ The account number for the bank account. """ bsb_number: str """ Bank-State-Branch number of the bank account. """ class CreateParamsPaymentMethodDataAlipay(TypedDict): pass class CreateParamsPaymentMethodDataAfterpayClearpay(TypedDict): pass class CreateParamsPaymentMethodDataAffirm(TypedDict): pass class CreateParamsPaymentMethodDataAcssDebit(TypedDict): account_number: str """ Customer's bank account number. """ institution_number: str """ Institution number of the customer's bank. """ transit_number: str """ Transit number of the customer's bank. """ class CreateParamsMandateData(TypedDict): customer_acceptance: "SetupIntent.CreateParamsMandateDataCustomerAcceptance" """ This hash contains details about the customer acceptance of the Mandate. """ class CreateParamsMandateDataCustomerAcceptance(TypedDict): accepted_at: NotRequired["int"] """ The time at which the customer accepted the Mandate. """ offline: NotRequired[ "SetupIntent.CreateParamsMandateDataCustomerAcceptanceOffline" ] """ If this is a Mandate accepted offline, this hash contains details about the offline acceptance. """ online: NotRequired[ "SetupIntent.CreateParamsMandateDataCustomerAcceptanceOnline" ] """ If this is a Mandate accepted online, this hash contains details about the online acceptance. """ type: Literal["offline", "online"] """ The type of customer acceptance information included with the Mandate. One of `online` or `offline`. """ class CreateParamsMandateDataCustomerAcceptanceOnline(TypedDict): ip_address: str """ The IP address from which the Mandate was accepted by the customer. """ user_agent: str """ The user agent of the browser from which the Mandate was accepted by the customer. """ class CreateParamsMandateDataCustomerAcceptanceOffline(TypedDict): pass class CreateParamsAutomaticPaymentMethods(TypedDict): allow_redirects: NotRequired["Literal['always', 'never']"] """ Controls whether this SetupIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. """ enabled: bool """ Whether this feature is enabled. """ class ListParams(RequestOptions): attach_to_self: NotRequired["bool"] """ 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. """ created: NotRequired["SetupIntent.ListParamsCreated|int"] """ A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. """ customer: NotRequired["str"] """ Only return SetupIntents for the customer specified by this customer ID. """ ending_before: NotRequired["str"] """ A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ limit: NotRequired["int"] """ A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. """ payment_method: NotRequired["str"] """ Only return SetupIntents that associate with the specified payment method. """ starting_after: NotRequired["str"] """ A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. """ class ListParamsCreated(TypedDict): gt: NotRequired["int"] """ Minimum value to filter by (exclusive) """ gte: NotRequired["int"] """ Minimum value to filter by (inclusive) """ lt: NotRequired["int"] """ Maximum value to filter by (exclusive) """ lte: NotRequired["int"] """ Maximum value to filter by (inclusive) """ class ModifyParams(RequestOptions): attach_to_self: NotRequired["bool"] """ 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. """ customer: NotRequired["str"] """ 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. """ description: NotRequired["str"] """ An arbitrary string attached to the object. Often useful for displaying to users. """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ flow_directions: NotRequired[ "List[Literal['inbound', 'outbound']]" ] """ 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. """ metadata: NotRequired["Literal['']|Dict[str, str]"] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ payment_method: NotRequired["str"] """ ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. """ payment_method_configuration: NotRequired["str"] """ The ID of the payment method configuration to use with this SetupIntent. """ payment_method_data: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodData" ] """ When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. """ payment_method_options: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptions" ] """ Payment method-specific configuration for this SetupIntent. """ payment_method_types: NotRequired["List[str]"] """ The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to ["card"]. """ class ModifyParamsPaymentMethodOptions(TypedDict): acss_debit: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsAcssDebit" ] """ If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options. """ card: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsCard" ] """ Configuration for any card setup attempted on this SetupIntent. """ link: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsLink" ] """ If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options. """ paypal: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsPaypal" ] """ If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options. """ sepa_debit: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsSepaDebit" ] """ If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options. """ us_bank_account: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsUsBankAccount" ] """ If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options. """ class ModifyParamsPaymentMethodOptionsUsBankAccount(TypedDict): financial_connections: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsUsBankAccountFinancialConnections" ] """ Additional fields for Financial Connections Session creation """ networks: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsUsBankAccountNetworks" ] """ Additional fields for network related functions """ verification_method: NotRequired[ "Literal['automatic', 'instant', 'microdeposits']" ] """ Verification method for the intent """ class ModifyParamsPaymentMethodOptionsUsBankAccountNetworks(TypedDict): requested: NotRequired["List[Literal['ach', 'us_domestic_wire']]"] """ Triggers validations to run across the selected networks """ class ModifyParamsPaymentMethodOptionsUsBankAccountFinancialConnections( TypedDict, ): permissions: NotRequired[ "List[Literal['balances', 'ownership', 'payment_method', 'transactions']]" ] """ The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`. """ prefetch: NotRequired["List[Literal['balances']]"] """ List of data features that you would like to retrieve upon account creation. """ return_url: NotRequired["str"] """ For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. """ class ModifyParamsPaymentMethodOptionsSepaDebit(TypedDict): mandate_options: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsSepaDebitMandateOptions" ] """ Additional fields for Mandate creation """ class ModifyParamsPaymentMethodOptionsSepaDebitMandateOptions( TypedDict, ): pass class ModifyParamsPaymentMethodOptionsPaypal(TypedDict): billing_agreement_id: NotRequired["str"] """ The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. """ class ModifyParamsPaymentMethodOptionsLink(TypedDict): persistent_token: NotRequired["str"] """ [Deprecated] This is a legacy parameter that no longer has any function. """ class ModifyParamsPaymentMethodOptionsCard(TypedDict): mandate_options: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsCardMandateOptions" ] """ Configuration options for setting up an eMandate for cards issued in India. """ moto: NotRequired["bool"] """ When specified, this parameter signals that a card has been collected as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation. """ network: NotRequired[ "Literal['amex', 'cartes_bancaires', 'diners', 'discover', 'eftpos_au', 'interac', 'jcb', 'mastercard', 'unionpay', 'unknown', 'visa']" ] """ Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time. """ request_three_d_secure: NotRequired["Literal['any', 'automatic']"] """ We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. """ class ModifyParamsPaymentMethodOptionsCardMandateOptions(TypedDict): amount: int """ Amount to be charged for future payments. """ amount_type: Literal["fixed", "maximum"] """ One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. """ currency: str """ Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ description: NotRequired["str"] """ A description of the mandate or subscription that is meant to be displayed to the customer. """ end_date: NotRequired["int"] """ End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. """ interval: Literal["day", "month", "sporadic", "week", "year"] """ Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. """ interval_count: NotRequired["int"] """ The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. """ reference: str """ Unique identifier for the mandate or subscription. """ start_date: int """ Start date of the mandate or subscription. Start date should not be lesser than yesterday. """ supported_types: NotRequired["List[Literal['india']]"] """ Specifies the type of mandates supported. Possible values are `india`. """ class ModifyParamsPaymentMethodOptionsAcssDebit(TypedDict): currency: NotRequired["Literal['cad', 'usd']"] """ Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). """ mandate_options: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodOptionsAcssDebitMandateOptions" ] """ Additional fields for Mandate creation """ verification_method: NotRequired[ "Literal['automatic', 'instant', 'microdeposits']" ] """ Verification method for the intent """ class ModifyParamsPaymentMethodOptionsAcssDebitMandateOptions( TypedDict, ): custom_mandate_url: NotRequired["Literal['']|str"] """ A URL for custom mandate text to render during confirmation step. The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent, or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent. """ default_for: NotRequired[ "List[Literal['invoice', 'subscription']]" ] """ List of Stripe products where this mandate can be selected automatically. """ interval_description: NotRequired["str"] """ Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'. """ payment_schedule: NotRequired[ "Literal['combined', 'interval', 'sporadic']" ] """ Payment schedule for the mandate. """ transaction_type: NotRequired["Literal['business', 'personal']"] """ Transaction type of the mandate. """ class ModifyParamsPaymentMethodData(TypedDict): acss_debit: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataAcssDebit" ] """ If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. """ affirm: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataAffirm" ] """ If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. """ afterpay_clearpay: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataAfterpayClearpay" ] """ If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. """ alipay: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataAlipay" ] """ If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. """ au_becs_debit: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataAuBecsDebit" ] """ If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. """ bacs_debit: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataBacsDebit" ] """ If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. """ bancontact: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataBancontact" ] """ If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. """ billing_details: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataBillingDetails" ] """ Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. """ blik: NotRequired["SetupIntent.ModifyParamsPaymentMethodDataBlik"] """ If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method. """ boleto: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataBoleto" ] """ If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. """ cashapp: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataCashapp" ] """ If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. """ customer_balance: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataCustomerBalance" ] """ If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method. """ eps: NotRequired["SetupIntent.ModifyParamsPaymentMethodDataEps"] """ If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. """ fpx: NotRequired["SetupIntent.ModifyParamsPaymentMethodDataFpx"] """ If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. """ giropay: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataGiropay" ] """ If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. """ grabpay: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataGrabpay" ] """ If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. """ ideal: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataIdeal" ] """ If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. """ interac_present: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataInteracPresent" ] """ If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. """ klarna: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataKlarna" ] """ If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method. """ konbini: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataKonbini" ] """ If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method. """ link: NotRequired["SetupIntent.ModifyParamsPaymentMethodDataLink"] """ If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. """ metadata: NotRequired["Dict[str, str]"] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. """ oxxo: NotRequired["SetupIntent.ModifyParamsPaymentMethodDataOxxo"] """ If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. """ p24: NotRequired["SetupIntent.ModifyParamsPaymentMethodDataP24"] """ If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. """ paynow: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataPaynow" ] """ If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method. """ paypal: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataPaypal" ] """ If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. """ pix: NotRequired["SetupIntent.ModifyParamsPaymentMethodDataPix"] """ If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. """ promptpay: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataPromptpay" ] """ If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method. """ radar_options: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataRadarOptions" ] """ Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. """ revolut_pay: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataRevolutPay" ] """ If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. """ sepa_debit: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataSepaDebit" ] """ If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. """ sofort: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataSofort" ] """ If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. """ type: Literal[ "acss_debit", "affirm", "afterpay_clearpay", "alipay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "us_bank_account", "wechat_pay", "zip", ] """ The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. """ us_bank_account: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataUsBankAccount" ] """ If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. """ wechat_pay: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataWechatPay" ] """ If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. """ zip: NotRequired["SetupIntent.ModifyParamsPaymentMethodDataZip"] """ If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method. """ class ModifyParamsPaymentMethodDataZip(TypedDict): pass class ModifyParamsPaymentMethodDataWechatPay(TypedDict): pass class ModifyParamsPaymentMethodDataUsBankAccount(TypedDict): account_holder_type: NotRequired[ "Literal['company', 'individual']" ] """ Account holder type: individual or company. """ account_number: NotRequired["str"] """ Account number of the bank account. """ account_type: NotRequired["Literal['checking', 'savings']"] """ Account type: checkings or savings. Defaults to checking if omitted. """ financial_connections_account: NotRequired["str"] """ The ID of a Financial Connections Account to use as a payment method. """ routing_number: NotRequired["str"] """ Routing number of the bank account. """ class ModifyParamsPaymentMethodDataSofort(TypedDict): country: Literal["AT", "BE", "DE", "ES", "IT", "NL"] """ Two-letter ISO code representing the country the bank account is located in. """ class ModifyParamsPaymentMethodDataSepaDebit(TypedDict): iban: str """ IBAN of the bank account. """ class ModifyParamsPaymentMethodDataRevolutPay(TypedDict): pass class ModifyParamsPaymentMethodDataRadarOptions(TypedDict): session: NotRequired["str"] """ A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. """ class ModifyParamsPaymentMethodDataPromptpay(TypedDict): pass class ModifyParamsPaymentMethodDataPix(TypedDict): pass class ModifyParamsPaymentMethodDataPaypal(TypedDict): pass class ModifyParamsPaymentMethodDataPaynow(TypedDict): pass class ModifyParamsPaymentMethodDataP24(TypedDict): bank: NotRequired[ "Literal['alior_bank', 'bank_millennium', 'bank_nowy_bfg_sa', 'bank_pekao_sa', 'banki_spbdzielcze', 'blik', 'bnp_paribas', 'boz', 'citi_handlowy', 'credit_agricole', 'envelobank', 'etransfer_pocztowy24', 'getin_bank', 'ideabank', 'ing', 'inteligo', 'mbank_mtransfer', 'nest_przelew', 'noble_pay', 'pbac_z_ipko', 'plus_bank', 'santander_przelew24', 'tmobile_usbugi_bankowe', 'toyota_bank', 'volkswagen_bank']" ] """ The customer's bank. """ class ModifyParamsPaymentMethodDataOxxo(TypedDict): pass class ModifyParamsPaymentMethodDataLink(TypedDict): pass class ModifyParamsPaymentMethodDataKonbini(TypedDict): pass class ModifyParamsPaymentMethodDataKlarna(TypedDict): dob: NotRequired[ "SetupIntent.ModifyParamsPaymentMethodDataKlarnaDob" ] """ Customer's date of birth """ class ModifyParamsPaymentMethodDataKlarnaDob(TypedDict): day: int """ The day of birth, between 1 and 31. """ month: int """ The month of birth, between 1 and 12. """ year: int """ The four-digit year of birth. """ class ModifyParamsPaymentMethodDataInteracPresent(TypedDict): pass class ModifyParamsPaymentMethodDataIdeal(TypedDict): bank: NotRequired[ "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']" ] """ The customer's bank. """ class ModifyParamsPaymentMethodDataGrabpay(TypedDict): pass class ModifyParamsPaymentMethodDataGiropay(TypedDict): pass class ModifyParamsPaymentMethodDataFpx(TypedDict): account_holder_type: NotRequired[ "Literal['company', 'individual']" ] """ Account holder type for FPX transaction """ bank: Literal[ "affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob", ] """ The customer's bank. """ class ModifyParamsPaymentMethodDataEps(TypedDict): bank: NotRequired[ "Literal['arzte_und_apotheker_bank', 'austrian_anadi_bank_ag', 'bank_austria', 'bankhaus_carl_spangler', 'bankhaus_schelhammer_und_schattera_ag', 'bawag_psk_ag', 'bks_bank_ag', 'brull_kallmus_bank_ag', 'btv_vier_lander_bank', 'capital_bank_grawe_gruppe_ag', 'deutsche_bank_ag', 'dolomitenbank', 'easybank_ag', 'erste_bank_und_sparkassen', 'hypo_alpeadriabank_international_ag', 'hypo_bank_burgenland_aktiengesellschaft', 'hypo_noe_lb_fur_niederosterreich_u_wien', 'hypo_oberosterreich_salzburg_steiermark', 'hypo_tirol_bank_ag', 'hypo_vorarlberg_bank_ag', 'marchfelder_bank', 'oberbank_ag', 'raiffeisen_bankengruppe_osterreich', 'schoellerbank_ag', 'sparda_bank_wien', 'volksbank_gruppe', 'volkskreditbank_ag', 'vr_bank_braunau']" ] """ The customer's bank. """ class ModifyParamsPaymentMethodDataCustomerBalance(TypedDict): pass class ModifyParamsPaymentMethodDataCashapp(TypedDict): pass class ModifyParamsPaymentMethodDataBoleto(TypedDict): tax_id: str """ The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) """ class ModifyParamsPaymentMethodDataBlik(TypedDict): pass class ModifyParamsPaymentMethodDataBillingDetails(TypedDict): address: NotRequired[ "Literal['']|SetupIntent.ModifyParamsPaymentMethodDataBillingDetailsAddress" ] """ Billing address. """ email: NotRequired["Literal['']|str"] """ Email address. """ name: NotRequired["Literal['']|str"] """ Full name. """ phone: NotRequired["Literal['']|str"] """ Billing phone number (including extension). """ class ModifyParamsPaymentMethodDataBillingDetailsAddress(TypedDict): city: NotRequired["str"] """ City, district, suburb, town, or village. """ country: NotRequired["str"] """ Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). """ line1: NotRequired["str"] """ Address line 1 (e.g., street, PO Box, or company name). """ line2: NotRequired["str"] """ Address line 2 (e.g., apartment, suite, unit, or building). """ postal_code: NotRequired["str"] """ ZIP or postal code. """ state: NotRequired["str"] """ State, county, province, or region. """ class ModifyParamsPaymentMethodDataBancontact(TypedDict): pass class ModifyParamsPaymentMethodDataBacsDebit(TypedDict): account_number: NotRequired["str"] """ Account number of the bank account that the funds will be debited from. """ sort_code: NotRequired["str"] """ Sort code of the bank account. (e.g., `10-20-30`) """ class ModifyParamsPaymentMethodDataAuBecsDebit(TypedDict): account_number: str """ The account number for the bank account. """ bsb_number: str """ Bank-State-Branch number of the bank account. """ class ModifyParamsPaymentMethodDataAlipay(TypedDict): pass class ModifyParamsPaymentMethodDataAfterpayClearpay(TypedDict): pass class ModifyParamsPaymentMethodDataAffirm(TypedDict): pass class ModifyParamsPaymentMethodDataAcssDebit(TypedDict): account_number: str """ Customer's bank account number. """ institution_number: str """ Institution number of the customer's bank. """ transit_number: str """ Transit number of the customer's bank. """ class RetrieveParams(RequestOptions): client_secret: NotRequired["str"] """ The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent. """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ class VerifyMicrodepositsParams(RequestOptions): amounts: NotRequired["List[int]"] """ Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account. """ descriptor_code: NotRequired["str"] """ A six-character code starting with SM present in the microdeposit sent to the bank account. """ expand: NotRequired["List[str]"] """ Specifies which fields in the response should be expanded. """ application: Optional[ExpandableField["Application"]] """ ID of the Connect application that created the SetupIntent. """ attach_to_self: Optional[bool] """ 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. """ automatic_payment_methods: Optional[AutomaticPaymentMethods] """ Settings for dynamic payment methods compatible with this Setup Intent """ cancellation_reason: Optional[ Literal["abandoned", "duplicate", "requested_by_customer"] ] """ Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. """ client_secret: Optional[str] """ 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. """ created: int """ Time at which the object was created. Measured in seconds since the Unix epoch. """ customer: Optional[ExpandableField["Customer"]] """ 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. """ description: Optional[str] """ An arbitrary string attached to the object. Often useful for displaying to users. """ flow_directions: Optional[List[Literal["inbound", "outbound"]]] """ 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. """ id: str """ Unique identifier for the object. """ last_setup_error: Optional[LastSetupError] """ The error encountered in the previous SetupIntent confirmation. """ latest_attempt: Optional[ExpandableField["SetupAttempt"]] """ The most recent SetupAttempt for this SetupIntent. """ livemode: bool """ Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. """ mandate: Optional[ExpandableField["Mandate"]] """ ID of the multi use Mandate generated by the SetupIntent. """ metadata: Optional[Dict[str, str]] """ Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. """ next_action: Optional[NextAction] """ If present, this property tells you what actions you need to take in order for your customer to continue payment setup. """ object: Literal["setup_intent"] """ String representing the object's type. Objects of the same type share the same value. """ on_behalf_of: Optional[ExpandableField["Account"]] """ The account (if any) for which the setup is intended. """ payment_method: Optional[ExpandableField["PaymentMethod"]] """ ID of the payment method used with this SetupIntent. """ payment_method_configuration_details: Optional[ PaymentMethodConfigurationDetails ] """ Information about the payment method configuration used for this Setup Intent. """ payment_method_options: Optional[PaymentMethodOptions] """ Payment method-specific configuration for this SetupIntent. """ payment_method_types: List[str] """ The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. """ single_use_mandate: Optional[ExpandableField["Mandate"]] """ ID of the single_use Mandate generated by the SetupIntent. """ status: Literal[ "canceled", "processing", "requires_action", "requires_confirmation", "requires_payment_method", "succeeded", ] """ [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. """ usage: str """ 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`. """ @classmethod def _cls_cancel( cls, intent: str, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack["SetupIntent.CancelParams"] ) -> "SetupIntent": """ 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. """ return cast( "SetupIntent", cls._static_request( "post", "/v1/setup_intents/{intent}/cancel".format( intent=util.sanitize_id(intent) ), api_key=api_key, stripe_version=stripe_version, stripe_account=stripe_account, params=params, ), ) @overload @staticmethod def cancel( intent: str, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack["SetupIntent.CancelParams"] ) -> "SetupIntent": """ 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. """ ... @overload def cancel( self, idempotency_key: Optional[str] = None, **params: Unpack["SetupIntent.CancelParams"] ) -> "SetupIntent": """ 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. """ ... @class_method_variant("_cls_cancel") def cancel( # pyright: ignore[reportGeneralTypeIssues] self, idempotency_key: Optional[str] = None, **params: Unpack["SetupIntent.CancelParams"] ) -> "SetupIntent": """ 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. """ return cast( "SetupIntent", self._request( "post", "/v1/setup_intents/{intent}/cancel".format( intent=util.sanitize_id(self.get("id")) ), idempotency_key=idempotency_key, params=params, ), ) @classmethod def _cls_confirm( cls, intent: str, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack["SetupIntent.ConfirmParams"] ) -> "SetupIntent": """ 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. """ return cast( "SetupIntent", cls._static_request( "post", "/v1/setup_intents/{intent}/confirm".format( intent=util.sanitize_id(intent) ), api_key=api_key, stripe_version=stripe_version, stripe_account=stripe_account, params=params, ), ) @overload @staticmethod def confirm( intent: str, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack["SetupIntent.ConfirmParams"] ) -> "SetupIntent": """ 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. """ ... @overload def confirm( self, idempotency_key: Optional[str] = None, **params: Unpack["SetupIntent.ConfirmParams"] ) -> "SetupIntent": """ 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. """ ... @class_method_variant("_cls_confirm") def confirm( # pyright: ignore[reportGeneralTypeIssues] self, idempotency_key: Optional[str] = None, **params: Unpack["SetupIntent.ConfirmParams"] ) -> "SetupIntent": """ 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. """ return cast( "SetupIntent", self._request( "post", "/v1/setup_intents/{intent}/confirm".format( intent=util.sanitize_id(self.get("id")) ), idempotency_key=idempotency_key, params=params, ), ) @classmethod def create( cls, api_key: Optional[str] = None, idempotency_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack["SetupIntent.CreateParams"] ) -> "SetupIntent": """ Creates a SetupIntent object. After you create the SetupIntent, attach a payment method and [confirm](https://stripe.com/docs/api/setup_intents/confirm) it to collect any required permissions to charge the payment method later. """ return cast( "SetupIntent", cls._static_request( "post", cls.class_url(), api_key, idempotency_key, stripe_version, stripe_account, params, ), ) @classmethod def list( cls, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack["SetupIntent.ListParams"] ) -> ListObject["SetupIntent"]: """ Returns a list of SetupIntents. """ result = cls._static_request( "get", cls.class_url(), api_key=api_key, stripe_version=stripe_version, stripe_account=stripe_account, params=params, ) if not isinstance(result, ListObject): raise TypeError( "Expected list object from API, got %s" % (type(result).__name__) ) return result @classmethod def modify( cls, id: str, **params: Unpack["SetupIntent.ModifyParams"] ) -> "SetupIntent": """ Updates a SetupIntent object. """ url = "%s/%s" % (cls.class_url(), quote_plus(id)) return cast( "SetupIntent", cls._static_request("post", url, params=params), ) @classmethod def retrieve( cls, id: str, **params: Unpack["SetupIntent.RetrieveParams"] ) -> "SetupIntent": """ Retrieves the details of a SetupIntent that has previously been created. Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string. When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://stripe.com/docs/api#setup_intent_object) object reference for more details. """ instance = cls(id, **params) instance.refresh() return instance @classmethod def _cls_verify_microdeposits( cls, intent: str, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack["SetupIntent.VerifyMicrodepositsParams"] ) -> "SetupIntent": """ Verifies microdeposits on a SetupIntent object. """ return cast( "SetupIntent", cls._static_request( "post", "/v1/setup_intents/{intent}/verify_microdeposits".format( intent=util.sanitize_id(intent) ), api_key=api_key, stripe_version=stripe_version, stripe_account=stripe_account, params=params, ), ) @overload @staticmethod def verify_microdeposits( intent: str, api_key: Optional[str] = None, stripe_version: Optional[str] = None, stripe_account: Optional[str] = None, **params: Unpack["SetupIntent.VerifyMicrodepositsParams"] ) -> "SetupIntent": """ Verifies microdeposits on a SetupIntent object. """ ... @overload def verify_microdeposits( self, idempotency_key: Optional[str] = None, **params: Unpack["SetupIntent.VerifyMicrodepositsParams"] ) -> "SetupIntent": """ Verifies microdeposits on a SetupIntent object. """ ... @class_method_variant("_cls_verify_microdeposits") def verify_microdeposits( # pyright: ignore[reportGeneralTypeIssues] self, idempotency_key: Optional[str] = None, **params: Unpack["SetupIntent.VerifyMicrodepositsParams"] ) -> "SetupIntent": """ Verifies microdeposits on a SetupIntent object. """ return cast( "SetupIntent", self._request( "post", "/v1/setup_intents/{intent}/verify_microdeposits".format( intent=util.sanitize_id(self.get("id")) ), idempotency_key=idempotency_key, params=params, ), ) _inner_class_types = { "automatic_payment_methods": AutomaticPaymentMethods, "last_setup_error": LastSetupError, "next_action": NextAction, "payment_method_configuration_details": PaymentMethodConfigurationDetails, "payment_method_options": PaymentMethodOptions, }