This commit is contained in:
Iliyan Angelov
2025-11-17 18:26:30 +02:00
parent 48353cde9c
commit 0c59fe1173
2535 changed files with 278997 additions and 2480 deletions

View File

@@ -0,0 +1,389 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.test_helpers import (
issuing as issuing,
terminal as terminal,
treasury as treasury,
)
from stripe.params.test_helpers._confirmation_token_create_params import (
ConfirmationTokenCreateParams as ConfirmationTokenCreateParams,
ConfirmationTokenCreateParamsPaymentMethodData as ConfirmationTokenCreateParamsPaymentMethodData,
ConfirmationTokenCreateParamsPaymentMethodDataAcssDebit as ConfirmationTokenCreateParamsPaymentMethodDataAcssDebit,
ConfirmationTokenCreateParamsPaymentMethodDataAffirm as ConfirmationTokenCreateParamsPaymentMethodDataAffirm,
ConfirmationTokenCreateParamsPaymentMethodDataAfterpayClearpay as ConfirmationTokenCreateParamsPaymentMethodDataAfterpayClearpay,
ConfirmationTokenCreateParamsPaymentMethodDataAlipay as ConfirmationTokenCreateParamsPaymentMethodDataAlipay,
ConfirmationTokenCreateParamsPaymentMethodDataAlma as ConfirmationTokenCreateParamsPaymentMethodDataAlma,
ConfirmationTokenCreateParamsPaymentMethodDataAmazonPay as ConfirmationTokenCreateParamsPaymentMethodDataAmazonPay,
ConfirmationTokenCreateParamsPaymentMethodDataAuBecsDebit as ConfirmationTokenCreateParamsPaymentMethodDataAuBecsDebit,
ConfirmationTokenCreateParamsPaymentMethodDataBacsDebit as ConfirmationTokenCreateParamsPaymentMethodDataBacsDebit,
ConfirmationTokenCreateParamsPaymentMethodDataBancontact as ConfirmationTokenCreateParamsPaymentMethodDataBancontact,
ConfirmationTokenCreateParamsPaymentMethodDataBillie as ConfirmationTokenCreateParamsPaymentMethodDataBillie,
ConfirmationTokenCreateParamsPaymentMethodDataBillingDetails as ConfirmationTokenCreateParamsPaymentMethodDataBillingDetails,
ConfirmationTokenCreateParamsPaymentMethodDataBillingDetailsAddress as ConfirmationTokenCreateParamsPaymentMethodDataBillingDetailsAddress,
ConfirmationTokenCreateParamsPaymentMethodDataBlik as ConfirmationTokenCreateParamsPaymentMethodDataBlik,
ConfirmationTokenCreateParamsPaymentMethodDataBoleto as ConfirmationTokenCreateParamsPaymentMethodDataBoleto,
ConfirmationTokenCreateParamsPaymentMethodDataCashapp as ConfirmationTokenCreateParamsPaymentMethodDataCashapp,
ConfirmationTokenCreateParamsPaymentMethodDataCrypto as ConfirmationTokenCreateParamsPaymentMethodDataCrypto,
ConfirmationTokenCreateParamsPaymentMethodDataCustomerBalance as ConfirmationTokenCreateParamsPaymentMethodDataCustomerBalance,
ConfirmationTokenCreateParamsPaymentMethodDataEps as ConfirmationTokenCreateParamsPaymentMethodDataEps,
ConfirmationTokenCreateParamsPaymentMethodDataFpx as ConfirmationTokenCreateParamsPaymentMethodDataFpx,
ConfirmationTokenCreateParamsPaymentMethodDataGiropay as ConfirmationTokenCreateParamsPaymentMethodDataGiropay,
ConfirmationTokenCreateParamsPaymentMethodDataGrabpay as ConfirmationTokenCreateParamsPaymentMethodDataGrabpay,
ConfirmationTokenCreateParamsPaymentMethodDataIdeal as ConfirmationTokenCreateParamsPaymentMethodDataIdeal,
ConfirmationTokenCreateParamsPaymentMethodDataInteracPresent as ConfirmationTokenCreateParamsPaymentMethodDataInteracPresent,
ConfirmationTokenCreateParamsPaymentMethodDataKakaoPay as ConfirmationTokenCreateParamsPaymentMethodDataKakaoPay,
ConfirmationTokenCreateParamsPaymentMethodDataKlarna as ConfirmationTokenCreateParamsPaymentMethodDataKlarna,
ConfirmationTokenCreateParamsPaymentMethodDataKlarnaDob as ConfirmationTokenCreateParamsPaymentMethodDataKlarnaDob,
ConfirmationTokenCreateParamsPaymentMethodDataKonbini as ConfirmationTokenCreateParamsPaymentMethodDataKonbini,
ConfirmationTokenCreateParamsPaymentMethodDataKrCard as ConfirmationTokenCreateParamsPaymentMethodDataKrCard,
ConfirmationTokenCreateParamsPaymentMethodDataLink as ConfirmationTokenCreateParamsPaymentMethodDataLink,
ConfirmationTokenCreateParamsPaymentMethodDataMbWay as ConfirmationTokenCreateParamsPaymentMethodDataMbWay,
ConfirmationTokenCreateParamsPaymentMethodDataMobilepay as ConfirmationTokenCreateParamsPaymentMethodDataMobilepay,
ConfirmationTokenCreateParamsPaymentMethodDataMultibanco as ConfirmationTokenCreateParamsPaymentMethodDataMultibanco,
ConfirmationTokenCreateParamsPaymentMethodDataNaverPay as ConfirmationTokenCreateParamsPaymentMethodDataNaverPay,
ConfirmationTokenCreateParamsPaymentMethodDataNzBankAccount as ConfirmationTokenCreateParamsPaymentMethodDataNzBankAccount,
ConfirmationTokenCreateParamsPaymentMethodDataOxxo as ConfirmationTokenCreateParamsPaymentMethodDataOxxo,
ConfirmationTokenCreateParamsPaymentMethodDataP24 as ConfirmationTokenCreateParamsPaymentMethodDataP24,
ConfirmationTokenCreateParamsPaymentMethodDataPayByBank as ConfirmationTokenCreateParamsPaymentMethodDataPayByBank,
ConfirmationTokenCreateParamsPaymentMethodDataPayco as ConfirmationTokenCreateParamsPaymentMethodDataPayco,
ConfirmationTokenCreateParamsPaymentMethodDataPaynow as ConfirmationTokenCreateParamsPaymentMethodDataPaynow,
ConfirmationTokenCreateParamsPaymentMethodDataPaypal as ConfirmationTokenCreateParamsPaymentMethodDataPaypal,
ConfirmationTokenCreateParamsPaymentMethodDataPix as ConfirmationTokenCreateParamsPaymentMethodDataPix,
ConfirmationTokenCreateParamsPaymentMethodDataPromptpay as ConfirmationTokenCreateParamsPaymentMethodDataPromptpay,
ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions as ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions,
ConfirmationTokenCreateParamsPaymentMethodDataRevolutPay as ConfirmationTokenCreateParamsPaymentMethodDataRevolutPay,
ConfirmationTokenCreateParamsPaymentMethodDataSamsungPay as ConfirmationTokenCreateParamsPaymentMethodDataSamsungPay,
ConfirmationTokenCreateParamsPaymentMethodDataSatispay as ConfirmationTokenCreateParamsPaymentMethodDataSatispay,
ConfirmationTokenCreateParamsPaymentMethodDataSepaDebit as ConfirmationTokenCreateParamsPaymentMethodDataSepaDebit,
ConfirmationTokenCreateParamsPaymentMethodDataSofort as ConfirmationTokenCreateParamsPaymentMethodDataSofort,
ConfirmationTokenCreateParamsPaymentMethodDataSwish as ConfirmationTokenCreateParamsPaymentMethodDataSwish,
ConfirmationTokenCreateParamsPaymentMethodDataTwint as ConfirmationTokenCreateParamsPaymentMethodDataTwint,
ConfirmationTokenCreateParamsPaymentMethodDataUsBankAccount as ConfirmationTokenCreateParamsPaymentMethodDataUsBankAccount,
ConfirmationTokenCreateParamsPaymentMethodDataWechatPay as ConfirmationTokenCreateParamsPaymentMethodDataWechatPay,
ConfirmationTokenCreateParamsPaymentMethodDataZip as ConfirmationTokenCreateParamsPaymentMethodDataZip,
ConfirmationTokenCreateParamsPaymentMethodOptions as ConfirmationTokenCreateParamsPaymentMethodOptions,
ConfirmationTokenCreateParamsPaymentMethodOptionsCard as ConfirmationTokenCreateParamsPaymentMethodOptionsCard,
ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallments as ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallments,
ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallmentsPlan as ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallmentsPlan,
ConfirmationTokenCreateParamsShipping as ConfirmationTokenCreateParamsShipping,
ConfirmationTokenCreateParamsShippingAddress as ConfirmationTokenCreateParamsShippingAddress,
)
from stripe.params.test_helpers._customer_fund_cash_balance_params import (
CustomerFundCashBalanceParams as CustomerFundCashBalanceParams,
)
from stripe.params.test_helpers._refund_expire_params import (
RefundExpireParams as RefundExpireParams,
)
from stripe.params.test_helpers._test_clock_advance_params import (
TestClockAdvanceParams as TestClockAdvanceParams,
)
from stripe.params.test_helpers._test_clock_create_params import (
TestClockCreateParams as TestClockCreateParams,
)
from stripe.params.test_helpers._test_clock_delete_params import (
TestClockDeleteParams as TestClockDeleteParams,
)
from stripe.params.test_helpers._test_clock_list_params import (
TestClockListParams as TestClockListParams,
)
from stripe.params.test_helpers._test_clock_retrieve_params import (
TestClockRetrieveParams as TestClockRetrieveParams,
)
# name -> (import_target, is_submodule)
_import_map = {
"issuing": ("stripe.params.test_helpers.issuing", True),
"terminal": ("stripe.params.test_helpers.terminal", True),
"treasury": ("stripe.params.test_helpers.treasury", True),
"ConfirmationTokenCreateParams": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodData": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataAcssDebit": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataAffirm": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataAfterpayClearpay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataAlipay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataAlma": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataAmazonPay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataAuBecsDebit": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataBacsDebit": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataBancontact": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataBillie": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataBillingDetails": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataBillingDetailsAddress": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataBlik": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataBoleto": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataCashapp": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataCrypto": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataCustomerBalance": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataEps": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataFpx": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataGiropay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataGrabpay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataIdeal": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataInteracPresent": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataKakaoPay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataKlarna": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataKlarnaDob": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataKonbini": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataKrCard": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataLink": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataMbWay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataMobilepay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataMultibanco": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataNaverPay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataNzBankAccount": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataOxxo": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataP24": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataPayByBank": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataPayco": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataPaynow": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataPaypal": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataPix": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataPromptpay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataRevolutPay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataSamsungPay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataSatispay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataSepaDebit": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataSofort": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataSwish": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataTwint": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataUsBankAccount": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataWechatPay": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodDataZip": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodOptions": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodOptionsCard": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallments": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallmentsPlan": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsShipping": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"ConfirmationTokenCreateParamsShippingAddress": (
"stripe.params.test_helpers._confirmation_token_create_params",
False,
),
"CustomerFundCashBalanceParams": (
"stripe.params.test_helpers._customer_fund_cash_balance_params",
False,
),
"RefundExpireParams": (
"stripe.params.test_helpers._refund_expire_params",
False,
),
"TestClockAdvanceParams": (
"stripe.params.test_helpers._test_clock_advance_params",
False,
),
"TestClockCreateParams": (
"stripe.params.test_helpers._test_clock_create_params",
False,
),
"TestClockDeleteParams": (
"stripe.params.test_helpers._test_clock_delete_params",
False,
),
"TestClockListParams": (
"stripe.params.test_helpers._test_clock_list_params",
False,
),
"TestClockRetrieveParams": (
"stripe.params.test_helpers._test_clock_retrieve_params",
False,
),
}
if not TYPE_CHECKING:
def __getattr__(name):
try:
target, is_submodule = _import_map[name]
module = import_module(target)
if is_submodule:
return module
return getattr(
module,
name,
)
except KeyError:
raise AttributeError()

View File

@@ -0,0 +1,925 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import Dict, List
from typing_extensions import Literal, NotRequired, TypedDict
class ConfirmationTokenCreateParams(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[
"ConfirmationTokenCreateParamsPaymentMethodData"
]
"""
If provided, this hash will be used to create a PaymentMethod.
"""
payment_method_options: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodOptions"
]
"""
Payment-method-specific configuration for this ConfirmationToken.
"""
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["ConfirmationTokenCreateParamsShipping"]
"""
Shipping information for this ConfirmationToken.
"""
class ConfirmationTokenCreateParamsPaymentMethodData(TypedDict):
acss_debit: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataAcssDebit"
]
"""
If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
"""
affirm: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataAffirm"]
"""
If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
"""
afterpay_clearpay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataAfterpayClearpay"
]
"""
If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
"""
alipay: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataAlipay"]
"""
If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
"""
allow_redisplay: NotRequired[Literal["always", "limited", "unspecified"]]
"""
This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
"""
alma: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataAlma"]
"""
If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
"""
amazon_pay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataAmazonPay"
]
"""
If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
"""
au_becs_debit: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataAuBecsDebit"
]
"""
If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
"""
bacs_debit: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataBacsDebit"
]
"""
If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
"""
bancontact: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataBancontact"
]
"""
If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
"""
billie: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataBillie"]
"""
If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
"""
billing_details: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataBillingDetails"
]
"""
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
"""
blik: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataBlik"]
"""
If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
"""
boleto: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataBoleto"]
"""
If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
"""
cashapp: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataCashapp"
]
"""
If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
"""
crypto: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataCrypto"]
"""
If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
"""
customer_balance: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataCustomerBalance"
]
"""
If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
"""
eps: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataEps"]
"""
If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
"""
fpx: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataFpx"]
"""
If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
"""
giropay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataGiropay"
]
"""
If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
"""
grabpay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataGrabpay"
]
"""
If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
"""
ideal: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataIdeal"]
"""
If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
"""
interac_present: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataInteracPresent"
]
"""
If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
"""
kakao_pay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataKakaoPay"
]
"""
If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
"""
klarna: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataKlarna"]
"""
If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
"""
konbini: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataKonbini"
]
"""
If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
"""
kr_card: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataKrCard"
]
"""
If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
"""
link: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataLink"]
"""
If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
"""
mb_way: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataMbWay"]
"""
If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY 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`.
"""
mobilepay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataMobilepay"
]
"""
If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
"""
multibanco: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataMultibanco"
]
"""
If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
"""
naver_pay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataNaverPay"
]
"""
If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
"""
nz_bank_account: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataNzBankAccount"
]
"""
If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
"""
oxxo: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataOxxo"]
"""
If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
"""
p24: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataP24"]
"""
If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
"""
pay_by_bank: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataPayByBank"
]
"""
If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
"""
payco: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataPayco"]
"""
If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
"""
paynow: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataPaynow"]
"""
If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
"""
paypal: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataPaypal"]
"""
If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
"""
pix: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataPix"]
"""
If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
"""
promptpay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataPromptpay"
]
"""
If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
"""
radar_options: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions"
]
"""
Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
"""
revolut_pay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataRevolutPay"
]
"""
If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
"""
samsung_pay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataSamsungPay"
]
"""
If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
"""
satispay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataSatispay"
]
"""
If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
"""
sepa_debit: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataSepaDebit"
]
"""
If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
"""
sofort: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataSofort"]
"""
If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
"""
swish: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataSwish"]
"""
If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
"""
twint: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataTwint"]
"""
If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
"""
type: Literal[
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"cashapp",
"crypto",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mb_way",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"swish",
"twint",
"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[
"ConfirmationTokenCreateParamsPaymentMethodDataUsBankAccount"
]
"""
If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
"""
wechat_pay: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodDataWechatPay"
]
"""
If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
"""
zip: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataZip"]
"""
If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataAcssDebit(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 ConfirmationTokenCreateParamsPaymentMethodDataAffirm(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataAfterpayClearpay(
TypedDict
):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataAlipay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataAlma(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataAmazonPay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataAuBecsDebit(TypedDict):
account_number: str
"""
The account number for the bank account.
"""
bsb_number: str
"""
Bank-State-Branch number of the bank account.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataBacsDebit(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 ConfirmationTokenCreateParamsPaymentMethodDataBancontact(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataBillie(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataBillingDetails(TypedDict):
address: NotRequired[
"Literal['']|ConfirmationTokenCreateParamsPaymentMethodDataBillingDetailsAddress"
]
"""
Billing address.
"""
email: NotRequired["Literal['']|str"]
"""
Email address.
"""
name: NotRequired["Literal['']|str"]
"""
Full name.
"""
phone: NotRequired["Literal['']|str"]
"""
Billing phone number (including extension).
"""
tax_id: NotRequired[str]
"""
Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataBillingDetailsAddress(
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, such as the street, PO Box, or company name.
"""
line2: NotRequired[str]
"""
Address line 2, such as the apartment, suite, unit, or building.
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataBlik(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataBoleto(TypedDict):
tax_id: str
"""
The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
"""
class ConfirmationTokenCreateParamsPaymentMethodDataCashapp(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataCrypto(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataCustomerBalance(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataEps(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 ConfirmationTokenCreateParamsPaymentMethodDataFpx(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 ConfirmationTokenCreateParamsPaymentMethodDataGiropay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataGrabpay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataIdeal(TypedDict):
bank: NotRequired[
Literal[
"abn_amro",
"asn_bank",
"bunq",
"buut",
"handelsbanken",
"ing",
"knab",
"moneyou",
"n26",
"nn",
"rabobank",
"regiobank",
"revolut",
"sns_bank",
"triodos_bank",
"van_lanschot",
"yoursafe",
]
]
"""
The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataInteracPresent(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataKakaoPay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataKlarna(TypedDict):
dob: NotRequired["ConfirmationTokenCreateParamsPaymentMethodDataKlarnaDob"]
"""
Customer's date of birth
"""
class ConfirmationTokenCreateParamsPaymentMethodDataKlarnaDob(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 ConfirmationTokenCreateParamsPaymentMethodDataKonbini(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataKrCard(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataLink(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataMbWay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataMobilepay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataMultibanco(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataNaverPay(TypedDict):
funding: NotRequired[Literal["card", "points"]]
"""
Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataNzBankAccount(TypedDict):
account_holder_name: NotRequired[str]
"""
The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
"""
account_number: str
"""
The account number for the bank account.
"""
bank_code: str
"""
The numeric code for the bank account's bank.
"""
branch_code: str
"""
The numeric code for the bank account's bank branch.
"""
reference: NotRequired[str]
suffix: str
"""
The suffix of the bank account number.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataOxxo(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataP24(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 ConfirmationTokenCreateParamsPaymentMethodDataPayByBank(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataPayco(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataPaynow(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataPaypal(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataPix(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataPromptpay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataRadarOptions(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 ConfirmationTokenCreateParamsPaymentMethodDataRevolutPay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataSamsungPay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataSatispay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataSepaDebit(TypedDict):
iban: str
"""
IBAN of the bank account.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataSofort(TypedDict):
country: Literal["AT", "BE", "DE", "ES", "IT", "NL"]
"""
Two-letter ISO code representing the country the bank account is located in.
"""
class ConfirmationTokenCreateParamsPaymentMethodDataSwish(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataTwint(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataUsBankAccount(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 ConfirmationTokenCreateParamsPaymentMethodDataWechatPay(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodDataZip(TypedDict):
pass
class ConfirmationTokenCreateParamsPaymentMethodOptions(TypedDict):
card: NotRequired["ConfirmationTokenCreateParamsPaymentMethodOptionsCard"]
"""
Configuration for any card payments confirmed using this ConfirmationToken.
"""
class ConfirmationTokenCreateParamsPaymentMethodOptionsCard(TypedDict):
installments: NotRequired[
"ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallments"
]
"""
Installment configuration for payments confirmed using this ConfirmationToken.
"""
class ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallments(
TypedDict,
):
plan: (
"ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallmentsPlan"
)
"""
The selected installment plan to use for this payment attempt.
This parameter can only be provided during confirmation.
"""
class ConfirmationTokenCreateParamsPaymentMethodOptionsCardInstallmentsPlan(
TypedDict,
):
count: NotRequired[int]
"""
For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
"""
interval: NotRequired[Literal["month"]]
"""
For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
One of `month`.
"""
type: Literal["bonus", "fixed_count", "revolving"]
"""
Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
"""
class ConfirmationTokenCreateParamsShipping(TypedDict):
address: "ConfirmationTokenCreateParamsShippingAddress"
"""
Shipping address
"""
name: str
"""
Recipient name.
"""
phone: NotRequired["Literal['']|str"]
"""
Recipient phone (including extension)
"""
class ConfirmationTokenCreateParamsShippingAddress(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, such as the street, PO Box, or company name.
"""
line2: NotRequired[str]
"""
Address line 2, such as the apartment, suite, unit, or building.
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""

View File

@@ -0,0 +1,23 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class CustomerFundCashBalanceParams(TypedDict):
amount: int
"""
Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
"""
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).
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
reference: NotRequired[str]
"""
A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class RefundExpireParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,16 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from typing import List
from typing_extensions import NotRequired
class TestClockAdvanceParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
frozen_time: int
"""
The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.
"""

View File

@@ -0,0 +1,20 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from typing import List
from typing_extensions import NotRequired
class TestClockCreateParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
frozen_time: int
"""
The initial frozen time for this test clock.
"""
name: NotRequired[str]
"""
The name for this test clock.
"""

View File

@@ -0,0 +1,7 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
class TestClockDeleteParams(RequestOptions):
pass

View File

@@ -0,0 +1,24 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from typing import List
from typing_extensions import NotRequired
class TestClockListParams(RequestOptions):
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.
"""
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.
"""

View File

@@ -0,0 +1,12 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from typing import List
from typing_extensions import NotRequired
class TestClockRetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,461 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.test_helpers.issuing._authorization_capture_params import (
AuthorizationCaptureParams as AuthorizationCaptureParams,
AuthorizationCaptureParamsPurchaseDetails as AuthorizationCaptureParamsPurchaseDetails,
AuthorizationCaptureParamsPurchaseDetailsFleet as AuthorizationCaptureParamsPurchaseDetailsFleet,
AuthorizationCaptureParamsPurchaseDetailsFleetCardholderPromptData as AuthorizationCaptureParamsPurchaseDetailsFleetCardholderPromptData,
AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdown as AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdown,
AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel as AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel,
AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel as AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel,
AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownTax as AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownTax,
AuthorizationCaptureParamsPurchaseDetailsFlight as AuthorizationCaptureParamsPurchaseDetailsFlight,
AuthorizationCaptureParamsPurchaseDetailsFlightSegment as AuthorizationCaptureParamsPurchaseDetailsFlightSegment,
AuthorizationCaptureParamsPurchaseDetailsFuel as AuthorizationCaptureParamsPurchaseDetailsFuel,
AuthorizationCaptureParamsPurchaseDetailsLodging as AuthorizationCaptureParamsPurchaseDetailsLodging,
AuthorizationCaptureParamsPurchaseDetailsReceipt as AuthorizationCaptureParamsPurchaseDetailsReceipt,
)
from stripe.params.test_helpers.issuing._authorization_create_params import (
AuthorizationCreateParams as AuthorizationCreateParams,
AuthorizationCreateParamsAmountDetails as AuthorizationCreateParamsAmountDetails,
AuthorizationCreateParamsFleet as AuthorizationCreateParamsFleet,
AuthorizationCreateParamsFleetCardholderPromptData as AuthorizationCreateParamsFleetCardholderPromptData,
AuthorizationCreateParamsFleetReportedBreakdown as AuthorizationCreateParamsFleetReportedBreakdown,
AuthorizationCreateParamsFleetReportedBreakdownFuel as AuthorizationCreateParamsFleetReportedBreakdownFuel,
AuthorizationCreateParamsFleetReportedBreakdownNonFuel as AuthorizationCreateParamsFleetReportedBreakdownNonFuel,
AuthorizationCreateParamsFleetReportedBreakdownTax as AuthorizationCreateParamsFleetReportedBreakdownTax,
AuthorizationCreateParamsFuel as AuthorizationCreateParamsFuel,
AuthorizationCreateParamsMerchantData as AuthorizationCreateParamsMerchantData,
AuthorizationCreateParamsNetworkData as AuthorizationCreateParamsNetworkData,
AuthorizationCreateParamsRiskAssessment as AuthorizationCreateParamsRiskAssessment,
AuthorizationCreateParamsRiskAssessmentCardTestingRisk as AuthorizationCreateParamsRiskAssessmentCardTestingRisk,
AuthorizationCreateParamsRiskAssessmentMerchantDisputeRisk as AuthorizationCreateParamsRiskAssessmentMerchantDisputeRisk,
AuthorizationCreateParamsVerificationData as AuthorizationCreateParamsVerificationData,
AuthorizationCreateParamsVerificationDataAuthenticationExemption as AuthorizationCreateParamsVerificationDataAuthenticationExemption,
AuthorizationCreateParamsVerificationDataThreeDSecure as AuthorizationCreateParamsVerificationDataThreeDSecure,
)
from stripe.params.test_helpers.issuing._authorization_expire_params import (
AuthorizationExpireParams as AuthorizationExpireParams,
)
from stripe.params.test_helpers.issuing._authorization_finalize_amount_params import (
AuthorizationFinalizeAmountParams as AuthorizationFinalizeAmountParams,
AuthorizationFinalizeAmountParamsFleet as AuthorizationFinalizeAmountParamsFleet,
AuthorizationFinalizeAmountParamsFleetCardholderPromptData as AuthorizationFinalizeAmountParamsFleetCardholderPromptData,
AuthorizationFinalizeAmountParamsFleetReportedBreakdown as AuthorizationFinalizeAmountParamsFleetReportedBreakdown,
AuthorizationFinalizeAmountParamsFleetReportedBreakdownFuel as AuthorizationFinalizeAmountParamsFleetReportedBreakdownFuel,
AuthorizationFinalizeAmountParamsFleetReportedBreakdownNonFuel as AuthorizationFinalizeAmountParamsFleetReportedBreakdownNonFuel,
AuthorizationFinalizeAmountParamsFleetReportedBreakdownTax as AuthorizationFinalizeAmountParamsFleetReportedBreakdownTax,
AuthorizationFinalizeAmountParamsFuel as AuthorizationFinalizeAmountParamsFuel,
)
from stripe.params.test_helpers.issuing._authorization_increment_params import (
AuthorizationIncrementParams as AuthorizationIncrementParams,
)
from stripe.params.test_helpers.issuing._authorization_respond_params import (
AuthorizationRespondParams as AuthorizationRespondParams,
)
from stripe.params.test_helpers.issuing._authorization_reverse_params import (
AuthorizationReverseParams as AuthorizationReverseParams,
)
from stripe.params.test_helpers.issuing._card_deliver_card_params import (
CardDeliverCardParams as CardDeliverCardParams,
)
from stripe.params.test_helpers.issuing._card_fail_card_params import (
CardFailCardParams as CardFailCardParams,
)
from stripe.params.test_helpers.issuing._card_return_card_params import (
CardReturnCardParams as CardReturnCardParams,
)
from stripe.params.test_helpers.issuing._card_ship_card_params import (
CardShipCardParams as CardShipCardParams,
)
from stripe.params.test_helpers.issuing._card_submit_card_params import (
CardSubmitCardParams as CardSubmitCardParams,
)
from stripe.params.test_helpers.issuing._personalization_design_activate_params import (
PersonalizationDesignActivateParams as PersonalizationDesignActivateParams,
)
from stripe.params.test_helpers.issuing._personalization_design_deactivate_params import (
PersonalizationDesignDeactivateParams as PersonalizationDesignDeactivateParams,
)
from stripe.params.test_helpers.issuing._personalization_design_reject_params import (
PersonalizationDesignRejectParams as PersonalizationDesignRejectParams,
PersonalizationDesignRejectParamsRejectionReasons as PersonalizationDesignRejectParamsRejectionReasons,
)
from stripe.params.test_helpers.issuing._transaction_create_force_capture_params import (
TransactionCreateForceCaptureParams as TransactionCreateForceCaptureParams,
TransactionCreateForceCaptureParamsMerchantData as TransactionCreateForceCaptureParamsMerchantData,
TransactionCreateForceCaptureParamsPurchaseDetails as TransactionCreateForceCaptureParamsPurchaseDetails,
TransactionCreateForceCaptureParamsPurchaseDetailsFleet as TransactionCreateForceCaptureParamsPurchaseDetailsFleet,
TransactionCreateForceCaptureParamsPurchaseDetailsFleetCardholderPromptData as TransactionCreateForceCaptureParamsPurchaseDetailsFleetCardholderPromptData,
TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdown as TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdown,
TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel as TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel,
TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel as TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel,
TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownTax as TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownTax,
TransactionCreateForceCaptureParamsPurchaseDetailsFlight as TransactionCreateForceCaptureParamsPurchaseDetailsFlight,
TransactionCreateForceCaptureParamsPurchaseDetailsFlightSegment as TransactionCreateForceCaptureParamsPurchaseDetailsFlightSegment,
TransactionCreateForceCaptureParamsPurchaseDetailsFuel as TransactionCreateForceCaptureParamsPurchaseDetailsFuel,
TransactionCreateForceCaptureParamsPurchaseDetailsLodging as TransactionCreateForceCaptureParamsPurchaseDetailsLodging,
TransactionCreateForceCaptureParamsPurchaseDetailsReceipt as TransactionCreateForceCaptureParamsPurchaseDetailsReceipt,
)
from stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params import (
TransactionCreateUnlinkedRefundParams as TransactionCreateUnlinkedRefundParams,
TransactionCreateUnlinkedRefundParamsMerchantData as TransactionCreateUnlinkedRefundParamsMerchantData,
TransactionCreateUnlinkedRefundParamsPurchaseDetails as TransactionCreateUnlinkedRefundParamsPurchaseDetails,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleet as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleet,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetCardholderPromptData as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetCardholderPromptData,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdown as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdown,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownFuel as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownFuel,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownNonFuel as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownNonFuel,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownTax as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownTax,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlight as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlight,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlightSegment as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlightSegment,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsFuel as TransactionCreateUnlinkedRefundParamsPurchaseDetailsFuel,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsLodging as TransactionCreateUnlinkedRefundParamsPurchaseDetailsLodging,
TransactionCreateUnlinkedRefundParamsPurchaseDetailsReceipt as TransactionCreateUnlinkedRefundParamsPurchaseDetailsReceipt,
)
from stripe.params.test_helpers.issuing._transaction_refund_params import (
TransactionRefundParams as TransactionRefundParams,
)
# name -> (import_target, is_submodule)
_import_map = {
"AuthorizationCaptureParams": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetails": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFleet": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFleetCardholderPromptData": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdown": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownTax": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFlight": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFlightSegment": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsFuel": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsLodging": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCaptureParamsPurchaseDetailsReceipt": (
"stripe.params.test_helpers.issuing._authorization_capture_params",
False,
),
"AuthorizationCreateParams": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsAmountDetails": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsFleet": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsFleetCardholderPromptData": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsFleetReportedBreakdown": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsFleetReportedBreakdownFuel": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsFleetReportedBreakdownNonFuel": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsFleetReportedBreakdownTax": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsFuel": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsMerchantData": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsNetworkData": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsRiskAssessment": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsRiskAssessmentCardTestingRisk": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsRiskAssessmentMerchantDisputeRisk": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsVerificationData": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsVerificationDataAuthenticationExemption": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationCreateParamsVerificationDataThreeDSecure": (
"stripe.params.test_helpers.issuing._authorization_create_params",
False,
),
"AuthorizationExpireParams": (
"stripe.params.test_helpers.issuing._authorization_expire_params",
False,
),
"AuthorizationFinalizeAmountParams": (
"stripe.params.test_helpers.issuing._authorization_finalize_amount_params",
False,
),
"AuthorizationFinalizeAmountParamsFleet": (
"stripe.params.test_helpers.issuing._authorization_finalize_amount_params",
False,
),
"AuthorizationFinalizeAmountParamsFleetCardholderPromptData": (
"stripe.params.test_helpers.issuing._authorization_finalize_amount_params",
False,
),
"AuthorizationFinalizeAmountParamsFleetReportedBreakdown": (
"stripe.params.test_helpers.issuing._authorization_finalize_amount_params",
False,
),
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownFuel": (
"stripe.params.test_helpers.issuing._authorization_finalize_amount_params",
False,
),
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownNonFuel": (
"stripe.params.test_helpers.issuing._authorization_finalize_amount_params",
False,
),
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownTax": (
"stripe.params.test_helpers.issuing._authorization_finalize_amount_params",
False,
),
"AuthorizationFinalizeAmountParamsFuel": (
"stripe.params.test_helpers.issuing._authorization_finalize_amount_params",
False,
),
"AuthorizationIncrementParams": (
"stripe.params.test_helpers.issuing._authorization_increment_params",
False,
),
"AuthorizationRespondParams": (
"stripe.params.test_helpers.issuing._authorization_respond_params",
False,
),
"AuthorizationReverseParams": (
"stripe.params.test_helpers.issuing._authorization_reverse_params",
False,
),
"CardDeliverCardParams": (
"stripe.params.test_helpers.issuing._card_deliver_card_params",
False,
),
"CardFailCardParams": (
"stripe.params.test_helpers.issuing._card_fail_card_params",
False,
),
"CardReturnCardParams": (
"stripe.params.test_helpers.issuing._card_return_card_params",
False,
),
"CardShipCardParams": (
"stripe.params.test_helpers.issuing._card_ship_card_params",
False,
),
"CardSubmitCardParams": (
"stripe.params.test_helpers.issuing._card_submit_card_params",
False,
),
"PersonalizationDesignActivateParams": (
"stripe.params.test_helpers.issuing._personalization_design_activate_params",
False,
),
"PersonalizationDesignDeactivateParams": (
"stripe.params.test_helpers.issuing._personalization_design_deactivate_params",
False,
),
"PersonalizationDesignRejectParams": (
"stripe.params.test_helpers.issuing._personalization_design_reject_params",
False,
),
"PersonalizationDesignRejectParamsRejectionReasons": (
"stripe.params.test_helpers.issuing._personalization_design_reject_params",
False,
),
"TransactionCreateForceCaptureParams": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsMerchantData": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetails": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFleet": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetCardholderPromptData": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdown": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownTax": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFlight": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFlightSegment": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsFuel": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsLodging": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateForceCaptureParamsPurchaseDetailsReceipt": (
"stripe.params.test_helpers.issuing._transaction_create_force_capture_params",
False,
),
"TransactionCreateUnlinkedRefundParams": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsMerchantData": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetails": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleet": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetCardholderPromptData": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdown": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownFuel": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownNonFuel": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownTax": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlight": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlightSegment": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFuel": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsLodging": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsReceipt": (
"stripe.params.test_helpers.issuing._transaction_create_unlinked_refund_params",
False,
),
"TransactionRefundParams": (
"stripe.params.test_helpers.issuing._transaction_refund_params",
False,
),
}
if not TYPE_CHECKING:
def __getattr__(name):
try:
target, is_submodule = _import_map[name]
module = import_module(target)
if is_submodule:
return module
return getattr(
module,
name,
)
except KeyError:
raise AttributeError()

View File

@@ -0,0 +1,272 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class AuthorizationCaptureParams(TypedDict):
capture_amount: NotRequired[int]
"""
The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
close_authorization: NotRequired[bool]
"""
Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
purchase_details: NotRequired["AuthorizationCaptureParamsPurchaseDetails"]
"""
Additional purchase information that is optionally provided by the merchant.
"""
class AuthorizationCaptureParamsPurchaseDetails(TypedDict):
fleet: NotRequired["AuthorizationCaptureParamsPurchaseDetailsFleet"]
"""
Fleet-specific information for transactions using Fleet cards.
"""
flight: NotRequired["AuthorizationCaptureParamsPurchaseDetailsFlight"]
"""
Information about the flight that was purchased with this transaction.
"""
fuel: NotRequired["AuthorizationCaptureParamsPurchaseDetailsFuel"]
"""
Information about fuel that was purchased with this transaction.
"""
lodging: NotRequired["AuthorizationCaptureParamsPurchaseDetailsLodging"]
"""
Information about lodging that was purchased with this transaction.
"""
receipt: NotRequired[
List["AuthorizationCaptureParamsPurchaseDetailsReceipt"]
]
"""
The line items in the purchase.
"""
reference: NotRequired[str]
"""
A merchant-specific order number.
"""
class AuthorizationCaptureParamsPurchaseDetailsFleet(TypedDict):
cardholder_prompt_data: NotRequired[
"AuthorizationCaptureParamsPurchaseDetailsFleetCardholderPromptData"
]
"""
Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
"""
purchase_type: NotRequired[
Literal[
"fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase"
]
]
"""
The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
"""
reported_breakdown: NotRequired[
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdown"
]
"""
More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
"""
service_type: NotRequired[
Literal["full_service", "non_fuel_transaction", "self_service"]
]
"""
The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
"""
class AuthorizationCaptureParamsPurchaseDetailsFleetCardholderPromptData(
TypedDict,
):
driver_id: NotRequired[str]
"""
Driver ID.
"""
odometer: NotRequired[int]
"""
Odometer reading.
"""
unspecified_id: NotRequired[str]
"""
An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
"""
user_id: NotRequired[str]
"""
User ID.
"""
vehicle_number: NotRequired[str]
"""
Vehicle number.
"""
class AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdown(
TypedDict,
):
fuel: NotRequired[
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel"
]
"""
Breakdown of fuel portion of the purchase.
"""
non_fuel: NotRequired[
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel"
]
"""
Breakdown of non-fuel portion of the purchase.
"""
tax: NotRequired[
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownTax"
]
"""
Information about tax included in this transaction.
"""
class AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel(
TypedDict,
):
gross_amount_decimal: NotRequired[str]
"""
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
"""
class AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel(
TypedDict,
):
gross_amount_decimal: NotRequired[str]
"""
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
"""
class AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownTax(
TypedDict,
):
local_amount_decimal: NotRequired[str]
"""
Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
national_amount_decimal: NotRequired[str]
"""
Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
class AuthorizationCaptureParamsPurchaseDetailsFlight(TypedDict):
departure_at: NotRequired[int]
"""
The time that the flight departed.
"""
passenger_name: NotRequired[str]
"""
The name of the passenger.
"""
refundable: NotRequired[bool]
"""
Whether the ticket is refundable.
"""
segments: NotRequired[
List["AuthorizationCaptureParamsPurchaseDetailsFlightSegment"]
]
"""
The legs of the trip.
"""
travel_agency: NotRequired[str]
"""
The travel agency that issued the ticket.
"""
class AuthorizationCaptureParamsPurchaseDetailsFlightSegment(TypedDict):
arrival_airport_code: NotRequired[str]
"""
The three-letter IATA airport code of the flight's destination.
"""
carrier: NotRequired[str]
"""
The airline carrier code.
"""
departure_airport_code: NotRequired[str]
"""
The three-letter IATA airport code that the flight departed from.
"""
flight_number: NotRequired[str]
"""
The flight number.
"""
service_class: NotRequired[str]
"""
The flight's service class.
"""
stopover_allowed: NotRequired[bool]
"""
Whether a stopover is allowed on this flight.
"""
class AuthorizationCaptureParamsPurchaseDetailsFuel(TypedDict):
industry_product_code: NotRequired[str]
"""
[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
"""
quantity_decimal: NotRequired[str]
"""
The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
"""
type: NotRequired[
Literal[
"diesel",
"other",
"unleaded_plus",
"unleaded_regular",
"unleaded_super",
]
]
"""
The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
"""
unit: NotRequired[
Literal[
"charging_minute",
"imperial_gallon",
"kilogram",
"kilowatt_hour",
"liter",
"other",
"pound",
"us_gallon",
]
]
"""
The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
"""
unit_cost_decimal: NotRequired[str]
"""
The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
"""
class AuthorizationCaptureParamsPurchaseDetailsLodging(TypedDict):
check_in_at: NotRequired[int]
"""
The time of checking into the lodging.
"""
nights: NotRequired[int]
"""
The number of nights stayed at the lodging.
"""
class AuthorizationCaptureParamsPurchaseDetailsReceipt(TypedDict):
description: NotRequired[str]
quantity: NotRequired[str]
total: NotRequired[int]
unit_cost: NotRequired[int]

View File

@@ -0,0 +1,673 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class AuthorizationCreateParams(TypedDict):
amount: NotRequired[int]
"""
The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
amount_details: NotRequired["AuthorizationCreateParamsAmountDetails"]
"""
Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
authorization_method: NotRequired[
Literal["chip", "contactless", "keyed_in", "online", "swipe"]
]
"""
How the card details were provided. Defaults to online.
"""
card: str
"""
Card associated with this authorization.
"""
currency: NotRequired[str]
"""
The currency of the authorization. If not provided, defaults to the currency of the card. 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).
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
fleet: NotRequired["AuthorizationCreateParamsFleet"]
"""
Fleet-specific information for authorizations using Fleet cards.
"""
fraud_disputability_likelihood: NotRequired[
Literal["neutral", "unknown", "very_likely", "very_unlikely"]
]
"""
Probability that this transaction can be disputed in the event of fraud. Assessed by comparing the characteristics of the authorization to card network rules.
"""
fuel: NotRequired["AuthorizationCreateParamsFuel"]
"""
Information about fuel that was purchased with this transaction.
"""
is_amount_controllable: NotRequired[bool]
"""
If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
"""
merchant_amount: NotRequired[int]
"""
The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
merchant_currency: NotRequired[str]
"""
The currency of the authorization. If not provided, defaults to the currency of the card. 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).
"""
merchant_data: NotRequired["AuthorizationCreateParamsMerchantData"]
"""
Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
"""
network_data: NotRequired["AuthorizationCreateParamsNetworkData"]
"""
Details about the authorization, such as identifiers, set by the card network.
"""
risk_assessment: NotRequired["AuthorizationCreateParamsRiskAssessment"]
"""
Stripe's assessment of the fraud risk for this authorization.
"""
verification_data: NotRequired["AuthorizationCreateParamsVerificationData"]
"""
Verifications that Stripe performed on information that the cardholder provided to the merchant.
"""
wallet: NotRequired[Literal["apple_pay", "google_pay", "samsung_pay"]]
"""
The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
"""
class AuthorizationCreateParamsAmountDetails(TypedDict):
atm_fee: NotRequired[int]
"""
The ATM withdrawal fee.
"""
cashback_amount: NotRequired[int]
"""
The amount of cash requested by the cardholder.
"""
class AuthorizationCreateParamsFleet(TypedDict):
cardholder_prompt_data: NotRequired[
"AuthorizationCreateParamsFleetCardholderPromptData"
]
"""
Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
"""
purchase_type: NotRequired[
Literal[
"fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase"
]
]
"""
The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
"""
reported_breakdown: NotRequired[
"AuthorizationCreateParamsFleetReportedBreakdown"
]
"""
More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
"""
service_type: NotRequired[
Literal["full_service", "non_fuel_transaction", "self_service"]
]
"""
The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
"""
class AuthorizationCreateParamsFleetCardholderPromptData(TypedDict):
driver_id: NotRequired[str]
"""
Driver ID.
"""
odometer: NotRequired[int]
"""
Odometer reading.
"""
unspecified_id: NotRequired[str]
"""
An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
"""
user_id: NotRequired[str]
"""
User ID.
"""
vehicle_number: NotRequired[str]
"""
Vehicle number.
"""
class AuthorizationCreateParamsFleetReportedBreakdown(TypedDict):
fuel: NotRequired["AuthorizationCreateParamsFleetReportedBreakdownFuel"]
"""
Breakdown of fuel portion of the purchase.
"""
non_fuel: NotRequired[
"AuthorizationCreateParamsFleetReportedBreakdownNonFuel"
]
"""
Breakdown of non-fuel portion of the purchase.
"""
tax: NotRequired["AuthorizationCreateParamsFleetReportedBreakdownTax"]
"""
Information about tax included in this transaction.
"""
class AuthorizationCreateParamsFleetReportedBreakdownFuel(TypedDict):
gross_amount_decimal: NotRequired[str]
"""
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
"""
class AuthorizationCreateParamsFleetReportedBreakdownNonFuel(TypedDict):
gross_amount_decimal: NotRequired[str]
"""
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
"""
class AuthorizationCreateParamsFleetReportedBreakdownTax(TypedDict):
local_amount_decimal: NotRequired[str]
"""
Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
national_amount_decimal: NotRequired[str]
"""
Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
class AuthorizationCreateParamsFuel(TypedDict):
industry_product_code: NotRequired[str]
"""
[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
"""
quantity_decimal: NotRequired[str]
"""
The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
"""
type: NotRequired[
Literal[
"diesel",
"other",
"unleaded_plus",
"unleaded_regular",
"unleaded_super",
]
]
"""
The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
"""
unit: NotRequired[
Literal[
"charging_minute",
"imperial_gallon",
"kilogram",
"kilowatt_hour",
"liter",
"other",
"pound",
"us_gallon",
]
]
"""
The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
"""
unit_cost_decimal: NotRequired[str]
"""
The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
"""
class AuthorizationCreateParamsMerchantData(TypedDict):
category: NotRequired[
Literal[
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards",
]
]
"""
A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
"""
city: NotRequired[str]
"""
City where the seller is located
"""
country: NotRequired[str]
"""
Country where the seller is located
"""
name: NotRequired[str]
"""
Name of the seller
"""
network_id: NotRequired[str]
"""
Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
"""
postal_code: NotRequired[str]
"""
Postal code where the seller is located
"""
state: NotRequired[str]
"""
State where the seller is located
"""
terminal_id: NotRequired[str]
"""
An ID assigned by the seller to the location of the sale.
"""
url: NotRequired[str]
"""
URL provided by the merchant on a 3DS request
"""
class AuthorizationCreateParamsNetworkData(TypedDict):
acquiring_institution_id: NotRequired[str]
"""
Identifier assigned to the acquirer by the card network.
"""
class AuthorizationCreateParamsRiskAssessment(TypedDict):
card_testing_risk: NotRequired[
"AuthorizationCreateParamsRiskAssessmentCardTestingRisk"
]
"""
Stripe's assessment of this authorization's likelihood of being card testing activity.
"""
merchant_dispute_risk: NotRequired[
"AuthorizationCreateParamsRiskAssessmentMerchantDisputeRisk"
]
"""
The dispute risk of the merchant (the seller on a purchase) on an authorization based on all Stripe Issuing activity.
"""
class AuthorizationCreateParamsRiskAssessmentCardTestingRisk(TypedDict):
invalid_account_number_decline_rate_past_hour: NotRequired[int]
"""
The % of declines due to a card number not existing in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of card testing activity, meaning bad actors may be attempting different card number combinations to guess a correct one. Takes on values between 0 and 100.
"""
invalid_credentials_decline_rate_past_hour: NotRequired[int]
"""
The % of declines due to incorrect verification data (like CVV or expiry) in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of bad actors attempting to utilize valid card credentials at merchants with verification requirements. Takes on values between 0 and 100.
"""
risk_level: Literal[
"elevated", "highest", "low", "normal", "not_assessed", "unknown"
]
"""
The likelihood that this authorization is associated with card testing activity. This is assessed by evaluating decline activity over the last hour.
"""
class AuthorizationCreateParamsRiskAssessmentMerchantDisputeRisk(TypedDict):
dispute_rate: NotRequired[int]
"""
The dispute rate observed across all Stripe Issuing authorizations for this merchant. For example, a value of 50 means 50% of authorizations from this merchant on Stripe Issuing have resulted in a dispute. Higher values mean a higher likelihood the authorization is disputed. Takes on values between 0 and 100.
"""
risk_level: Literal[
"elevated", "highest", "low", "normal", "not_assessed", "unknown"
]
"""
The likelihood that authorizations from this merchant will result in a dispute based on their history on Stripe Issuing.
"""
class AuthorizationCreateParamsVerificationData(TypedDict):
address_line1_check: NotRequired[
Literal["match", "mismatch", "not_provided"]
]
"""
Whether the cardholder provided an address first line and if it matched the cardholder's `billing.address.line1`.
"""
address_postal_code_check: NotRequired[
Literal["match", "mismatch", "not_provided"]
]
"""
Whether the cardholder provided a postal code and if it matched the cardholder's `billing.address.postal_code`.
"""
authentication_exemption: NotRequired[
"AuthorizationCreateParamsVerificationDataAuthenticationExemption"
]
"""
The exemption applied to this authorization.
"""
cvc_check: NotRequired[Literal["match", "mismatch", "not_provided"]]
"""
Whether the cardholder provided a CVC and if it matched Stripe's record.
"""
expiry_check: NotRequired[Literal["match", "mismatch", "not_provided"]]
"""
Whether the cardholder provided an expiry date and if it matched Stripe's record.
"""
three_d_secure: NotRequired[
"AuthorizationCreateParamsVerificationDataThreeDSecure"
]
"""
3D Secure details.
"""
class AuthorizationCreateParamsVerificationDataAuthenticationExemption(
TypedDict,
):
claimed_by: Literal["acquirer", "issuer"]
"""
The entity that requested the exemption, either the acquiring merchant or the Issuing user.
"""
type: Literal[
"low_value_transaction", "transaction_risk_analysis", "unknown"
]
"""
The specific exemption claimed for this authorization.
"""
class AuthorizationCreateParamsVerificationDataThreeDSecure(TypedDict):
result: Literal[
"attempt_acknowledged", "authenticated", "failed", "required"
]
"""
The outcome of the 3D Secure authentication request.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class AuthorizationExpireParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,165 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class AuthorizationFinalizeAmountParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
final_amount: int
"""
The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
fleet: NotRequired["AuthorizationFinalizeAmountParamsFleet"]
"""
Fleet-specific information for authorizations using Fleet cards.
"""
fuel: NotRequired["AuthorizationFinalizeAmountParamsFuel"]
"""
Information about fuel that was purchased with this transaction.
"""
class AuthorizationFinalizeAmountParamsFleet(TypedDict):
cardholder_prompt_data: NotRequired[
"AuthorizationFinalizeAmountParamsFleetCardholderPromptData"
]
"""
Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
"""
purchase_type: NotRequired[
Literal[
"fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase"
]
]
"""
The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
"""
reported_breakdown: NotRequired[
"AuthorizationFinalizeAmountParamsFleetReportedBreakdown"
]
"""
More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
"""
service_type: NotRequired[
Literal["full_service", "non_fuel_transaction", "self_service"]
]
"""
The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
"""
class AuthorizationFinalizeAmountParamsFleetCardholderPromptData(TypedDict):
driver_id: NotRequired[str]
"""
Driver ID.
"""
odometer: NotRequired[int]
"""
Odometer reading.
"""
unspecified_id: NotRequired[str]
"""
An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
"""
user_id: NotRequired[str]
"""
User ID.
"""
vehicle_number: NotRequired[str]
"""
Vehicle number.
"""
class AuthorizationFinalizeAmountParamsFleetReportedBreakdown(TypedDict):
fuel: NotRequired[
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownFuel"
]
"""
Breakdown of fuel portion of the purchase.
"""
non_fuel: NotRequired[
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownNonFuel"
]
"""
Breakdown of non-fuel portion of the purchase.
"""
tax: NotRequired[
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownTax"
]
"""
Information about tax included in this transaction.
"""
class AuthorizationFinalizeAmountParamsFleetReportedBreakdownFuel(TypedDict):
gross_amount_decimal: NotRequired[str]
"""
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
"""
class AuthorizationFinalizeAmountParamsFleetReportedBreakdownNonFuel(
TypedDict
):
gross_amount_decimal: NotRequired[str]
"""
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
"""
class AuthorizationFinalizeAmountParamsFleetReportedBreakdownTax(TypedDict):
local_amount_decimal: NotRequired[str]
"""
Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
national_amount_decimal: NotRequired[str]
"""
Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
class AuthorizationFinalizeAmountParamsFuel(TypedDict):
industry_product_code: NotRequired[str]
"""
[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
"""
quantity_decimal: NotRequired[str]
"""
The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
"""
type: NotRequired[
Literal[
"diesel",
"other",
"unleaded_plus",
"unleaded_regular",
"unleaded_super",
]
]
"""
The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
"""
unit: NotRequired[
Literal[
"charging_minute",
"imperial_gallon",
"kilogram",
"kilowatt_hour",
"liter",
"other",
"pound",
"us_gallon",
]
]
"""
The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
"""
unit_cost_decimal: NotRequired[str]
"""
The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
"""

View File

@@ -0,0 +1,19 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class AuthorizationIncrementParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
increment_amount: int
"""
The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
is_amount_controllable: NotRequired[bool]
"""
If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
"""

View File

@@ -0,0 +1,15 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class AuthorizationRespondParams(TypedDict):
confirmed: bool
"""
Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false).
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,15 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class AuthorizationReverseParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
reverse_amount: NotRequired[int]
"""
The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class CardDeliverCardParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class CardFailCardParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class CardReturnCardParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class CardShipCardParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class CardSubmitCardParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class PersonalizationDesignActivateParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class PersonalizationDesignDeactivateParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,51 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class PersonalizationDesignRejectParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
rejection_reasons: "PersonalizationDesignRejectParamsRejectionReasons"
"""
The reason(s) the personalization design was rejected.
"""
class PersonalizationDesignRejectParamsRejectionReasons(TypedDict):
card_logo: NotRequired[
List[
Literal[
"geographic_location",
"inappropriate",
"network_name",
"non_binary_image",
"non_fiat_currency",
"other",
"other_entity",
"promotional_material",
]
]
]
"""
The reason(s) the card logo was rejected.
"""
carrier_text: NotRequired[
List[
Literal[
"geographic_location",
"inappropriate",
"network_name",
"non_fiat_currency",
"other",
"other_entity",
"promotional_material",
]
]
]
"""
The reason(s) the carrier text was rejected.
"""

View File

@@ -0,0 +1,628 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class TransactionCreateForceCaptureParams(TypedDict):
amount: int
"""
The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
card: str
"""
Card associated with this transaction.
"""
currency: NotRequired[str]
"""
The currency of the capture. If not provided, defaults to the currency of the card. 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).
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
merchant_data: NotRequired[
"TransactionCreateForceCaptureParamsMerchantData"
]
"""
Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
"""
purchase_details: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetails"
]
"""
Additional purchase information that is optionally provided by the merchant.
"""
class TransactionCreateForceCaptureParamsMerchantData(TypedDict):
category: NotRequired[
Literal[
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards",
]
]
"""
A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
"""
city: NotRequired[str]
"""
City where the seller is located
"""
country: NotRequired[str]
"""
Country where the seller is located
"""
name: NotRequired[str]
"""
Name of the seller
"""
network_id: NotRequired[str]
"""
Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
"""
postal_code: NotRequired[str]
"""
Postal code where the seller is located
"""
state: NotRequired[str]
"""
State where the seller is located
"""
terminal_id: NotRequired[str]
"""
An ID assigned by the seller to the location of the sale.
"""
url: NotRequired[str]
"""
URL provided by the merchant on a 3DS request
"""
class TransactionCreateForceCaptureParamsPurchaseDetails(TypedDict):
fleet: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetailsFleet"
]
"""
Fleet-specific information for transactions using Fleet cards.
"""
flight: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetailsFlight"
]
"""
Information about the flight that was purchased with this transaction.
"""
fuel: NotRequired["TransactionCreateForceCaptureParamsPurchaseDetailsFuel"]
"""
Information about fuel that was purchased with this transaction.
"""
lodging: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetailsLodging"
]
"""
Information about lodging that was purchased with this transaction.
"""
receipt: NotRequired[
List["TransactionCreateForceCaptureParamsPurchaseDetailsReceipt"]
]
"""
The line items in the purchase.
"""
reference: NotRequired[str]
"""
A merchant-specific order number.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFleet(TypedDict):
cardholder_prompt_data: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetCardholderPromptData"
]
"""
Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
"""
purchase_type: NotRequired[
Literal[
"fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase"
]
]
"""
The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
"""
reported_breakdown: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdown"
]
"""
More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
"""
service_type: NotRequired[
Literal["full_service", "non_fuel_transaction", "self_service"]
]
"""
The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFleetCardholderPromptData(
TypedDict,
):
driver_id: NotRequired[str]
"""
Driver ID.
"""
odometer: NotRequired[int]
"""
Odometer reading.
"""
unspecified_id: NotRequired[str]
"""
An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
"""
user_id: NotRequired[str]
"""
User ID.
"""
vehicle_number: NotRequired[str]
"""
Vehicle number.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdown(
TypedDict,
):
fuel: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel"
]
"""
Breakdown of fuel portion of the purchase.
"""
non_fuel: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel"
]
"""
Breakdown of non-fuel portion of the purchase.
"""
tax: NotRequired[
"TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownTax"
]
"""
Information about tax included in this transaction.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel(
TypedDict,
):
gross_amount_decimal: NotRequired[str]
"""
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel(
TypedDict,
):
gross_amount_decimal: NotRequired[str]
"""
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFleetReportedBreakdownTax(
TypedDict,
):
local_amount_decimal: NotRequired[str]
"""
Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
national_amount_decimal: NotRequired[str]
"""
Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFlight(TypedDict):
departure_at: NotRequired[int]
"""
The time that the flight departed.
"""
passenger_name: NotRequired[str]
"""
The name of the passenger.
"""
refundable: NotRequired[bool]
"""
Whether the ticket is refundable.
"""
segments: NotRequired[
List["TransactionCreateForceCaptureParamsPurchaseDetailsFlightSegment"]
]
"""
The legs of the trip.
"""
travel_agency: NotRequired[str]
"""
The travel agency that issued the ticket.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFlightSegment(
TypedDict,
):
arrival_airport_code: NotRequired[str]
"""
The three-letter IATA airport code of the flight's destination.
"""
carrier: NotRequired[str]
"""
The airline carrier code.
"""
departure_airport_code: NotRequired[str]
"""
The three-letter IATA airport code that the flight departed from.
"""
flight_number: NotRequired[str]
"""
The flight number.
"""
service_class: NotRequired[str]
"""
The flight's service class.
"""
stopover_allowed: NotRequired[bool]
"""
Whether a stopover is allowed on this flight.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsFuel(TypedDict):
industry_product_code: NotRequired[str]
"""
[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
"""
quantity_decimal: NotRequired[str]
"""
The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
"""
type: NotRequired[
Literal[
"diesel",
"other",
"unleaded_plus",
"unleaded_regular",
"unleaded_super",
]
]
"""
The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
"""
unit: NotRequired[
Literal[
"charging_minute",
"imperial_gallon",
"kilogram",
"kilowatt_hour",
"liter",
"other",
"pound",
"us_gallon",
]
]
"""
The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
"""
unit_cost_decimal: NotRequired[str]
"""
The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsLodging(TypedDict):
check_in_at: NotRequired[int]
"""
The time of checking into the lodging.
"""
nights: NotRequired[int]
"""
The number of nights stayed at the lodging.
"""
class TransactionCreateForceCaptureParamsPurchaseDetailsReceipt(TypedDict):
description: NotRequired[str]
quantity: NotRequired[str]
total: NotRequired[int]
unit_cost: NotRequired[int]

View File

@@ -0,0 +1,632 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class TransactionCreateUnlinkedRefundParams(TypedDict):
amount: int
"""
The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""
card: str
"""
Card associated with this unlinked refund transaction.
"""
currency: NotRequired[str]
"""
The currency of the unlinked refund. If not provided, defaults to the currency of the card. 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).
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
merchant_data: NotRequired[
"TransactionCreateUnlinkedRefundParamsMerchantData"
]
"""
Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
"""
purchase_details: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetails"
]
"""
Additional purchase information that is optionally provided by the merchant.
"""
class TransactionCreateUnlinkedRefundParamsMerchantData(TypedDict):
category: NotRequired[
Literal[
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards",
]
]
"""
A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
"""
city: NotRequired[str]
"""
City where the seller is located
"""
country: NotRequired[str]
"""
Country where the seller is located
"""
name: NotRequired[str]
"""
Name of the seller
"""
network_id: NotRequired[str]
"""
Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
"""
postal_code: NotRequired[str]
"""
Postal code where the seller is located
"""
state: NotRequired[str]
"""
State where the seller is located
"""
terminal_id: NotRequired[str]
"""
An ID assigned by the seller to the location of the sale.
"""
url: NotRequired[str]
"""
URL provided by the merchant on a 3DS request
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetails(TypedDict):
fleet: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleet"
]
"""
Fleet-specific information for transactions using Fleet cards.
"""
flight: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlight"
]
"""
Information about the flight that was purchased with this transaction.
"""
fuel: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFuel"
]
"""
Information about fuel that was purchased with this transaction.
"""
lodging: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsLodging"
]
"""
Information about lodging that was purchased with this transaction.
"""
receipt: NotRequired[
List["TransactionCreateUnlinkedRefundParamsPurchaseDetailsReceipt"]
]
"""
The line items in the purchase.
"""
reference: NotRequired[str]
"""
A merchant-specific order number.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleet(TypedDict):
cardholder_prompt_data: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetCardholderPromptData"
]
"""
Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
"""
purchase_type: NotRequired[
Literal[
"fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase"
]
]
"""
The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
"""
reported_breakdown: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdown"
]
"""
More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
"""
service_type: NotRequired[
Literal["full_service", "non_fuel_transaction", "self_service"]
]
"""
The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetCardholderPromptData(
TypedDict,
):
driver_id: NotRequired[str]
"""
Driver ID.
"""
odometer: NotRequired[int]
"""
Odometer reading.
"""
unspecified_id: NotRequired[str]
"""
An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
"""
user_id: NotRequired[str]
"""
User ID.
"""
vehicle_number: NotRequired[str]
"""
Vehicle number.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdown(
TypedDict,
):
fuel: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownFuel"
]
"""
Breakdown of fuel portion of the purchase.
"""
non_fuel: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownNonFuel"
]
"""
Breakdown of non-fuel portion of the purchase.
"""
tax: NotRequired[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownTax"
]
"""
Information about tax included in this transaction.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownFuel(
TypedDict,
):
gross_amount_decimal: NotRequired[str]
"""
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownNonFuel(
TypedDict,
):
gross_amount_decimal: NotRequired[str]
"""
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFleetReportedBreakdownTax(
TypedDict,
):
local_amount_decimal: NotRequired[str]
"""
Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
national_amount_decimal: NotRequired[str]
"""
Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlight(TypedDict):
departure_at: NotRequired[int]
"""
The time that the flight departed.
"""
passenger_name: NotRequired[str]
"""
The name of the passenger.
"""
refundable: NotRequired[bool]
"""
Whether the ticket is refundable.
"""
segments: NotRequired[
List[
"TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlightSegment"
]
]
"""
The legs of the trip.
"""
travel_agency: NotRequired[str]
"""
The travel agency that issued the ticket.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFlightSegment(
TypedDict,
):
arrival_airport_code: NotRequired[str]
"""
The three-letter IATA airport code of the flight's destination.
"""
carrier: NotRequired[str]
"""
The airline carrier code.
"""
departure_airport_code: NotRequired[str]
"""
The three-letter IATA airport code that the flight departed from.
"""
flight_number: NotRequired[str]
"""
The flight number.
"""
service_class: NotRequired[str]
"""
The flight's service class.
"""
stopover_allowed: NotRequired[bool]
"""
Whether a stopover is allowed on this flight.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsFuel(TypedDict):
industry_product_code: NotRequired[str]
"""
[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
"""
quantity_decimal: NotRequired[str]
"""
The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
"""
type: NotRequired[
Literal[
"diesel",
"other",
"unleaded_plus",
"unleaded_regular",
"unleaded_super",
]
]
"""
The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
"""
unit: NotRequired[
Literal[
"charging_minute",
"imperial_gallon",
"kilogram",
"kilowatt_hour",
"liter",
"other",
"pound",
"us_gallon",
]
]
"""
The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
"""
unit_cost_decimal: NotRequired[str]
"""
The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsLodging(TypedDict):
check_in_at: NotRequired[int]
"""
The time of checking into the lodging.
"""
nights: NotRequired[int]
"""
The number of nights stayed at the lodging.
"""
class TransactionCreateUnlinkedRefundParamsPurchaseDetailsReceipt(TypedDict):
description: NotRequired[str]
quantity: NotRequired[str]
total: NotRequired[int]
unit_cost: NotRequired[int]

View File

@@ -0,0 +1,15 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class TransactionRefundParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
refund_amount: NotRequired[int]
"""
The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
"""

View File

@@ -0,0 +1,61 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.test_helpers.terminal._reader_present_payment_method_params import (
ReaderPresentPaymentMethodParams as ReaderPresentPaymentMethodParams,
ReaderPresentPaymentMethodParamsCard as ReaderPresentPaymentMethodParamsCard,
ReaderPresentPaymentMethodParamsCardPresent as ReaderPresentPaymentMethodParamsCardPresent,
ReaderPresentPaymentMethodParamsInteracPresent as ReaderPresentPaymentMethodParamsInteracPresent,
)
from stripe.params.test_helpers.terminal._reader_succeed_input_collection_params import (
ReaderSucceedInputCollectionParams as ReaderSucceedInputCollectionParams,
)
from stripe.params.test_helpers.terminal._reader_timeout_input_collection_params import (
ReaderTimeoutInputCollectionParams as ReaderTimeoutInputCollectionParams,
)
# name -> (import_target, is_submodule)
_import_map = {
"ReaderPresentPaymentMethodParams": (
"stripe.params.test_helpers.terminal._reader_present_payment_method_params",
False,
),
"ReaderPresentPaymentMethodParamsCard": (
"stripe.params.test_helpers.terminal._reader_present_payment_method_params",
False,
),
"ReaderPresentPaymentMethodParamsCardPresent": (
"stripe.params.test_helpers.terminal._reader_present_payment_method_params",
False,
),
"ReaderPresentPaymentMethodParamsInteracPresent": (
"stripe.params.test_helpers.terminal._reader_present_payment_method_params",
False,
),
"ReaderSucceedInputCollectionParams": (
"stripe.params.test_helpers.terminal._reader_succeed_input_collection_params",
False,
),
"ReaderTimeoutInputCollectionParams": (
"stripe.params.test_helpers.terminal._reader_timeout_input_collection_params",
False,
),
}
if not TYPE_CHECKING:
def __getattr__(name):
try:
target, is_submodule = _import_map[name]
module = import_module(target)
if is_submodule:
return module
return getattr(
module,
name,
)
except KeyError:
raise AttributeError()

View File

@@ -0,0 +1,66 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class ReaderPresentPaymentMethodParams(TypedDict):
amount_tip: NotRequired[int]
"""
Simulated on-reader tip amount.
"""
card: NotRequired["ReaderPresentPaymentMethodParamsCard"]
"""
Simulated data for the card payment method.
"""
card_present: NotRequired["ReaderPresentPaymentMethodParamsCardPresent"]
"""
Simulated data for the card_present payment method.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
interac_present: NotRequired[
"ReaderPresentPaymentMethodParamsInteracPresent"
]
"""
Simulated data for the interac_present payment method.
"""
type: NotRequired[Literal["card", "card_present", "interac_present"]]
"""
Simulated payment type.
"""
class ReaderPresentPaymentMethodParamsCard(TypedDict):
cvc: NotRequired[str]
"""
Card security code.
"""
exp_month: int
"""
Two-digit number representing the card's expiration month.
"""
exp_year: int
"""
Two- or four-digit number representing the card's expiration year.
"""
number: str
"""
The card number, as a string without any separators.
"""
class ReaderPresentPaymentMethodParamsCardPresent(TypedDict):
number: NotRequired[str]
"""
The card number, as a string without any separators.
"""
class ReaderPresentPaymentMethodParamsInteracPresent(TypedDict):
number: NotRequired[str]
"""
The Interac card number.
"""

View File

@@ -0,0 +1,15 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class ReaderSucceedInputCollectionParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
skip_non_required_inputs: NotRequired[Literal["all", "none"]]
"""
This parameter defines the skip behavior for input collection.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class ReaderTimeoutInputCollectionParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,181 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.test_helpers.treasury._inbound_transfer_fail_params import (
InboundTransferFailParams as InboundTransferFailParams,
InboundTransferFailParamsFailureDetails as InboundTransferFailParamsFailureDetails,
)
from stripe.params.test_helpers.treasury._inbound_transfer_return_inbound_transfer_params import (
InboundTransferReturnInboundTransferParams as InboundTransferReturnInboundTransferParams,
)
from stripe.params.test_helpers.treasury._inbound_transfer_succeed_params import (
InboundTransferSucceedParams as InboundTransferSucceedParams,
)
from stripe.params.test_helpers.treasury._outbound_payment_fail_params import (
OutboundPaymentFailParams as OutboundPaymentFailParams,
)
from stripe.params.test_helpers.treasury._outbound_payment_post_params import (
OutboundPaymentPostParams as OutboundPaymentPostParams,
)
from stripe.params.test_helpers.treasury._outbound_payment_return_outbound_payment_params import (
OutboundPaymentReturnOutboundPaymentParams as OutboundPaymentReturnOutboundPaymentParams,
OutboundPaymentReturnOutboundPaymentParamsReturnedDetails as OutboundPaymentReturnOutboundPaymentParamsReturnedDetails,
)
from stripe.params.test_helpers.treasury._outbound_payment_update_params import (
OutboundPaymentUpdateParams as OutboundPaymentUpdateParams,
OutboundPaymentUpdateParamsTrackingDetails as OutboundPaymentUpdateParamsTrackingDetails,
OutboundPaymentUpdateParamsTrackingDetailsAch as OutboundPaymentUpdateParamsTrackingDetailsAch,
OutboundPaymentUpdateParamsTrackingDetailsUsDomesticWire as OutboundPaymentUpdateParamsTrackingDetailsUsDomesticWire,
)
from stripe.params.test_helpers.treasury._outbound_transfer_fail_params import (
OutboundTransferFailParams as OutboundTransferFailParams,
)
from stripe.params.test_helpers.treasury._outbound_transfer_post_params import (
OutboundTransferPostParams as OutboundTransferPostParams,
)
from stripe.params.test_helpers.treasury._outbound_transfer_return_outbound_transfer_params import (
OutboundTransferReturnOutboundTransferParams as OutboundTransferReturnOutboundTransferParams,
OutboundTransferReturnOutboundTransferParamsReturnedDetails as OutboundTransferReturnOutboundTransferParamsReturnedDetails,
)
from stripe.params.test_helpers.treasury._outbound_transfer_update_params import (
OutboundTransferUpdateParams as OutboundTransferUpdateParams,
OutboundTransferUpdateParamsTrackingDetails as OutboundTransferUpdateParamsTrackingDetails,
OutboundTransferUpdateParamsTrackingDetailsAch as OutboundTransferUpdateParamsTrackingDetailsAch,
OutboundTransferUpdateParamsTrackingDetailsUsDomesticWire as OutboundTransferUpdateParamsTrackingDetailsUsDomesticWire,
)
from stripe.params.test_helpers.treasury._received_credit_create_params import (
ReceivedCreditCreateParams as ReceivedCreditCreateParams,
ReceivedCreditCreateParamsInitiatingPaymentMethodDetails as ReceivedCreditCreateParamsInitiatingPaymentMethodDetails,
ReceivedCreditCreateParamsInitiatingPaymentMethodDetailsUsBankAccount as ReceivedCreditCreateParamsInitiatingPaymentMethodDetailsUsBankAccount,
)
from stripe.params.test_helpers.treasury._received_debit_create_params import (
ReceivedDebitCreateParams as ReceivedDebitCreateParams,
ReceivedDebitCreateParamsInitiatingPaymentMethodDetails as ReceivedDebitCreateParamsInitiatingPaymentMethodDetails,
ReceivedDebitCreateParamsInitiatingPaymentMethodDetailsUsBankAccount as ReceivedDebitCreateParamsInitiatingPaymentMethodDetailsUsBankAccount,
)
# name -> (import_target, is_submodule)
_import_map = {
"InboundTransferFailParams": (
"stripe.params.test_helpers.treasury._inbound_transfer_fail_params",
False,
),
"InboundTransferFailParamsFailureDetails": (
"stripe.params.test_helpers.treasury._inbound_transfer_fail_params",
False,
),
"InboundTransferReturnInboundTransferParams": (
"stripe.params.test_helpers.treasury._inbound_transfer_return_inbound_transfer_params",
False,
),
"InboundTransferSucceedParams": (
"stripe.params.test_helpers.treasury._inbound_transfer_succeed_params",
False,
),
"OutboundPaymentFailParams": (
"stripe.params.test_helpers.treasury._outbound_payment_fail_params",
False,
),
"OutboundPaymentPostParams": (
"stripe.params.test_helpers.treasury._outbound_payment_post_params",
False,
),
"OutboundPaymentReturnOutboundPaymentParams": (
"stripe.params.test_helpers.treasury._outbound_payment_return_outbound_payment_params",
False,
),
"OutboundPaymentReturnOutboundPaymentParamsReturnedDetails": (
"stripe.params.test_helpers.treasury._outbound_payment_return_outbound_payment_params",
False,
),
"OutboundPaymentUpdateParams": (
"stripe.params.test_helpers.treasury._outbound_payment_update_params",
False,
),
"OutboundPaymentUpdateParamsTrackingDetails": (
"stripe.params.test_helpers.treasury._outbound_payment_update_params",
False,
),
"OutboundPaymentUpdateParamsTrackingDetailsAch": (
"stripe.params.test_helpers.treasury._outbound_payment_update_params",
False,
),
"OutboundPaymentUpdateParamsTrackingDetailsUsDomesticWire": (
"stripe.params.test_helpers.treasury._outbound_payment_update_params",
False,
),
"OutboundTransferFailParams": (
"stripe.params.test_helpers.treasury._outbound_transfer_fail_params",
False,
),
"OutboundTransferPostParams": (
"stripe.params.test_helpers.treasury._outbound_transfer_post_params",
False,
),
"OutboundTransferReturnOutboundTransferParams": (
"stripe.params.test_helpers.treasury._outbound_transfer_return_outbound_transfer_params",
False,
),
"OutboundTransferReturnOutboundTransferParamsReturnedDetails": (
"stripe.params.test_helpers.treasury._outbound_transfer_return_outbound_transfer_params",
False,
),
"OutboundTransferUpdateParams": (
"stripe.params.test_helpers.treasury._outbound_transfer_update_params",
False,
),
"OutboundTransferUpdateParamsTrackingDetails": (
"stripe.params.test_helpers.treasury._outbound_transfer_update_params",
False,
),
"OutboundTransferUpdateParamsTrackingDetailsAch": (
"stripe.params.test_helpers.treasury._outbound_transfer_update_params",
False,
),
"OutboundTransferUpdateParamsTrackingDetailsUsDomesticWire": (
"stripe.params.test_helpers.treasury._outbound_transfer_update_params",
False,
),
"ReceivedCreditCreateParams": (
"stripe.params.test_helpers.treasury._received_credit_create_params",
False,
),
"ReceivedCreditCreateParamsInitiatingPaymentMethodDetails": (
"stripe.params.test_helpers.treasury._received_credit_create_params",
False,
),
"ReceivedCreditCreateParamsInitiatingPaymentMethodDetailsUsBankAccount": (
"stripe.params.test_helpers.treasury._received_credit_create_params",
False,
),
"ReceivedDebitCreateParams": (
"stripe.params.test_helpers.treasury._received_debit_create_params",
False,
),
"ReceivedDebitCreateParamsInitiatingPaymentMethodDetails": (
"stripe.params.test_helpers.treasury._received_debit_create_params",
False,
),
"ReceivedDebitCreateParamsInitiatingPaymentMethodDetailsUsBankAccount": (
"stripe.params.test_helpers.treasury._received_debit_create_params",
False,
),
}
if not TYPE_CHECKING:
def __getattr__(name):
try:
target, is_submodule = _import_map[name]
module = import_module(target)
if is_submodule:
return module
return getattr(
module,
name,
)
except KeyError:
raise AttributeError()

View File

@@ -0,0 +1,38 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class InboundTransferFailParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
failure_details: NotRequired["InboundTransferFailParamsFailureDetails"]
"""
Details about a failed InboundTransfer.
"""
class InboundTransferFailParamsFailureDetails(TypedDict):
code: NotRequired[
Literal[
"account_closed",
"account_frozen",
"bank_account_restricted",
"bank_ownership_changed",
"debit_not_authorized",
"incorrect_account_holder_address",
"incorrect_account_holder_name",
"incorrect_account_holder_tax_id",
"insufficient_funds",
"invalid_account_number",
"invalid_currency",
"no_account",
"other",
]
]
"""
Reason for the failure.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class InboundTransferReturnInboundTransferParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class InboundTransferSucceedParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class OutboundPaymentFailParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class OutboundPaymentPostParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,37 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class OutboundPaymentReturnOutboundPaymentParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
returned_details: NotRequired[
"OutboundPaymentReturnOutboundPaymentParamsReturnedDetails"
]
"""
Optional hash to set the return code.
"""
class OutboundPaymentReturnOutboundPaymentParamsReturnedDetails(TypedDict):
code: NotRequired[
Literal[
"account_closed",
"account_frozen",
"bank_account_restricted",
"bank_ownership_changed",
"declined",
"incorrect_account_holder_name",
"invalid_account_number",
"invalid_currency",
"no_account",
"other",
]
]
"""
The return code to be set on the OutboundPayment object.
"""

View File

@@ -0,0 +1,54 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class OutboundPaymentUpdateParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
tracking_details: "OutboundPaymentUpdateParamsTrackingDetails"
"""
Details about network-specific tracking information.
"""
class OutboundPaymentUpdateParamsTrackingDetails(TypedDict):
ach: NotRequired["OutboundPaymentUpdateParamsTrackingDetailsAch"]
"""
ACH network tracking details.
"""
type: Literal["ach", "us_domestic_wire"]
"""
The US bank account network used to send funds.
"""
us_domestic_wire: NotRequired[
"OutboundPaymentUpdateParamsTrackingDetailsUsDomesticWire"
]
"""
US domestic wire network tracking details.
"""
class OutboundPaymentUpdateParamsTrackingDetailsAch(TypedDict):
trace_id: str
"""
ACH trace ID for funds sent over the `ach` network.
"""
class OutboundPaymentUpdateParamsTrackingDetailsUsDomesticWire(TypedDict):
chips: NotRequired[str]
"""
CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
"""
imad: NotRequired[str]
"""
IMAD for funds sent over the `us_domestic_wire` network.
"""
omad: NotRequired[str]
"""
OMAD for funds sent over the `us_domestic_wire` network.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class OutboundTransferFailParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,11 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import NotRequired, TypedDict
class OutboundTransferPostParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""

View File

@@ -0,0 +1,37 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class OutboundTransferReturnOutboundTransferParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
returned_details: NotRequired[
"OutboundTransferReturnOutboundTransferParamsReturnedDetails"
]
"""
Details about a returned OutboundTransfer.
"""
class OutboundTransferReturnOutboundTransferParamsReturnedDetails(TypedDict):
code: NotRequired[
Literal[
"account_closed",
"account_frozen",
"bank_account_restricted",
"bank_ownership_changed",
"declined",
"incorrect_account_holder_name",
"invalid_account_number",
"invalid_currency",
"no_account",
"other",
]
]
"""
Reason for the return.
"""

View File

@@ -0,0 +1,54 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class OutboundTransferUpdateParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
tracking_details: "OutboundTransferUpdateParamsTrackingDetails"
"""
Details about network-specific tracking information.
"""
class OutboundTransferUpdateParamsTrackingDetails(TypedDict):
ach: NotRequired["OutboundTransferUpdateParamsTrackingDetailsAch"]
"""
ACH network tracking details.
"""
type: Literal["ach", "us_domestic_wire"]
"""
The US bank account network used to send funds.
"""
us_domestic_wire: NotRequired[
"OutboundTransferUpdateParamsTrackingDetailsUsDomesticWire"
]
"""
US domestic wire network tracking details.
"""
class OutboundTransferUpdateParamsTrackingDetailsAch(TypedDict):
trace_id: str
"""
ACH trace ID for funds sent over the `ach` network.
"""
class OutboundTransferUpdateParamsTrackingDetailsUsDomesticWire(TypedDict):
chips: NotRequired[str]
"""
CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
"""
imad: NotRequired[str]
"""
IMAD for funds sent over the `us_domestic_wire` network.
"""
omad: NotRequired[str]
"""
OMAD for funds sent over the `us_domestic_wire` network.
"""

View File

@@ -0,0 +1,67 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class ReceivedCreditCreateParams(TypedDict):
amount: int
"""
Amount (in cents) to be transferred.
"""
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: 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.
"""
financial_account: str
"""
The FinancialAccount to send funds to.
"""
initiating_payment_method_details: NotRequired[
"ReceivedCreditCreateParamsInitiatingPaymentMethodDetails"
]
"""
Initiating payment method details for the object.
"""
network: Literal["ach", "us_domestic_wire"]
"""
Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
"""
class ReceivedCreditCreateParamsInitiatingPaymentMethodDetails(TypedDict):
type: Literal["us_bank_account"]
"""
The source type.
"""
us_bank_account: NotRequired[
"ReceivedCreditCreateParamsInitiatingPaymentMethodDetailsUsBankAccount"
]
"""
Optional fields for `us_bank_account`.
"""
class ReceivedCreditCreateParamsInitiatingPaymentMethodDetailsUsBankAccount(
TypedDict,
):
account_holder_name: NotRequired[str]
"""
The bank account holder's name.
"""
account_number: NotRequired[str]
"""
The bank account number.
"""
routing_number: NotRequired[str]
"""
The bank account's routing number.
"""

View File

@@ -0,0 +1,67 @@
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from typing import List
from typing_extensions import Literal, NotRequired, TypedDict
class ReceivedDebitCreateParams(TypedDict):
amount: int
"""
Amount (in cents) to be transferred.
"""
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: 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.
"""
financial_account: str
"""
The FinancialAccount to pull funds from.
"""
initiating_payment_method_details: NotRequired[
"ReceivedDebitCreateParamsInitiatingPaymentMethodDetails"
]
"""
Initiating payment method details for the object.
"""
network: Literal["ach"]
"""
Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
"""
class ReceivedDebitCreateParamsInitiatingPaymentMethodDetails(TypedDict):
type: Literal["us_bank_account"]
"""
The source type.
"""
us_bank_account: NotRequired[
"ReceivedDebitCreateParamsInitiatingPaymentMethodDetailsUsBankAccount"
]
"""
Optional fields for `us_bank_account`.
"""
class ReceivedDebitCreateParamsInitiatingPaymentMethodDetailsUsBankAccount(
TypedDict,
):
account_holder_name: NotRequired[str]
"""
The bank account holder's name.
"""
account_number: NotRequired[str]
"""
The bank account number.
"""
routing_number: NotRequired[str]
"""
The bank account's routing number.
"""