8378962062

Committed 21 Mar 2024 05:06PM UTC coverage: 97.435% (+0.01%) from 97.424%

Build # 8378962062

Build Type

Pull #1273

github

Committed by

web-flow

Commit Message

Merge a2a466275 into 38bcf6eec

Pull Request Pull Request #1273: Update generated code

Run Details

895 of 1350 branches covered (66.3%)

Branch coverage included in aggregate %.

1261 of 1281 new or added lines in 25 files covered. (98.44%)

1 existing line in 1 file now uncovered.

56378 of 57431 relevant lines covered (98.17%)

0.98 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

99.59

/stripe/test_helpers/_confirmation_token_service.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._confirmation_token import ConfirmationToken
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict


class ConfirmationTokenService(StripeService):
    class CreateParams(TypedDict):
        expand: NotRequired["List[str]"]
        """
        Specifies which fields in the response should be expanded.
        """
        payment_method: NotRequired["str"]
        """
        ID of an existing PaymentMethod.
        """
        payment_method_data: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodData"
        ]
        """
        If provided, this hash will be used to create a PaymentMethod.
        """
        return_url: NotRequired["str"]
        """
        Return URL used to confirm the Intent.
        """
        setup_future_usage: NotRequired["Literal['off_session', 'on_session']"]
        """
        Indicates that you intend to make future payments with this ConfirmationToken's payment method.

        The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
        """
        shipping: NotRequired["ConfirmationTokenService.CreateParamsShipping"]
        """
        Shipping information for this ConfirmationToken.
        """

    class CreateParamsPaymentMethodData(TypedDict):
        acss_debit: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataAcssDebit"
        ]
        """
        If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
        """
        affirm: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataAffirm"
        ]
        """
        If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
        """
        afterpay_clearpay: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataAfterpayClearpay"
        ]
        """
        If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
        """
        alipay: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataAlipay"
        ]
        """
        If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
        """
        au_becs_debit: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataAuBecsDebit"
        ]
        """
        If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
        """
        bacs_debit: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataBacsDebit"
        ]
        """
        If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
        """
        bancontact: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataBancontact"
        ]
        """
        If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
        """
        billing_details: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataBillingDetails"
        ]
        """
        Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
        """
        blik: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataBlik"
        ]
        """
        If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
        """
        boleto: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataBoleto"
        ]
        """
        If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
        """
        cashapp: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataCashapp"
        ]
        """
        If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
        """
        customer_balance: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataCustomerBalance"
        ]
        """
        If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
        """
        eps: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataEps"
        ]
        """
        If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
        """
        fpx: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataFpx"
        ]
        """
        If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
        """
        giropay: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataGiropay"
        ]
        """
        If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
        """
        grabpay: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataGrabpay"
        ]
        """
        If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
        """
        ideal: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataIdeal"
        ]
        """
        If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
        """
        interac_present: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataInteracPresent"
        ]
        """
        If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
        """
        klarna: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataKlarna"
        ]
        """
        If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
        """
        konbini: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataKonbini"
        ]
        """
        If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
        """
        link: NotRequired[
            "ConfirmationTokenService.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[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataOxxo"
        ]
        """
        If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
        """
        p24: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataP24"
        ]
        """
        If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
        """
        paynow: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataPaynow"
        ]
        """
        If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
        """
        paypal: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataPaypal"
        ]
        """
        If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
        """
        pix: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataPix"
        ]
        """
        If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
        """
        promptpay: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataPromptpay"
        ]
        """
        If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
        """
        radar_options: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataRadarOptions"
        ]
        """
        Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
        """
        revolut_pay: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataRevolutPay"
        ]
        """
        If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
        """
        sepa_debit: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataSepaDebit"
        ]
        """
        If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
        """
        sofort: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataSofort"
        ]
        """
        If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
        """
        swish: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataSwish"
        ]
        """
        If this is a `swish` PaymentMethod, this hash contains details about the Swish 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",
            "swish",
            "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[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataUsBankAccount"
        ]
        """
        If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
        """
        wechat_pay: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataWechatPay"
        ]
        """
        If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
        """
        zip: NotRequired[
            "ConfirmationTokenService.CreateParamsPaymentMethodDataZip"
        ]
        """
        If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
        """

    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 CreateParamsPaymentMethodDataAffirm(TypedDict):
        pass

    class CreateParamsPaymentMethodDataAfterpayClearpay(TypedDict):
        pass

    class CreateParamsPaymentMethodDataAlipay(TypedDict):
        pass

    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 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 CreateParamsPaymentMethodDataBancontact(TypedDict):
        pass

    class CreateParamsPaymentMethodDataBillingDetails(TypedDict):
        address: NotRequired[
            "Literal['']|ConfirmationTokenService.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 CreateParamsPaymentMethodDataBlik(TypedDict):
        pass

    class CreateParamsPaymentMethodDataBoleto(TypedDict):
        tax_id: str
        """
        The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
        """

    class CreateParamsPaymentMethodDataCashapp(TypedDict):
        pass

    class CreateParamsPaymentMethodDataCustomerBalance(TypedDict):
        pass

    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 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 CreateParamsPaymentMethodDataGiropay(TypedDict):
        pass

    class CreateParamsPaymentMethodDataGrabpay(TypedDict):
        pass

    class CreateParamsPaymentMethodDataIdeal(TypedDict):
        bank: NotRequired[
            "Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']"
        ]
        """
        The customer's bank.
        """

    class CreateParamsPaymentMethodDataInteracPresent(TypedDict):
        pass

    class CreateParamsPaymentMethodDataKlarna(TypedDict):
        dob: NotRequired[
            "ConfirmationTokenService.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 CreateParamsPaymentMethodDataKonbini(TypedDict):
        pass

    class CreateParamsPaymentMethodDataLink(TypedDict):
        pass

    class CreateParamsPaymentMethodDataOxxo(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', 'velobank', 'volkswagen_bank']"
        ]
        """
        The customer's bank.
        """

    class CreateParamsPaymentMethodDataPaynow(TypedDict):
        pass

    class CreateParamsPaymentMethodDataPaypal(TypedDict):
        pass

    class CreateParamsPaymentMethodDataPix(TypedDict):
        pass

    class CreateParamsPaymentMethodDataPromptpay(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 CreateParamsPaymentMethodDataRevolutPay(TypedDict):
        pass

    class CreateParamsPaymentMethodDataSepaDebit(TypedDict):
        iban: str
        """
        IBAN 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 CreateParamsPaymentMethodDataSwish(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 CreateParamsPaymentMethodDataWechatPay(TypedDict):
        pass

    class CreateParamsPaymentMethodDataZip(TypedDict):
        pass

    class CreateParamsShipping(TypedDict):
        address: "ConfirmationTokenService.CreateParamsShippingAddress"
        """
        Shipping address
        """
        name: str
        """
        Recipient name.
        """
        phone: NotRequired["Literal['']|str"]
        """
        Recipient phone (including extension)
        """

    class CreateParamsShippingAddress(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.
        """

    def create(
        self,
        params: "ConfirmationTokenService.CreateParams" = {},
        options: RequestOptions = {},
    ) -> ConfirmationToken:
        """
        Creates a test mode Confirmation Token server side for your integration tests.
        """
        return cast(
            ConfirmationToken,
            self._request(
                "post",
                "/v1/test_helpers/confirmation_tokens",
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._confirmation_token import ConfirmationToken	1✔
4	from stripe._request_options import RequestOptions	1✔
5	from stripe._stripe_service import StripeService	1✔
6	from typing import Dict, List, cast	1✔
7	from typing_extensions import Literal, NotRequired, TypedDict	1✔
8
9
10	class ConfirmationTokenService(StripeService):	1✔
11	class CreateParams(TypedDict):	1✔
12	expand: NotRequired["List[str]"]	1✔
13	"""	1✔
14	Specifies which fields in the response should be expanded.
15	"""
16	payment_method: NotRequired["str"]	1✔
17	"""	1✔
18	ID of an existing PaymentMethod.
19	"""
20	payment_method_data: NotRequired[	1✔
21	"ConfirmationTokenService.CreateParamsPaymentMethodData"
22	]
23	"""	1✔
24	If provided, this hash will be used to create a PaymentMethod.
25	"""
26	return_url: NotRequired["str"]	1✔
27	"""	1✔
28	Return URL used to confirm the Intent.
29	"""
30	setup_future_usage: NotRequired["Literal['off_session', 'on_session']"]	1✔
31	"""	1✔
32	Indicates that you intend to make future payments with this ConfirmationToken's payment method.
33
34	The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
35	"""
36	shipping: NotRequired["ConfirmationTokenService.CreateParamsShipping"]	1✔
37	"""	1✔
38	Shipping information for this ConfirmationToken.
39	"""
40
41	class CreateParamsPaymentMethodData(TypedDict):	1✔
42	acss_debit: NotRequired[	1✔
43	"ConfirmationTokenService.CreateParamsPaymentMethodDataAcssDebit"
44	]
45	"""	1✔
46	If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
47	"""
48	affirm: NotRequired[	1✔
49	"ConfirmationTokenService.CreateParamsPaymentMethodDataAffirm"
50	]
51	"""	1✔
52	If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
53	"""
54	afterpay_clearpay: NotRequired[	1✔
55	"ConfirmationTokenService.CreateParamsPaymentMethodDataAfterpayClearpay"
56	]
57	"""	1✔
58	If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
59	"""
60	alipay: NotRequired[	1✔
61	"ConfirmationTokenService.CreateParamsPaymentMethodDataAlipay"
62	]
63	"""	1✔
64	If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
65	"""
66	au_becs_debit: NotRequired[	1✔
67	"ConfirmationTokenService.CreateParamsPaymentMethodDataAuBecsDebit"
68	]
69	"""	1✔
70	If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
71	"""
72	bacs_debit: NotRequired[	1✔
73	"ConfirmationTokenService.CreateParamsPaymentMethodDataBacsDebit"
74	]
75	"""	1✔
76	If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
77	"""
78	bancontact: NotRequired[	1✔
79	"ConfirmationTokenService.CreateParamsPaymentMethodDataBancontact"
80	]
81	"""	1✔
82	If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
83	"""
84	billing_details: NotRequired[	1✔
85	"ConfirmationTokenService.CreateParamsPaymentMethodDataBillingDetails"
86	]
87	"""	1✔
88	Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
89	"""
90	blik: NotRequired[	1✔
91	"ConfirmationTokenService.CreateParamsPaymentMethodDataBlik"
92	]
93	"""	1✔
94	If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
95	"""
96	boleto: NotRequired[	1✔
97	"ConfirmationTokenService.CreateParamsPaymentMethodDataBoleto"
98	]
99	"""	1✔
100	If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
101	"""
102	cashapp: NotRequired[	1✔
103	"ConfirmationTokenService.CreateParamsPaymentMethodDataCashapp"
104	]
105	"""	1✔
106	If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
107	"""
108	customer_balance: NotRequired[	1✔
109	"ConfirmationTokenService.CreateParamsPaymentMethodDataCustomerBalance"
110	]
111	"""	1✔
112	If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
113	"""
114	eps: NotRequired[	1✔
115	"ConfirmationTokenService.CreateParamsPaymentMethodDataEps"
116	]
117	"""	1✔
118	If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
119	"""
120	fpx: NotRequired[	1✔
121	"ConfirmationTokenService.CreateParamsPaymentMethodDataFpx"
122	]
123	"""	1✔
124	If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
125	"""
126	giropay: NotRequired[	1✔
127	"ConfirmationTokenService.CreateParamsPaymentMethodDataGiropay"
128	]
129	"""	1✔
130	If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
131	"""
132	grabpay: NotRequired[	1✔
133	"ConfirmationTokenService.CreateParamsPaymentMethodDataGrabpay"
134	]
135	"""	1✔
136	If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
137	"""
138	ideal: NotRequired[	1✔
139	"ConfirmationTokenService.CreateParamsPaymentMethodDataIdeal"
140	]
141	"""	1✔
142	If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
143	"""
144	interac_present: NotRequired[	1✔
145	"ConfirmationTokenService.CreateParamsPaymentMethodDataInteracPresent"
146	]
147	"""	1✔
148	If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
149	"""
150	klarna: NotRequired[	1✔
151	"ConfirmationTokenService.CreateParamsPaymentMethodDataKlarna"
152	]
153	"""	1✔
154	If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
155	"""
156	konbini: NotRequired[	1✔
157	"ConfirmationTokenService.CreateParamsPaymentMethodDataKonbini"
158	]
159	"""	1✔
160	If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
161	"""
162	link: NotRequired[	1✔
163	"ConfirmationTokenService.CreateParamsPaymentMethodDataLink"
164	]
165	"""	1✔
166	If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
167	"""
168	metadata: NotRequired["Dict[str, str]"]	1✔
169	"""	1✔
170	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`.
171	"""
172	oxxo: NotRequired[	1✔
173	"ConfirmationTokenService.CreateParamsPaymentMethodDataOxxo"
174	]
175	"""	1✔
176	If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
177	"""
178	p24: NotRequired[	1✔
179	"ConfirmationTokenService.CreateParamsPaymentMethodDataP24"
180	]
181	"""	1✔
182	If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
183	"""
184	paynow: NotRequired[	1✔
185	"ConfirmationTokenService.CreateParamsPaymentMethodDataPaynow"
186	]
187	"""	1✔
188	If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
189	"""
190	paypal: NotRequired[	1✔
191	"ConfirmationTokenService.CreateParamsPaymentMethodDataPaypal"
192	]
193	"""	1✔
194	If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
195	"""
196	pix: NotRequired[	1✔
197	"ConfirmationTokenService.CreateParamsPaymentMethodDataPix"
198	]
199	"""	1✔
200	If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
201	"""
202	promptpay: NotRequired[	1✔
203	"ConfirmationTokenService.CreateParamsPaymentMethodDataPromptpay"
204	]
205	"""	1✔
206	If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
207	"""
208	radar_options: NotRequired[	1✔
209	"ConfirmationTokenService.CreateParamsPaymentMethodDataRadarOptions"
210	]
211	"""	1✔
212	Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
213	"""
214	revolut_pay: NotRequired[	1✔
215	"ConfirmationTokenService.CreateParamsPaymentMethodDataRevolutPay"
216	]
217	"""	1✔
218	If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
219	"""
220	sepa_debit: NotRequired[	1✔
221	"ConfirmationTokenService.CreateParamsPaymentMethodDataSepaDebit"
222	]
223	"""	1✔
224	If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
225	"""
226	sofort: NotRequired[	1✔
227	"ConfirmationTokenService.CreateParamsPaymentMethodDataSofort"
228	]
229	"""	1✔
230	If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
231	"""
232	swish: NotRequired[	1✔
233	"ConfirmationTokenService.CreateParamsPaymentMethodDataSwish"
234	]
235	"""	1✔
236	If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
237	"""
238	type: Literal[	1✔
239	"acss_debit",
240	"affirm",
241	"afterpay_clearpay",
242	"alipay",
243	"au_becs_debit",
244	"bacs_debit",
245	"bancontact",
246	"blik",
247	"boleto",
248	"cashapp",
249	"customer_balance",
250	"eps",
251	"fpx",
252	"giropay",
253	"grabpay",
254	"ideal",
255	"klarna",
256	"konbini",
257	"link",
258	"oxxo",
259	"p24",
260	"paynow",
261	"paypal",
262	"pix",
263	"promptpay",
264	"revolut_pay",
265	"sepa_debit",
266	"sofort",
267	"swish",
268	"us_bank_account",
269	"wechat_pay",
270	"zip",
271	]
272	"""	1✔
273	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.
274	"""
275	us_bank_account: NotRequired[	1✔
276	"ConfirmationTokenService.CreateParamsPaymentMethodDataUsBankAccount"
277	]
278	"""	1✔
279	If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
280	"""
281	wechat_pay: NotRequired[	1✔
282	"ConfirmationTokenService.CreateParamsPaymentMethodDataWechatPay"
283	]
284	"""	1✔
285	If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
286	"""
287	zip: NotRequired[	1✔
288	"ConfirmationTokenService.CreateParamsPaymentMethodDataZip"
289	]
290	"""	1✔
291	If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
292	"""
293
294	class CreateParamsPaymentMethodDataAcssDebit(TypedDict):	1✔
295	account_number: str	1✔
296	"""	1✔
297	Customer's bank account number.
298	"""
299	institution_number: str	1✔
300	"""	1✔
301	Institution number of the customer's bank.
302	"""
303	transit_number: str	1✔
304	"""	1✔
305	Transit number of the customer's bank.
306	"""
307
308	class CreateParamsPaymentMethodDataAffirm(TypedDict):	1✔
309	pass	1✔
310
311	class CreateParamsPaymentMethodDataAfterpayClearpay(TypedDict):	1✔
312	pass	1✔
313
314	class CreateParamsPaymentMethodDataAlipay(TypedDict):	1✔
315	pass	1✔
316
317	class CreateParamsPaymentMethodDataAuBecsDebit(TypedDict):	1✔
318	account_number: str	1✔
319	"""	1✔
320	The account number for the bank account.
321	"""
322	bsb_number: str	1✔
323	"""	1✔
324	Bank-State-Branch number of the bank account.
325	"""
326
327	class CreateParamsPaymentMethodDataBacsDebit(TypedDict):	1✔
328	account_number: NotRequired["str"]	1✔
329	"""	1✔
330	Account number of the bank account that the funds will be debited from.
331	"""
332	sort_code: NotRequired["str"]	1✔
333	"""	1✔
334	Sort code of the bank account. (e.g., `10-20-30`)
335	"""
336
337	class CreateParamsPaymentMethodDataBancontact(TypedDict):	1✔
338	pass	1✔
339
340	class CreateParamsPaymentMethodDataBillingDetails(TypedDict):	1✔
341	address: NotRequired[	1✔
342	"Literal['']\|ConfirmationTokenService.CreateParamsPaymentMethodDataBillingDetailsAddress"
343	]
344	"""	1✔
345	Billing address.
346	"""
347	email: NotRequired["Literal['']\|str"]	1✔
348	"""	1✔
349	Email address.
350	"""
351	name: NotRequired["Literal['']\|str"]	1✔
352	"""	1✔
353	Full name.
354	"""
355	phone: NotRequired["Literal['']\|str"]	1✔
356	"""	1✔
357	Billing phone number (including extension).
358	"""
359
360	class CreateParamsPaymentMethodDataBillingDetailsAddress(TypedDict):	1✔
361	city: NotRequired["str"]	1✔
362	"""	1✔
363	City, district, suburb, town, or village.
364	"""
365	country: NotRequired["str"]	1✔
366	"""	1✔
367	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
368	"""
369	line1: NotRequired["str"]	1✔
370	"""	1✔
371	Address line 1 (e.g., street, PO Box, or company name).
372	"""
373	line2: NotRequired["str"]	1✔
374	"""	1✔
375	Address line 2 (e.g., apartment, suite, unit, or building).
376	"""
377	postal_code: NotRequired["str"]	1✔
378	"""	1✔
379	ZIP or postal code.
380	"""
381	state: NotRequired["str"]	1✔
382	"""	1✔
383	State, county, province, or region.
384	"""
385
386	class CreateParamsPaymentMethodDataBlik(TypedDict):	1✔
387	pass	1✔
388
389	class CreateParamsPaymentMethodDataBoleto(TypedDict):	1✔
390	tax_id: str	1✔
391	"""	1✔
392	The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
393	"""
394
395	class CreateParamsPaymentMethodDataCashapp(TypedDict):	1✔
396	pass	1✔
397
398	class CreateParamsPaymentMethodDataCustomerBalance(TypedDict):	1✔
399	pass	1✔
400
401	class CreateParamsPaymentMethodDataEps(TypedDict):	1✔
402	bank: NotRequired[	1✔
403	"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']"
404	]
405	"""	1✔
406	The customer's bank.
407	"""
408
409	class CreateParamsPaymentMethodDataFpx(TypedDict):	1✔
410	account_holder_type: NotRequired["Literal['company', 'individual']"]	1✔
411	"""	1✔
412	Account holder type for FPX transaction
413	"""
414	bank: Literal[	1✔
415	"affin_bank",
416	"agrobank",
417	"alliance_bank",
418	"ambank",
419	"bank_islam",
420	"bank_muamalat",
421	"bank_of_china",
422	"bank_rakyat",
423	"bsn",
424	"cimb",
425	"deutsche_bank",
426	"hong_leong_bank",
427	"hsbc",
428	"kfh",
429	"maybank2e",
430	"maybank2u",
431	"ocbc",
432	"pb_enterprise",
433	"public_bank",
434	"rhb",
435	"standard_chartered",
436	"uob",
437	]
438	"""	1✔
439	The customer's bank.
440	"""
441
442	class CreateParamsPaymentMethodDataGiropay(TypedDict):	1✔
443	pass	1✔
444
445	class CreateParamsPaymentMethodDataGrabpay(TypedDict):	1✔
446	pass	1✔
447
448	class CreateParamsPaymentMethodDataIdeal(TypedDict):	1✔
449	bank: NotRequired[	1✔
450	"Literal['abn_amro', 'asn_bank', 'bunq', 'handelsbanken', 'ing', 'knab', 'moneyou', 'n26', 'nn', 'rabobank', 'regiobank', 'revolut', 'sns_bank', 'triodos_bank', 'van_lanschot', 'yoursafe']"
451	]
452	"""	1✔
453	The customer's bank.
454	"""
455
456	class CreateParamsPaymentMethodDataInteracPresent(TypedDict):	1✔
457	pass	1✔
458
459	class CreateParamsPaymentMethodDataKlarna(TypedDict):	1✔
460	dob: NotRequired[	1✔
461	"ConfirmationTokenService.CreateParamsPaymentMethodDataKlarnaDob"
462	]
463	"""	1✔
464	Customer's date of birth
465	"""
466
467	class CreateParamsPaymentMethodDataKlarnaDob(TypedDict):	1✔
468	day: int	1✔
469	"""	1✔
470	The day of birth, between 1 and 31.
471	"""
472	month: int	1✔
473	"""	1✔
474	The month of birth, between 1 and 12.
475	"""
476	year: int	1✔
477	"""	1✔
478	The four-digit year of birth.
479	"""
480
481	class CreateParamsPaymentMethodDataKonbini(TypedDict):	1✔
482	pass	1✔
483
484	class CreateParamsPaymentMethodDataLink(TypedDict):	1✔
485	pass	1✔
486
487	class CreateParamsPaymentMethodDataOxxo(TypedDict):	1✔
488	pass	1✔
489
490	class CreateParamsPaymentMethodDataP24(TypedDict):	1✔
491	bank: NotRequired[	1✔
492	"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', 'velobank', 'volkswagen_bank']"
493	]
494	"""	1✔
495	The customer's bank.
496	"""
497
498	class CreateParamsPaymentMethodDataPaynow(TypedDict):	1✔
499	pass	1✔
500
501	class CreateParamsPaymentMethodDataPaypal(TypedDict):	1✔
502	pass	1✔
503
504	class CreateParamsPaymentMethodDataPix(TypedDict):	1✔
505	pass	1✔
506
507	class CreateParamsPaymentMethodDataPromptpay(TypedDict):	1✔
508	pass	1✔
509
510	class CreateParamsPaymentMethodDataRadarOptions(TypedDict):	1✔
511	session: NotRequired["str"]	1✔
512	"""	1✔
513	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.
514	"""
515
516	class CreateParamsPaymentMethodDataRevolutPay(TypedDict):	1✔
517	pass	1✔
518
519	class CreateParamsPaymentMethodDataSepaDebit(TypedDict):	1✔
520	iban: str	1✔
521	"""	1✔
522	IBAN of the bank account.
523	"""
524
525	class CreateParamsPaymentMethodDataSofort(TypedDict):	1✔
526	country: Literal["AT", "BE", "DE", "ES", "IT", "NL"]	1✔
527	"""	1✔
528	Two-letter ISO code representing the country the bank account is located in.
529	"""
530
531	class CreateParamsPaymentMethodDataSwish(TypedDict):	1✔
532	pass	1✔
533
534	class CreateParamsPaymentMethodDataUsBankAccount(TypedDict):	1✔
535	account_holder_type: NotRequired["Literal['company', 'individual']"]	1✔
536	"""	1✔
537	Account holder type: individual or company.
538	"""
539	account_number: NotRequired["str"]	1✔
540	"""	1✔
541	Account number of the bank account.
542	"""
543	account_type: NotRequired["Literal['checking', 'savings']"]	1✔
544	"""	1✔
545	Account type: checkings or savings. Defaults to checking if omitted.
546	"""
547	financial_connections_account: NotRequired["str"]	1✔
548	"""	1✔
549	The ID of a Financial Connections Account to use as a payment method.
550	"""
551	routing_number: NotRequired["str"]	1✔
552	"""	1✔
553	Routing number of the bank account.
554	"""
555
556	class CreateParamsPaymentMethodDataWechatPay(TypedDict):	1✔
557	pass	1✔
558
559	class CreateParamsPaymentMethodDataZip(TypedDict):	1✔
560	pass	1✔
561
562	class CreateParamsShipping(TypedDict):	1✔
563	address: "ConfirmationTokenService.CreateParamsShippingAddress"	1✔
564	"""	1✔
565	Shipping address
566	"""
567	name: str	1✔
568	"""	1✔
569	Recipient name.
570	"""
571	phone: NotRequired["Literal['']\|str"]	1✔
572	"""	1✔
573	Recipient phone (including extension)
574	"""
575
576	class CreateParamsShippingAddress(TypedDict):	1✔
577	city: NotRequired["str"]	1✔
578	"""	1✔
579	City, district, suburb, town, or village.
580	"""
581	country: NotRequired["str"]	1✔
582	"""	1✔
583	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
584	"""
585	line1: NotRequired["str"]	1✔
586	"""	1✔
587	Address line 1 (e.g., street, PO Box, or company name).
588	"""
589	line2: NotRequired["str"]	1✔
590	"""	1✔
591	Address line 2 (e.g., apartment, suite, unit, or building).
592	"""
593	postal_code: NotRequired["str"]	1✔
594	"""	1✔
595	ZIP or postal code.
596	"""
597	state: NotRequired["str"]	1✔
598	"""	1✔
599	State, county, province, or region.
600	"""
601
602	def create(	1✔
603	self,
604	params: "ConfirmationTokenService.CreateParams" = {},
605	options: RequestOptions = {},
606	) -> ConfirmationToken:
607	"""
608	Creates a test mode Confirmation Token server side for your integration tests.
609	"""
NEW 610	return cast(	×
611	ConfirmationToken,
612	self._request(
613	"post",
614	"/v1/test_helpers/confirmation_tokens",
615	api_mode="V1",
616	base_address="api",
617	params=params,
618	options=options,
619	),
620	)

stripe / stripe-python / 8378962062

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous