stripe_api library
Classes
- AuBecsDebit
- AubecsDebit data associated with the payment method
- BacsDebit
- BacsDebit data associated with the payment method
- BankAccountToken
- BillingAddress
- BillingDetails
- Billing information associated with the payment method.
- BillingDetailsFields
- CardElementChangeEvent
- CardElementChangeEventValue
- CardElementClasses
- CardElementOptions
- CardPaymentMethod
- Card data associated with the payment method
- CardPaymentMethodDetails
- CardToken
- CardTokenPaymentMethod
- ConfirmAcssDebitPaymentData
- ConfirmAcssDebitPaymentOptions
- ConfirmAlipayPaymentData
- ConfirmAlipayPaymentOptions
- ConfirmCardPaymentData
- ConfirmCardPaymentOptions
- ConfirmCardSetupData
- ConfirmCardSetupOptions
- ConfirmIdealPaymentData
- ConfirmIdealPaymentOptions
- ConfirmP24PaymentData
- ConfirmP24PaymentOptions
- ConfirmPaymentOptions
- ConfirmPaymentParams
- ConfirmSepaDebitPaymentData
- ConfirmSepaDebitSetupData
- ConfirmSetupOptions
- ConfirmSetupParams
- CreatePaymentMethodData
- CreateTokenBankAccountData
- CreateTokenCardData
- CreateTokenPIIData
- ElementAppearance
- Appareance options for the Payment Element and other elements. https://stripe.com/docs/elements/appearance-api
- ExpressCheckoutButtonTheme
- The theme of the express checkout button
- ExpressCheckoutButtonType
- Specify the preferred button type to display.
- ExpressCheckoutConfirmEvent
- Confirm parameters from the express checkout element
- ExpressCheckoutLayout
- Layout parameters of the express checkout element
- ExpressCheckoutOptions
- Options for the express checkout element
- ExpressCheckoutPaymentMethods
- The layout of the express checkout button
- Fpx
- Ideal
- Ideal data associated with the payment method
- IdealBankData
- An object detailing the customer's iDEAL bank.
- IdealPaymentMethodDetails
- IdPaymentMethodDetails
- P24PaymentMethodDetails
- PaymentElementAddressFields
- PaymentElementApplePayAutoReloadPaymentRequest
- PaymentElementApplePayDeferredPaymentProperties
- PaymentElementApplePayDeferredPaymentRequest
- PaymentElementApplePayOptions
- PaymentElementApplePayReloadPaymentProperties
- PaymentElementAppleRecurringRequest
- PaymentElementBillingDetails
- PaymentElementBillingDetailsAddress
- PaymentElementBusiness
- PaymentElementCardDefaults
- PaymentElementChangeEvent
- PaymentElementChangeEventValue
- PaymentElementDefaultValues
- PaymentElementFields
- PaymentElementIdealDefaults
- PaymentElementLayout
- Specify the layout for the Payment Element. If you only pass a layout type ('accordion' or ‘tabs’) without any additional parameters, t he Payment Element renders using that layout and the default values associated with it.
- PaymentElementOptions
- PaymentElementOptionsTerms
- Control how mandates or other legal agreements are displayed in the Payment Element. The default setting is auto, which causes legal agreements to only be shown when necessary.
- PaymentElementPaymentMethodDefaults
- PaymentElementRecurringPaymentProperties
- PaymentElementShippingDetails
- PaymentElementWalletOptions
- By default, the Payment Element will display all the payment methods that the underlying Payment Intent was created with. However, wallets like Apple Pay and Google Pay are not payment methods per the Payment Intent API. They will show when the Payment Intent has the card payment method and the customer is using a supported platform and have an active card in their account. This is the auto behavior, and it is the default for choice for all wallets. If you do not want to show a given wallet as a payment option, you can set its property in wallets to never.
- PaymentIntent
- A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system.
- PaymentIntentAmountDetails
- PaymentIntentAutomaticPaymentMethods
- PaymentIntentResponse
- PaymentIntentTip
- PaymentMethod
- PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.
- PaymentMethodData
- Generic payment method data object that holds the billingdetails.
- PaymentMethodDataAfterPay
- Payment method data object for Afterpay / clearpay payment method.
- PaymentMethodDataAubecs
- Payment method data object for Aubecs payment method.
- PaymentMethodDataCardFromMethod
- Payment method data object for card from payment method.
- PaymentMethodDataCardFromToken
- Payment method data object for card with token payment method.
- PaymentMethodDataFpx
- Payment method data object for Fpx payment method.
- PaymentMethodDataIdeal
- Payment method data object for ideal payment method.
- PaymentMethodDataSepa
- Payment method data object for Sepa debit payment method.
- PaymentMethodDataSofort
- Payment method data object for Sofort payment method.
- PaymentMethodDataUsBank
- Payment method data object forUsbankaccount payment method.
- PaymentMethodDetails
- Abstraction for details of a payment method. In general this can be just the identifier of the payment method, or be a class that contains more information depending on the payment type.
- PaymentMethodParams
- Parameters that specify the desired configuration of a specific payment method.
- PaymentMethodResponse
- SepaBillingDetails
- Billing information associated with the payment method.
- SepaDebit
- SepaDebit data associated with the payment method
- SepaDebitIbanData
- SepaDebitPaymentMethodDetails
- SetupIntent
- A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.
- SetupIntentResponse
- ShippingDetails
- ShippingDetailsAddress
- StripeError
- Token
- Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. You should use our recommended payments integrations to perform this process client-side. T his ensures that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.
- TokenResponse
- Upi
- Upi data associated with the payment method.
- UsBankAccount
- Data associated with the payment method Us bank account.
Enums
- ApplePayRecurringPaymentTimeInterVal
- BankAccountHolderType
- BankAccountStatus
- CardElementIconStyle
- CardFundingType
- CardTokenBrand
- CardTokenizationMethod
- ElementAppearanceLabels
- Enables switching between labels above form fields and floating labels within the form fields
- ElementTheme
- ExpressApplePayButtonTheme
- The theme of the apple pay button
- ExpressApplePayButtonType
- The type of apple pay button to display
- ExpressCheckoutOverflow
- The layout of the express checkout button
- ExpressGooglePayButtonTheme
- The theme of the google pay button
- ExpressGooglePayButtonType
- The type of google pay button to display
- ExpressPaymentNethodEnabled
- Whether or not to display the payment method
- ExpressPaypalButtonTheme
- The theme of the paypal button
- ExpressPaypalButtonType
- The type of paypal button to display
- PaymentConfirmationRedirect
- By default, stripe.confirmPayment will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmPayment will only redirect if your user chooses a redirect-based payment method.
- PaymentElementFieldRequired
- PaymentElementLayoutType
- PaymentElementShowTerms
- PaymentIntentCancellationReason
- Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
- PaymentIntentCaptureMethod
- Controls when the funds will be captured from the customer’s account.
- PaymentIntentConfirmationMethod
- PaymentIntentSetupFutureUsage
- PaymentIntentsStatus
- Status of the payment intent.
- PaymentMethodType
- 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.
- SetupConfirmationRedirect
- By default, stripe.confirmPayment will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmPayment will only redirect if your user chooses a redirect-based payment method.
- SetupIntentCancellationReason
- Reason for cancellation of this SetupIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
- SetupIntentFlowDirections
- Indicates the directions of money movement for which this payment method is intended to be used.
- SetupIntentsStatus
- Status of the setup intent.
- SetupIntentUsage
- TokenType
- UsBankAccountHolderType
- UsBankAccountType
- VerificationCheck
Extensions
- AuBecsDebitPatterns on AuBecsDebit
- Adds pattern-matching-related methods to AuBecsDebit.
- BacsDebitPatterns on BacsDebit
- Adds pattern-matching-related methods to BacsDebit.
- BankAccountTokenPatterns on BankAccountToken
- Adds pattern-matching-related methods to BankAccountToken.
- BillingAddressPatterns on BillingAddress
- Adds pattern-matching-related methods to BillingAddress.
- BillingDetailsFieldsPatterns on BillingDetailsFields
- Adds pattern-matching-related methods to BillingDetailsFields.
- BillingDetailsPatterns on BillingDetails
- Adds pattern-matching-related methods to BillingDetails.
- CardElementChangeEventPatterns on CardElementChangeEvent
- Adds pattern-matching-related methods to CardElementChangeEvent.
- CardElementChangeEventValuePatterns on CardElementChangeEventValue
- Adds pattern-matching-related methods to CardElementChangeEventValue.
- CardElementClassesPatterns on CardElementClasses
- Adds pattern-matching-related methods to CardElementClasses.
- CardElementOptionsPatterns on CardElementOptions
- Adds pattern-matching-related methods to CardElementOptions.
- CardPaymentMethodDetailsPatterns on CardPaymentMethodDetails
- Adds pattern-matching-related methods to CardPaymentMethodDetails.
- CardPaymentMethodPatterns on CardPaymentMethod
- Adds pattern-matching-related methods to CardPaymentMethod.
- CardTokenPatterns on CardToken
- Adds pattern-matching-related methods to CardToken.
- CardTokenPaymentMethodPatterns on CardTokenPaymentMethod
- Adds pattern-matching-related methods to CardTokenPaymentMethod.
- ConfirmAcssDebitPaymentDataPatterns on ConfirmAcssDebitPaymentData
- Adds pattern-matching-related methods to ConfirmAcssDebitPaymentData.
- ConfirmAcssDebitPaymentOptionsPatterns on ConfirmAcssDebitPaymentOptions
- Adds pattern-matching-related methods to ConfirmAcssDebitPaymentOptions.
- ConfirmAlipayPaymentDataPatterns on ConfirmAlipayPaymentData
- Adds pattern-matching-related methods to ConfirmAlipayPaymentData.
- ConfirmAlipayPaymentOptionsPatterns on ConfirmAlipayPaymentOptions
- Adds pattern-matching-related methods to ConfirmAlipayPaymentOptions.
- ConfirmCardPaymentDataPatterns on ConfirmCardPaymentData
- Adds pattern-matching-related methods to ConfirmCardPaymentData.
- ConfirmCardPaymentOptionsPatterns on ConfirmCardPaymentOptions
- Adds pattern-matching-related methods to ConfirmCardPaymentOptions.
- ConfirmCardSetupDataPatterns on ConfirmCardSetupData
- Adds pattern-matching-related methods to ConfirmCardSetupData.
- ConfirmCardSetupOptionsPatterns on ConfirmCardSetupOptions
- Adds pattern-matching-related methods to ConfirmCardSetupOptions.
- ConfirmIdealPaymentDataPatterns on ConfirmIdealPaymentData
- Adds pattern-matching-related methods to ConfirmIdealPaymentData.
- ConfirmIdealPaymentOptionsPatterns on ConfirmIdealPaymentOptions
- Adds pattern-matching-related methods to ConfirmIdealPaymentOptions.
- ConfirmP24PaymentDataPatterns on ConfirmP24PaymentData
- Adds pattern-matching-related methods to ConfirmP24PaymentData.
- ConfirmP24PaymentOptionsPatterns on ConfirmP24PaymentOptions
- Adds pattern-matching-related methods to ConfirmP24PaymentOptions.
- ConfirmPaymentOptionsPatterns on ConfirmPaymentOptions
- Adds pattern-matching-related methods to ConfirmPaymentOptions.
- ConfirmPaymentParamsPatterns on ConfirmPaymentParams
- Adds pattern-matching-related methods to ConfirmPaymentParams.
- ConfirmSepaDebitPaymentDataPatterns on ConfirmSepaDebitPaymentData
- Adds pattern-matching-related methods to ConfirmSepaDebitPaymentData.
- ConfirmSepaDebitSetupDataPatterns on ConfirmSepaDebitSetupData
- Adds pattern-matching-related methods to ConfirmSepaDebitSetupData.
- ConfirmSetupOptionsPatterns on ConfirmSetupOptions
- Adds pattern-matching-related methods to ConfirmSetupOptions.
- ConfirmSetupParamsPatterns on ConfirmSetupParams
- Adds pattern-matching-related methods to ConfirmSetupParams.
- CreatePaymentMethodDataPatterns on CreatePaymentMethodData
- Adds pattern-matching-related methods to CreatePaymentMethodData.
- CreateTokenBankAccountDataPatterns on CreateTokenBankAccountData
- Adds pattern-matching-related methods to CreateTokenBankAccountData.
- CreateTokenCardDataPatterns on CreateTokenCardData
- Adds pattern-matching-related methods to CreateTokenCardData.
- CreateTokenPIIDataPatterns on CreateTokenPIIData
- Adds pattern-matching-related methods to CreateTokenPIIData.
- ElementAppearancePatterns on ElementAppearance
- Adds pattern-matching-related methods to ElementAppearance.
- ExpressCheckoutButtonThemePatterns on ExpressCheckoutButtonTheme
- Adds pattern-matching-related methods to ExpressCheckoutButtonTheme.
- ExpressCheckoutButtonTypePatterns on ExpressCheckoutButtonType
- Adds pattern-matching-related methods to ExpressCheckoutButtonType.
- ExpressCheckoutConfirmEventPatterns on ExpressCheckoutConfirmEvent
- Adds pattern-matching-related methods to ExpressCheckoutConfirmEvent.
- ExpressCheckoutLayoutPatterns on ExpressCheckoutLayout
- Adds pattern-matching-related methods to ExpressCheckoutLayout.
- ExpressCheckoutOptionsPatterns on ExpressCheckoutOptions
- Adds pattern-matching-related methods to ExpressCheckoutOptions.
- ExpressCheckoutPaymentMethodsPatterns on ExpressCheckoutPaymentMethods
- Adds pattern-matching-related methods to ExpressCheckoutPaymentMethods.
- FpxPatterns on Fpx
- Adds pattern-matching-related methods to Fpx.
- IdealBankDataPatterns on IdealBankData
- Adds pattern-matching-related methods to IdealBankData.
- IdealPatterns on Ideal
- Adds pattern-matching-related methods to Ideal.
- IdealPaymentMethodDetailsPatterns on IdealPaymentMethodDetails
- Adds pattern-matching-related methods to IdealPaymentMethodDetails.
- P24PaymentMethodDetailsPatterns on P24PaymentMethodDetails
- Adds pattern-matching-related methods to P24PaymentMethodDetails.
- PaymentElementAddressFieldsPatterns on PaymentElementAddressFields
- Adds pattern-matching-related methods to PaymentElementAddressFields.
- PaymentElementApplePayAutoReloadPaymentRequestPatterns on PaymentElementApplePayAutoReloadPaymentRequest
- Adds pattern-matching-related methods to PaymentElementApplePayAutoReloadPaymentRequest.
- PaymentElementApplePayDeferredPaymentPropertiesPatterns on PaymentElementApplePayDeferredPaymentProperties
- Adds pattern-matching-related methods to PaymentElementApplePayDeferredPaymentProperties.
- PaymentElementApplePayDeferredPaymentRequestPatterns on PaymentElementApplePayDeferredPaymentRequest
- Adds pattern-matching-related methods to PaymentElementApplePayDeferredPaymentRequest.
- PaymentElementApplePayOptionsPatterns on PaymentElementApplePayOptions
- Adds pattern-matching-related methods to PaymentElementApplePayOptions.
- PaymentElementApplePayReloadPaymentPropertiesPatterns on PaymentElementApplePayReloadPaymentProperties
- Adds pattern-matching-related methods to PaymentElementApplePayReloadPaymentProperties.
- PaymentElementAppleRecurringRequestPatterns on PaymentElementAppleRecurringRequest
- Adds pattern-matching-related methods to PaymentElementAppleRecurringRequest.
- PaymentElementBillingDetailsAddressPatterns on PaymentElementBillingDetailsAddress
- Adds pattern-matching-related methods to PaymentElementBillingDetailsAddress.
- PaymentElementBillingDetailsPatterns on PaymentElementBillingDetails
- Adds pattern-matching-related methods to PaymentElementBillingDetails.
- PaymentElementBusinessPatterns on PaymentElementBusiness
- Adds pattern-matching-related methods to PaymentElementBusiness.
- PaymentElementCardDefaultsPatterns on PaymentElementCardDefaults
- Adds pattern-matching-related methods to PaymentElementCardDefaults.
- PaymentElementChangeEventPatterns on PaymentElementChangeEvent
- Adds pattern-matching-related methods to PaymentElementChangeEvent.
- PaymentElementChangeEventValuePatterns on PaymentElementChangeEventValue
- Adds pattern-matching-related methods to PaymentElementChangeEventValue.
- PaymentElementDefaultValuesPatterns on PaymentElementDefaultValues
- Adds pattern-matching-related methods to PaymentElementDefaultValues.
- PaymentElementFieldsPatterns on PaymentElementFields
- Adds pattern-matching-related methods to PaymentElementFields.
- PaymentElementIdealDefaultsPatterns on PaymentElementIdealDefaults
- Adds pattern-matching-related methods to PaymentElementIdealDefaults.
- PaymentElementLayoutPatterns on PaymentElementLayout
- Adds pattern-matching-related methods to PaymentElementLayout.
- PaymentElementOptionsPatterns on PaymentElementOptions
- Adds pattern-matching-related methods to PaymentElementOptions.
- PaymentElementOptionsTermsPatterns on PaymentElementOptionsTerms
- Adds pattern-matching-related methods to PaymentElementOptionsTerms.
- PaymentElementPaymentMethodDefaultsPatterns on PaymentElementPaymentMethodDefaults
- Adds pattern-matching-related methods to PaymentElementPaymentMethodDefaults.
- PaymentElementRecurringPaymentPropertiesPatterns on PaymentElementRecurringPaymentProperties
- Adds pattern-matching-related methods to PaymentElementRecurringPaymentProperties.
- PaymentElementShippingDetailsPatterns on PaymentElementShippingDetails
- Adds pattern-matching-related methods to PaymentElementShippingDetails.
- PaymentElementWalletOptionsPatterns on PaymentElementWalletOptions
- Adds pattern-matching-related methods to PaymentElementWalletOptions.
- PaymentIntentAmountDetailsPatterns on PaymentIntentAmountDetails
- Adds pattern-matching-related methods to PaymentIntentAmountDetails.
- PaymentIntentAutomaticPaymentMethodsPatterns on PaymentIntentAutomaticPaymentMethods
- Adds pattern-matching-related methods to PaymentIntentAutomaticPaymentMethods.
- PaymentIntentPatterns on PaymentIntent
- Adds pattern-matching-related methods to PaymentIntent.
- PaymentIntentResponsePatterns on PaymentIntentResponse
- Adds pattern-matching-related methods to PaymentIntentResponse.
- PaymentIntentTipPatterns on PaymentIntentTip
- Adds pattern-matching-related methods to PaymentIntentTip.
- PaymentMethodDataAfterPayPatterns on PaymentMethodDataAfterPay
- Adds pattern-matching-related methods to PaymentMethodDataAfterPay.
- PaymentMethodDataAubecsPatterns on PaymentMethodDataAubecs
- Adds pattern-matching-related methods to PaymentMethodDataAubecs.
- PaymentMethodDataCardFromMethodPatterns on PaymentMethodDataCardFromMethod
- Adds pattern-matching-related methods to PaymentMethodDataCardFromMethod.
- PaymentMethodDataCardFromTokenPatterns on PaymentMethodDataCardFromToken
- Adds pattern-matching-related methods to PaymentMethodDataCardFromToken.
- PaymentMethodDataFpxPatterns on PaymentMethodDataFpx
- Adds pattern-matching-related methods to PaymentMethodDataFpx.
- PaymentMethodDataIdealPatterns on PaymentMethodDataIdeal
- Adds pattern-matching-related methods to PaymentMethodDataIdeal.
- PaymentMethodDataPatterns on PaymentMethodData
- Adds pattern-matching-related methods to PaymentMethodData.
- PaymentMethodDataSepaPatterns on PaymentMethodDataSepa
- Adds pattern-matching-related methods to PaymentMethodDataSepa.
- PaymentMethodDataSofortPatterns on PaymentMethodDataSofort
- Adds pattern-matching-related methods to PaymentMethodDataSofort.
- PaymentMethodDataUsBankPatterns on PaymentMethodDataUsBank
- Adds pattern-matching-related methods to PaymentMethodDataUsBank.
- PaymentMethodParamsPatterns on PaymentMethodParams
- Adds pattern-matching-related methods to PaymentMethodParams.
- PaymentMethodPatterns on PaymentMethod
- Adds pattern-matching-related methods to PaymentMethod.
- PaymentMethodResponsePatterns on PaymentMethodResponse
- Adds pattern-matching-related methods to PaymentMethodResponse.
- SepaBillingDetailsPatterns on SepaBillingDetails
- Adds pattern-matching-related methods to SepaBillingDetails.
- SepaDebitIbanDataPatterns on SepaDebitIbanData
- Adds pattern-matching-related methods to SepaDebitIbanData.
- SepaDebitPatterns on SepaDebit
- Adds pattern-matching-related methods to SepaDebit.
- SepaDebitPaymentMethodDetailsPatterns on SepaDebitPaymentMethodDetails
- Adds pattern-matching-related methods to SepaDebitPaymentMethodDetails.
- SetupIntentPatterns on SetupIntent
- Adds pattern-matching-related methods to SetupIntent.
- SetupIntentResponsePatterns on SetupIntentResponse
- Adds pattern-matching-related methods to SetupIntentResponse.
- ShippingDetailsAddressPatterns on ShippingDetailsAddress
- Adds pattern-matching-related methods to ShippingDetailsAddress.
- ShippingDetailsPatterns on ShippingDetails
- Adds pattern-matching-related methods to ShippingDetails.
- StripeErrorPatterns on StripeError
- Adds pattern-matching-related methods to StripeError.
- TokenPatterns on Token
- Adds pattern-matching-related methods to Token.
- TokenResponsePatterns on TokenResponse
- Adds pattern-matching-related methods to TokenResponse.
- UpiPatterns on Upi
- Adds pattern-matching-related methods to Upi.
- UsBankAccountPatterns on UsBankAccount
- Adds pattern-matching-related methods to UsBankAccount.