stripe 19.2.1 → 19.3.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1686 -15
- package/OPENAPI_VERSION +1 -1
- package/README.md +1 -0
- package/VERSION +1 -1
- package/cjs/Error.js +115 -1
- package/cjs/RequestSender.js +1 -1
- package/cjs/apiVersion.js +2 -3
- package/cjs/resources/AccountNotices.js +21 -0
- package/cjs/resources/Billing/Analytics/MeterUsage.js +12 -0
- package/cjs/resources/Capital/FinancingOffers.js +21 -0
- package/cjs/resources/Capital/FinancingSummary.js +12 -0
- package/cjs/resources/Capital/FinancingTransactions.js +17 -0
- package/cjs/resources/DelegatedCheckout/RequestedSessions.js +28 -0
- package/cjs/resources/ExternalAccounts.js +23 -0
- package/cjs/resources/FinancialConnections/Accounts.js +5 -0
- package/cjs/resources/FinancialConnections/Institutions.js +17 -0
- package/cjs/resources/FxQuotes.js +15 -0
- package/cjs/resources/Identity/BlocklistEntries.js +25 -0
- package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
- package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
- package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
- package/cjs/resources/Mandates.js +5 -0
- package/cjs/resources/Margins.js +22 -0
- package/cjs/resources/Orders.js +24 -0
- package/cjs/resources/PaymentIntents.js +8 -0
- package/cjs/resources/PaymentMethods.js +4 -0
- package/cjs/resources/Privacy/RedactionJobs.js +42 -0
- package/cjs/resources/Quotes.js +32 -0
- package/cjs/resources/SubscriptionSchedules.js +4 -0
- package/cjs/resources/Subscriptions.js +4 -0
- package/cjs/resources/Tax/Associations.js +9 -0
- package/cjs/resources/Tax/Forms.js +20 -0
- package/cjs/resources/Terminal/OnboardingLinks.js +12 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
- package/cjs/resources/V2/Billing/BillSettings/Versions.js +17 -0
- package/cjs/resources/V2/Billing/BillSettings.js +27 -0
- package/cjs/resources/V2/Billing/Cadences.js +23 -0
- package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +17 -0
- package/cjs/resources/V2/Billing/CollectionSettings.js +30 -0
- package/cjs/resources/V2/Billing/CustomPricingUnits.js +25 -0
- package/cjs/resources/V2/Billing/Intents/Actions.js +17 -0
- package/cjs/resources/V2/Billing/Intents.js +36 -0
- package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +12 -0
- package/cjs/resources/V2/Billing/LicenseFees/Versions.js +17 -0
- package/cjs/resources/V2/Billing/LicenseFees.js +27 -0
- package/cjs/resources/V2/Billing/LicensedItems.js +25 -0
- package/cjs/resources/V2/Billing/MeteredItems.js +22 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions/Components.js +12 -0
- package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +26 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js +29 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js +17 -0
- package/cjs/resources/V2/Billing/PricingPlans.js +29 -0
- package/cjs/resources/V2/Billing/Profiles.js +19 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js +29 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js +25 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js +17 -0
- package/cjs/resources/V2/Billing/RateCards.js +29 -0
- package/cjs/resources/V2/Billing/ServiceActions.js +20 -0
- package/cjs/resources/V2/Core/AccountLinks.js +9 -0
- package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
- package/cjs/resources/V2/Core/Accounts.js +25 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js +16 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +33 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +37 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +29 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
- package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
- package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
- package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
- package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
- package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
- package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
- package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +20 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +29 -0
- package/cjs/resources/V2/Tax/AutomaticRules.js +22 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +12 -0
- package/cjs/resources.js +142 -8
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +100 -0
- package/esm/RequestSender.js +1 -1
- package/esm/apiVersion.js +1 -2
- package/esm/resources/AccountNotices.js +18 -0
- package/esm/resources/Billing/Analytics/MeterUsage.js +9 -0
- package/esm/resources/Capital/FinancingOffers.js +18 -0
- package/esm/resources/Capital/FinancingSummary.js +9 -0
- package/esm/resources/Capital/FinancingTransactions.js +14 -0
- package/esm/resources/DelegatedCheckout/RequestedSessions.js +25 -0
- package/esm/resources/ExternalAccounts.js +20 -0
- package/esm/resources/FinancialConnections/Accounts.js +5 -0
- package/esm/resources/FinancialConnections/Institutions.js +14 -0
- package/esm/resources/FxQuotes.js +12 -0
- package/esm/resources/Identity/BlocklistEntries.js +22 -0
- package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
- package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
- package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
- package/esm/resources/Mandates.js +5 -0
- package/esm/resources/Margins.js +19 -0
- package/esm/resources/Orders.js +21 -0
- package/esm/resources/PaymentIntents.js +8 -0
- package/esm/resources/PaymentMethods.js +4 -0
- package/esm/resources/Privacy/RedactionJobs.js +39 -0
- package/esm/resources/Quotes.js +32 -0
- package/esm/resources/SubscriptionSchedules.js +4 -0
- package/esm/resources/Subscriptions.js +4 -0
- package/esm/resources/Tax/Associations.js +6 -0
- package/esm/resources/Tax/Forms.js +17 -0
- package/esm/resources/Terminal/OnboardingLinks.js +9 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
- package/esm/resources/V2/Billing/BillSettings/Versions.js +14 -0
- package/esm/resources/V2/Billing/BillSettings.js +24 -0
- package/esm/resources/V2/Billing/Cadences.js +20 -0
- package/esm/resources/V2/Billing/CollectionSettings/Versions.js +14 -0
- package/esm/resources/V2/Billing/CollectionSettings.js +27 -0
- package/esm/resources/V2/Billing/CustomPricingUnits.js +22 -0
- package/esm/resources/V2/Billing/Intents/Actions.js +14 -0
- package/esm/resources/V2/Billing/Intents.js +33 -0
- package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +9 -0
- package/esm/resources/V2/Billing/LicenseFees/Versions.js +14 -0
- package/esm/resources/V2/Billing/LicenseFees.js +24 -0
- package/esm/resources/V2/Billing/LicensedItems.js +22 -0
- package/esm/resources/V2/Billing/MeteredItems.js +19 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions/Components.js +9 -0
- package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +23 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js +26 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js +14 -0
- package/esm/resources/V2/Billing/PricingPlans.js +26 -0
- package/esm/resources/V2/Billing/Profiles.js +16 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js +26 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js +22 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js +14 -0
- package/esm/resources/V2/Billing/RateCards.js +26 -0
- package/esm/resources/V2/Billing/ServiceActions.js +17 -0
- package/esm/resources/V2/Core/AccountLinks.js +6 -0
- package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
- package/esm/resources/V2/Core/Accounts.js +22 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js +13 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +30 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +34 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +26 -0
- package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
- package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
- package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
- package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
- package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
- package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
- package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
- package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
- package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
- package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +17 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +26 -0
- package/esm/resources/V2/Tax/AutomaticRules.js +19 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +9 -0
- package/esm/resources.js +129 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +5 -1
- package/types/AccountNotices.d.ts +113 -0
- package/types/AccountNoticesResource.d.ts +98 -0
- package/types/AccountSessions.d.ts +45 -0
- package/types/AccountSessionsResource.d.ts +264 -0
- package/types/Accounts.d.ts +214 -1
- package/types/AccountsResource.d.ts +544 -0
- package/types/ApplicationFees.d.ts +6 -1
- package/types/Balance.d.ts +82 -0
- package/types/BalanceTransactions.d.ts +2 -1
- package/types/BankAccounts.d.ts +2 -0
- package/types/Billing/AlertTriggereds.d.ts +16 -1
- package/types/Billing/Alerts.d.ts +116 -1
- package/types/Billing/AlertsResource.d.ts +149 -2
- package/types/Billing/Analytics/MeterUsage.d.ts +31 -0
- package/types/Billing/Analytics/MeterUsageResource.d.ts +694 -0
- package/types/Billing/Analytics/MeterUsageRows.d.ts +58 -0
- package/types/Billing/CreditBalanceSummary.d.ts +123 -2
- package/types/Billing/CreditBalanceSummaryResource.d.ts +20 -3
- package/types/Billing/CreditBalanceTransactions.d.ts +118 -2
- package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
- package/types/Billing/CreditGrants.d.ts +76 -1
- package/types/Billing/CreditGrantsResource.d.ts +45 -4
- package/types/Billing/MeterEventSummaries.d.ts +7 -0
- package/types/Billing/Meters.d.ts +5 -0
- package/types/Billing/MetersResource.d.ts +17 -0
- package/types/BillingPortal/Sessions.d.ts +5 -0
- package/types/BillingPortal/SessionsResource.d.ts +12 -4
- package/types/Capabilities.d.ts +2 -0
- package/types/Capital/FinancingOffers.d.ts +188 -0
- package/types/Capital/FinancingOffersResource.d.ts +97 -0
- package/types/Capital/FinancingSummary.d.ts +106 -0
- package/types/Capital/FinancingSummaryResource.d.ts +27 -0
- package/types/Capital/FinancingTransactions.d.ts +135 -0
- package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
- package/types/Cards.d.ts +19 -0
- package/types/CashBalances.d.ts +5 -0
- package/types/Charges.d.ts +185 -0
- package/types/ChargesResource.d.ts +1406 -0
- package/types/Checkout/Sessions.d.ts +427 -2
- package/types/Checkout/SessionsResource.d.ts +682 -2
- package/types/ConfirmationTokens.d.ts +139 -0
- package/types/Coupons.d.ts +33 -0
- package/types/CouponsResource.d.ts +21 -0
- package/types/CreditNoteLineItems.d.ts +17 -0
- package/types/CreditNotes.d.ts +5 -0
- package/types/CreditNotesResource.d.ts +5 -0
- package/types/CustomerBalanceTransactions.d.ts +2 -0
- package/types/CustomerCashBalanceTransactions.d.ts +2 -0
- package/types/CustomerSessions.d.ts +46 -0
- package/types/CustomerSessionsResource.d.ts +47 -1
- package/types/Customers.d.ts +2 -0
- package/types/CustomersResource.d.ts +8 -0
- package/types/DelegatedCheckout/RequestedSessions.d.ts +360 -0
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +593 -0
- package/types/Discounts.d.ts +10 -0
- package/types/Disputes.d.ts +40 -0
- package/types/DisputesResource.d.ts +11 -0
- package/types/Errors.d.ts +85 -0
- package/types/EventTypes.d.ts +630 -0
- package/types/Events.d.ts +95 -0
- package/types/ExternalAccountsResource.d.ts +304 -0
- package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
- package/types/FinancialConnections/Accounts.d.ts +36 -1
- package/types/FinancialConnections/AccountsResource.d.ts +40 -3
- package/types/FinancialConnections/Institutions.d.ts +98 -0
- package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
- package/types/FinancialConnections/Sessions.d.ts +51 -1
- package/types/FinancialConnections/SessionsResource.d.ts +43 -1
- package/types/FxQuotes.d.ts +155 -0
- package/types/FxQuotesResource.d.ts +130 -0
- package/types/Identity/BlocklistEntries.d.ts +78 -0
- package/types/Identity/BlocklistEntriesResource.d.ts +146 -0
- package/types/Identity/VerificationReports.d.ts +10 -0
- package/types/Identity/VerificationReportsResource.d.ts +5 -0
- package/types/Identity/VerificationSessions.d.ts +5 -0
- package/types/Identity/VerificationSessionsResource.d.ts +7 -0
- package/types/InvoiceItems.d.ts +114 -2
- package/types/InvoiceItemsResource.d.ts +117 -6
- package/types/InvoiceLineItems.d.ts +158 -3
- package/types/InvoicePayments.d.ts +1 -1
- package/types/Invoices.d.ts +203 -4
- package/types/InvoicesResource.d.ts +1625 -2
- package/types/Issuing/CardholdersResource.d.ts +2 -1
- package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
- package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
- package/types/Issuing/Settlements.d.ts +113 -0
- package/types/Issuing/Transactions.d.ts +5 -0
- package/types/Issuing/TransactionsResource.d.ts +5 -0
- package/types/LineItems.d.ts +49 -0
- package/types/Mandates.d.ts +135 -1
- package/types/MandatesResource.d.ts +31 -0
- package/types/Margins.d.ts +56 -0
- package/types/MarginsResource.d.ts +114 -0
- package/types/Orders.d.ts +1163 -0
- package/types/OrdersResource.d.ts +3139 -0
- package/types/PaymentAttemptRecords.d.ts +141 -0
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +7 -13
- package/types/PaymentIntents.d.ts +807 -20
- package/types/PaymentIntentsResource.d.ts +9765 -4959
- package/types/PaymentLinks.d.ts +6 -0
- package/types/PaymentLinksResource.d.ts +12 -0
- package/types/PaymentMethodBalances.d.ts +63 -0
- package/types/PaymentMethodConfigurations.d.ts +216 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +300 -0
- package/types/PaymentMethods.d.ts +144 -0
- package/types/PaymentMethodsResource.d.ts +187 -2
- package/types/PaymentRecords.d.ts +141 -0
- package/types/Persons.d.ts +2 -0
- package/types/Prices.d.ts +22 -0
- package/types/PricesResource.d.ts +22 -0
- package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
- package/types/Privacy/RedactionJobs.d.ts +111 -0
- package/types/Privacy/RedactionJobsResource.d.ts +230 -0
- package/types/PromotionCodes.d.ts +5 -0
- package/types/PromotionCodesResource.d.ts +10 -0
- package/types/QuoteLines.d.ts +634 -0
- package/types/QuotePreviewInvoices.d.ts +1771 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +908 -0
- package/types/Quotes.d.ts +594 -1
- package/types/QuotesResource.d.ts +2588 -243
- package/types/Refunds.d.ts +14 -0
- package/types/SetupAttempts.d.ts +51 -1
- package/types/SetupIntents.d.ts +239 -2
- package/types/SetupIntentsResource.d.ts +1044 -4
- package/types/Sources.d.ts +29 -0
- package/types/SubscriptionItems.d.ts +26 -0
- package/types/SubscriptionItemsResource.d.ts +109 -0
- package/types/SubscriptionSchedules.d.ts +205 -0
- package/types/SubscriptionSchedulesResource.d.ts +1233 -5
- package/types/Subscriptions.d.ts +262 -1
- package/types/SubscriptionsResource.d.ts +745 -8
- package/types/Tax/Associations.d.ts +82 -0
- package/types/Tax/AssociationsResource.d.ts +29 -0
- package/types/Tax/Forms.d.ts +220 -0
- package/types/Tax/FormsResource.d.ts +107 -0
- package/types/TaxIds.d.ts +10 -0
- package/types/TaxIdsResource.d.ts +10 -0
- package/types/Terminal/Configurations.d.ts +9 -0
- package/types/Terminal/ConfigurationsResource.d.ts +28 -0
- package/types/Terminal/OnboardingLinks.d.ts +57 -0
- package/types/Terminal/OnboardingLinksResource.d.ts +62 -0
- package/types/Terminal/ReaderCollectedData.d.ts +51 -0
- package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
- package/types/Terminal/Readers.d.ts +20 -0
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
- package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
- package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
- package/types/Transfers.d.ts +9 -0
- package/types/TransfersResource.d.ts +7 -0
- package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
- package/types/Treasury/FinancialAccounts.d.ts +5 -0
- package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
- package/types/Treasury/OutboundTransfers.d.ts +26 -0
- package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
- package/types/Treasury/ReceivedCredits.d.ts +26 -0
- package/types/Treasury/ReceivedDebits.d.ts +31 -0
- package/types/V2/Billing/BillSettingVersions.d.ts +97 -0
- package/types/V2/Billing/BillSettings/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/BillSettings.d.ts +120 -0
- package/types/V2/Billing/BillSettingsResource.d.ts +241 -0
- package/types/V2/Billing/Cadences.d.ts +731 -0
- package/types/V2/Billing/CadencesResource.d.ts +516 -0
- package/types/V2/Billing/CollectionSettingVersions.d.ts +314 -0
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
- package/types/V2/Billing/CollectionSettings.d.ts +337 -0
- package/types/V2/Billing/CollectionSettingsResource.d.ts +675 -0
- package/types/V2/Billing/CustomPricingUnits.d.ts +56 -0
- package/types/V2/Billing/CustomPricingUnitsResource.d.ts +122 -0
- package/types/V2/Billing/IntentActions.d.ts +459 -0
- package/types/V2/Billing/Intents/ActionsResource.d.ts +58 -0
- package/types/V2/Billing/Intents.d.ts +117 -0
- package/types/V2/Billing/IntentsResource.d.ts +575 -0
- package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +64 -0
- package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +28 -0
- package/types/V2/Billing/LicenseFeeVersions.d.ts +106 -0
- package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/LicenseFees.d.ts +164 -0
- package/types/V2/Billing/LicenseFeesResource.d.ts +290 -0
- package/types/V2/Billing/LicensedItems.d.ts +73 -0
- package/types/V2/Billing/LicensedItemsResource.d.ts +157 -0
- package/types/V2/Billing/MeteredItems.d.ts +101 -0
- package/types/V2/Billing/MeteredItemsResource.d.ts +189 -0
- package/types/V2/Billing/PricingPlanComponents.d.ts +109 -0
- package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts +57 -0
- package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts +40 -0
- package/types/V2/Billing/PricingPlanSubscriptions.d.ts +144 -0
- package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +120 -0
- package/types/V2/Billing/PricingPlanVersions.d.ts +49 -0
- package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +197 -0
- package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/PricingPlans.d.ts +84 -0
- package/types/V2/Billing/PricingPlansResource.d.ts +151 -0
- package/types/V2/Billing/Profiles.d.ts +70 -0
- package/types/V2/Billing/ProfilesResource.d.ts +150 -0
- package/types/V2/Billing/RateCardRates.d.ts +144 -0
- package/types/V2/Billing/RateCardSubscriptions.d.ts +144 -0
- package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +157 -0
- package/types/V2/Billing/RateCardVersions.d.ts +39 -0
- package/types/V2/Billing/RateCards/RatesResource.d.ts +203 -0
- package/types/V2/Billing/RateCards/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/RateCards.d.ts +98 -0
- package/types/V2/Billing/RateCardsResource.d.ts +162 -0
- package/types/V2/Billing/ServiceActions.d.ts +274 -0
- package/types/V2/Billing/ServiceActionsResource.d.ts +370 -0
- package/types/V2/Core/AccountLinks.d.ts +168 -0
- package/types/V2/Core/AccountLinksResource.d.ts +152 -0
- package/types/V2/Core/AccountPersons.d.ts +615 -0
- package/types/V2/Core/Accounts/PersonsResource.d.ts +1153 -0
- package/types/V2/Core/Accounts.d.ts +7478 -0
- package/types/V2/Core/AccountsResource.d.ts +6723 -0
- package/types/V2/Core/ClaimableSandboxes.d.ts +132 -0
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +74 -0
- package/types/V2/Core/EventTypes.d.ts +8589 -10
- package/types/V2/Core/Events.d.ts +12 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +194 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +116 -0
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +198 -0
- package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
- package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
- package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +148 -0
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +172 -0
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +178 -0
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +126 -0
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +206 -0
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +170 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +283 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +247 -0
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +330 -0
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +256 -0
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +213 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +201 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +93 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +307 -0
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +186 -0
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
- package/types/V2/MoneyManagement/RecipientVerifications.d.ts +112 -0
- package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +77 -0
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +162 -0
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
- package/types/V2/MoneyManagement/Transactions.d.ts +177 -0
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
- package/types/V2/Payments/OffSessionPayments.d.ts +326 -0
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +401 -0
- package/types/V2/Tax/AutomaticRules.d.ts +53 -0
- package/types/V2/Tax/AutomaticRulesResource.d.ts +102 -0
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +73 -0
- package/types/V2/TestHelpers/MoneyManagementResource.d.ts +49 -0
- package/types/WebhookEndpointsResource.d.ts +74 -0
- package/types/Webhooks.d.ts +2 -0
- package/types/apiVersion.d.ts +1 -2
- package/types/index.d.ts +222 -0
- package/types/lib.d.ts +10 -0
|
@@ -34,6 +34,13 @@ declare module 'stripe' {
|
|
|
34
34
|
*/
|
|
35
35
|
customer?: string;
|
|
36
36
|
|
|
37
|
+
/**
|
|
38
|
+
* ID of the Account this SetupIntent belongs to, if one exists.
|
|
39
|
+
*
|
|
40
|
+
* If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
|
|
41
|
+
*/
|
|
42
|
+
customer_account?: string;
|
|
43
|
+
|
|
37
44
|
/**
|
|
38
45
|
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
39
46
|
*/
|
|
@@ -104,6 +111,11 @@ declare module 'stripe' {
|
|
|
104
111
|
*/
|
|
105
112
|
return_url?: string;
|
|
106
113
|
|
|
114
|
+
/**
|
|
115
|
+
* Provides industry-specific information about the SetupIntent.
|
|
116
|
+
*/
|
|
117
|
+
setup_details?: SetupIntentCreateParams.SetupDetails;
|
|
118
|
+
|
|
107
119
|
/**
|
|
108
120
|
* If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.
|
|
109
121
|
*
|
|
@@ -161,7 +173,9 @@ declare module 'stripe' {
|
|
|
161
173
|
| 'eps'
|
|
162
174
|
| 'fpx'
|
|
163
175
|
| 'giropay'
|
|
176
|
+
| 'gopay'
|
|
164
177
|
| 'grabpay'
|
|
178
|
+
| 'id_bank_transfer'
|
|
165
179
|
| 'ideal'
|
|
166
180
|
| 'kakao_pay'
|
|
167
181
|
| 'klarna'
|
|
@@ -178,13 +192,19 @@ declare module 'stripe' {
|
|
|
178
192
|
| 'payco'
|
|
179
193
|
| 'paynow'
|
|
180
194
|
| 'paypal'
|
|
195
|
+
| 'paypay'
|
|
196
|
+
| 'payto'
|
|
181
197
|
| 'pix'
|
|
182
198
|
| 'promptpay'
|
|
199
|
+
| 'qris'
|
|
200
|
+
| 'rechnung'
|
|
183
201
|
| 'revolut_pay'
|
|
184
202
|
| 'samsung_pay'
|
|
185
203
|
| 'satispay'
|
|
186
204
|
| 'sepa_debit'
|
|
205
|
+
| 'shopeepay'
|
|
187
206
|
| 'sofort'
|
|
207
|
+
| 'stripe_balance'
|
|
188
208
|
| 'swish'
|
|
189
209
|
| 'twint'
|
|
190
210
|
| 'us_bank_account'
|
|
@@ -343,11 +363,21 @@ declare module 'stripe' {
|
|
|
343
363
|
*/
|
|
344
364
|
giropay?: PaymentMethodData.Giropay;
|
|
345
365
|
|
|
366
|
+
/**
|
|
367
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
368
|
+
*/
|
|
369
|
+
gopay?: PaymentMethodData.Gopay;
|
|
370
|
+
|
|
346
371
|
/**
|
|
347
372
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
348
373
|
*/
|
|
349
374
|
grabpay?: PaymentMethodData.Grabpay;
|
|
350
375
|
|
|
376
|
+
/**
|
|
377
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
378
|
+
*/
|
|
379
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
380
|
+
|
|
351
381
|
/**
|
|
352
382
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
353
383
|
*/
|
|
@@ -443,6 +473,16 @@ declare module 'stripe' {
|
|
|
443
473
|
*/
|
|
444
474
|
paypal?: PaymentMethodData.Paypal;
|
|
445
475
|
|
|
476
|
+
/**
|
|
477
|
+
* If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
|
|
478
|
+
*/
|
|
479
|
+
paypay?: PaymentMethodData.Paypay;
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
483
|
+
*/
|
|
484
|
+
payto?: PaymentMethodData.Payto;
|
|
485
|
+
|
|
446
486
|
/**
|
|
447
487
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
448
488
|
*/
|
|
@@ -453,11 +493,21 @@ declare module 'stripe' {
|
|
|
453
493
|
*/
|
|
454
494
|
promptpay?: PaymentMethodData.Promptpay;
|
|
455
495
|
|
|
496
|
+
/**
|
|
497
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
498
|
+
*/
|
|
499
|
+
qris?: PaymentMethodData.Qris;
|
|
500
|
+
|
|
456
501
|
/**
|
|
457
502
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
458
503
|
*/
|
|
459
504
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
460
505
|
|
|
506
|
+
/**
|
|
507
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
508
|
+
*/
|
|
509
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
510
|
+
|
|
461
511
|
/**
|
|
462
512
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
463
513
|
*/
|
|
@@ -478,11 +528,21 @@ declare module 'stripe' {
|
|
|
478
528
|
*/
|
|
479
529
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
480
530
|
|
|
531
|
+
/**
|
|
532
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
533
|
+
*/
|
|
534
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
535
|
+
|
|
481
536
|
/**
|
|
482
537
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
483
538
|
*/
|
|
484
539
|
sofort?: PaymentMethodData.Sofort;
|
|
485
540
|
|
|
541
|
+
/**
|
|
542
|
+
* This hash contains details about the Stripe balance payment method.
|
|
543
|
+
*/
|
|
544
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
545
|
+
|
|
486
546
|
/**
|
|
487
547
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
488
548
|
*/
|
|
@@ -695,8 +755,21 @@ declare module 'stripe' {
|
|
|
695
755
|
|
|
696
756
|
interface Giropay {}
|
|
697
757
|
|
|
758
|
+
interface Gopay {}
|
|
759
|
+
|
|
698
760
|
interface Grabpay {}
|
|
699
761
|
|
|
762
|
+
interface IdBankTransfer {
|
|
763
|
+
/**
|
|
764
|
+
* Bank where the account is held.
|
|
765
|
+
*/
|
|
766
|
+
bank?: IdBankTransfer.Bank;
|
|
767
|
+
}
|
|
768
|
+
|
|
769
|
+
namespace IdBankTransfer {
|
|
770
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
771
|
+
}
|
|
772
|
+
|
|
700
773
|
interface Ideal {
|
|
701
774
|
/**
|
|
702
775
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -854,10 +927,31 @@ declare module 'stripe' {
|
|
|
854
927
|
|
|
855
928
|
interface Paypal {}
|
|
856
929
|
|
|
930
|
+
interface Paypay {}
|
|
931
|
+
|
|
932
|
+
interface Payto {
|
|
933
|
+
/**
|
|
934
|
+
* The account number for the bank account.
|
|
935
|
+
*/
|
|
936
|
+
account_number?: string;
|
|
937
|
+
|
|
938
|
+
/**
|
|
939
|
+
* Bank-State-Branch number of the bank account.
|
|
940
|
+
*/
|
|
941
|
+
bsb_number?: string;
|
|
942
|
+
|
|
943
|
+
/**
|
|
944
|
+
* The PayID alias for the bank account.
|
|
945
|
+
*/
|
|
946
|
+
pay_id?: string;
|
|
947
|
+
}
|
|
948
|
+
|
|
857
949
|
interface Pix {}
|
|
858
950
|
|
|
859
951
|
interface Promptpay {}
|
|
860
952
|
|
|
953
|
+
interface Qris {}
|
|
954
|
+
|
|
861
955
|
interface RadarOptions {
|
|
862
956
|
/**
|
|
863
957
|
* 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.
|
|
@@ -865,6 +959,32 @@ declare module 'stripe' {
|
|
|
865
959
|
session?: string;
|
|
866
960
|
}
|
|
867
961
|
|
|
962
|
+
interface Rechnung {
|
|
963
|
+
/**
|
|
964
|
+
* Customer's date of birth
|
|
965
|
+
*/
|
|
966
|
+
dob: Rechnung.Dob;
|
|
967
|
+
}
|
|
968
|
+
|
|
969
|
+
namespace Rechnung {
|
|
970
|
+
interface Dob {
|
|
971
|
+
/**
|
|
972
|
+
* The day of birth, between 1 and 31.
|
|
973
|
+
*/
|
|
974
|
+
day: number;
|
|
975
|
+
|
|
976
|
+
/**
|
|
977
|
+
* The month of birth, between 1 and 12.
|
|
978
|
+
*/
|
|
979
|
+
month: number;
|
|
980
|
+
|
|
981
|
+
/**
|
|
982
|
+
* The four-digit year of birth.
|
|
983
|
+
*/
|
|
984
|
+
year: number;
|
|
985
|
+
}
|
|
986
|
+
}
|
|
987
|
+
|
|
868
988
|
interface RevolutPay {}
|
|
869
989
|
|
|
870
990
|
interface SamsungPay {}
|
|
@@ -878,6 +998,8 @@ declare module 'stripe' {
|
|
|
878
998
|
iban: string;
|
|
879
999
|
}
|
|
880
1000
|
|
|
1001
|
+
interface Shopeepay {}
|
|
1002
|
+
|
|
881
1003
|
interface Sofort {
|
|
882
1004
|
/**
|
|
883
1005
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -889,6 +1011,22 @@ declare module 'stripe' {
|
|
|
889
1011
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
890
1012
|
}
|
|
891
1013
|
|
|
1014
|
+
interface StripeBalance {
|
|
1015
|
+
/**
|
|
1016
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
1017
|
+
*/
|
|
1018
|
+
account?: string;
|
|
1019
|
+
|
|
1020
|
+
/**
|
|
1021
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
1022
|
+
*/
|
|
1023
|
+
source_type?: StripeBalance.SourceType;
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
namespace StripeBalance {
|
|
1027
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
1028
|
+
}
|
|
1029
|
+
|
|
892
1030
|
interface Swish {}
|
|
893
1031
|
|
|
894
1032
|
interface Twint {}
|
|
@@ -912,7 +1050,9 @@ declare module 'stripe' {
|
|
|
912
1050
|
| 'eps'
|
|
913
1051
|
| 'fpx'
|
|
914
1052
|
| 'giropay'
|
|
1053
|
+
| 'gopay'
|
|
915
1054
|
| 'grabpay'
|
|
1055
|
+
| 'id_bank_transfer'
|
|
916
1056
|
| 'ideal'
|
|
917
1057
|
| 'kakao_pay'
|
|
918
1058
|
| 'klarna'
|
|
@@ -930,13 +1070,19 @@ declare module 'stripe' {
|
|
|
930
1070
|
| 'payco'
|
|
931
1071
|
| 'paynow'
|
|
932
1072
|
| 'paypal'
|
|
1073
|
+
| 'paypay'
|
|
1074
|
+
| 'payto'
|
|
933
1075
|
| 'pix'
|
|
934
1076
|
| 'promptpay'
|
|
1077
|
+
| 'qris'
|
|
1078
|
+
| 'rechnung'
|
|
935
1079
|
| 'revolut_pay'
|
|
936
1080
|
| 'samsung_pay'
|
|
937
1081
|
| 'satispay'
|
|
938
1082
|
| 'sepa_debit'
|
|
1083
|
+
| 'shopeepay'
|
|
939
1084
|
| 'sofort'
|
|
1085
|
+
| 'stripe_balance'
|
|
940
1086
|
| 'swish'
|
|
941
1087
|
| 'twint'
|
|
942
1088
|
| 'us_bank_account'
|
|
@@ -1022,6 +1168,16 @@ declare module 'stripe' {
|
|
|
1022
1168
|
*/
|
|
1023
1169
|
paypal?: PaymentMethodOptions.Paypal;
|
|
1024
1170
|
|
|
1171
|
+
/**
|
|
1172
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
1173
|
+
*/
|
|
1174
|
+
payto?: PaymentMethodOptions.Payto;
|
|
1175
|
+
|
|
1176
|
+
/**
|
|
1177
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
1178
|
+
*/
|
|
1179
|
+
pix?: PaymentMethodOptions.Pix;
|
|
1180
|
+
|
|
1025
1181
|
/**
|
|
1026
1182
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
1027
1183
|
*/
|
|
@@ -1469,6 +1625,150 @@ declare module 'stripe' {
|
|
|
1469
1625
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
1470
1626
|
*/
|
|
1471
1627
|
billing_agreement_id?: string;
|
|
1628
|
+
|
|
1629
|
+
currency?: string;
|
|
1630
|
+
|
|
1631
|
+
/**
|
|
1632
|
+
* The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
|
|
1633
|
+
*/
|
|
1634
|
+
subsellers?: Array<string>;
|
|
1635
|
+
}
|
|
1636
|
+
|
|
1637
|
+
interface Payto {
|
|
1638
|
+
/**
|
|
1639
|
+
* Additional fields for Mandate creation.
|
|
1640
|
+
*/
|
|
1641
|
+
mandate_options?: Payto.MandateOptions;
|
|
1642
|
+
}
|
|
1643
|
+
|
|
1644
|
+
namespace Payto {
|
|
1645
|
+
interface MandateOptions {
|
|
1646
|
+
/**
|
|
1647
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
1648
|
+
*/
|
|
1649
|
+
amount?: number;
|
|
1650
|
+
|
|
1651
|
+
/**
|
|
1652
|
+
* The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
|
1653
|
+
*/
|
|
1654
|
+
amount_type?: MandateOptions.AmountType;
|
|
1655
|
+
|
|
1656
|
+
/**
|
|
1657
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
1658
|
+
*/
|
|
1659
|
+
end_date?: string;
|
|
1660
|
+
|
|
1661
|
+
/**
|
|
1662
|
+
* The periodicity at which payments will be collected.
|
|
1663
|
+
*/
|
|
1664
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1665
|
+
|
|
1666
|
+
/**
|
|
1667
|
+
* The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
1668
|
+
*/
|
|
1669
|
+
payments_per_period?: number;
|
|
1670
|
+
|
|
1671
|
+
/**
|
|
1672
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
1673
|
+
*/
|
|
1674
|
+
purpose?: MandateOptions.Purpose;
|
|
1675
|
+
|
|
1676
|
+
/**
|
|
1677
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
1678
|
+
*/
|
|
1679
|
+
start_date?: string;
|
|
1680
|
+
}
|
|
1681
|
+
|
|
1682
|
+
namespace MandateOptions {
|
|
1683
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1684
|
+
|
|
1685
|
+
type PaymentSchedule =
|
|
1686
|
+
| 'adhoc'
|
|
1687
|
+
| 'annual'
|
|
1688
|
+
| 'daily'
|
|
1689
|
+
| 'fortnightly'
|
|
1690
|
+
| 'monthly'
|
|
1691
|
+
| 'quarterly'
|
|
1692
|
+
| 'semi_annual'
|
|
1693
|
+
| 'weekly';
|
|
1694
|
+
|
|
1695
|
+
type Purpose =
|
|
1696
|
+
| 'dependant_support'
|
|
1697
|
+
| 'government'
|
|
1698
|
+
| 'loan'
|
|
1699
|
+
| 'mortgage'
|
|
1700
|
+
| 'other'
|
|
1701
|
+
| 'pension'
|
|
1702
|
+
| 'personal'
|
|
1703
|
+
| 'retail'
|
|
1704
|
+
| 'salary'
|
|
1705
|
+
| 'tax'
|
|
1706
|
+
| 'utility';
|
|
1707
|
+
}
|
|
1708
|
+
}
|
|
1709
|
+
|
|
1710
|
+
interface Pix {
|
|
1711
|
+
/**
|
|
1712
|
+
* Additional fields for mandate creation.
|
|
1713
|
+
*/
|
|
1714
|
+
mandate_options?: Pix.MandateOptions;
|
|
1715
|
+
}
|
|
1716
|
+
|
|
1717
|
+
namespace Pix {
|
|
1718
|
+
interface MandateOptions {
|
|
1719
|
+
/**
|
|
1720
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
1721
|
+
*/
|
|
1722
|
+
amount?: number;
|
|
1723
|
+
|
|
1724
|
+
/**
|
|
1725
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
1726
|
+
*/
|
|
1727
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
1728
|
+
|
|
1729
|
+
/**
|
|
1730
|
+
* Type of amount. Defaults to `maximum`.
|
|
1731
|
+
*/
|
|
1732
|
+
amount_type?: MandateOptions.AmountType;
|
|
1733
|
+
|
|
1734
|
+
/**
|
|
1735
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
1736
|
+
*/
|
|
1737
|
+
currency?: string;
|
|
1738
|
+
|
|
1739
|
+
/**
|
|
1740
|
+
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
1741
|
+
*/
|
|
1742
|
+
end_date?: string;
|
|
1743
|
+
|
|
1744
|
+
/**
|
|
1745
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
1746
|
+
*/
|
|
1747
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1748
|
+
|
|
1749
|
+
/**
|
|
1750
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
1751
|
+
*/
|
|
1752
|
+
reference?: string;
|
|
1753
|
+
|
|
1754
|
+
/**
|
|
1755
|
+
* Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
|
|
1756
|
+
*/
|
|
1757
|
+
start_date?: string;
|
|
1758
|
+
}
|
|
1759
|
+
|
|
1760
|
+
namespace MandateOptions {
|
|
1761
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
1762
|
+
|
|
1763
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1764
|
+
|
|
1765
|
+
type PaymentSchedule =
|
|
1766
|
+
| 'halfyearly'
|
|
1767
|
+
| 'monthly'
|
|
1768
|
+
| 'quarterly'
|
|
1769
|
+
| 'weekly'
|
|
1770
|
+
| 'yearly';
|
|
1771
|
+
}
|
|
1472
1772
|
}
|
|
1473
1773
|
|
|
1474
1774
|
interface SepaDebit {
|
|
@@ -1516,6 +1816,11 @@ declare module 'stripe' {
|
|
|
1516
1816
|
*/
|
|
1517
1817
|
filters?: FinancialConnections.Filters;
|
|
1518
1818
|
|
|
1819
|
+
/**
|
|
1820
|
+
* Customize manual entry behavior
|
|
1821
|
+
*/
|
|
1822
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
1823
|
+
|
|
1519
1824
|
/**
|
|
1520
1825
|
* The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
|
|
1521
1826
|
*/
|
|
@@ -1538,19 +1843,39 @@ declare module 'stripe' {
|
|
|
1538
1843
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1539
1844
|
*/
|
|
1540
1845
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1846
|
+
|
|
1847
|
+
/**
|
|
1848
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
1849
|
+
*/
|
|
1850
|
+
institution?: string;
|
|
1541
1851
|
}
|
|
1542
1852
|
|
|
1543
1853
|
namespace Filters {
|
|
1544
1854
|
type AccountSubcategory = 'checking' | 'savings';
|
|
1545
1855
|
}
|
|
1546
1856
|
|
|
1857
|
+
interface ManualEntry {
|
|
1858
|
+
/**
|
|
1859
|
+
* Settings for configuring manual entry of account details.
|
|
1860
|
+
*/
|
|
1861
|
+
mode: ManualEntry.Mode;
|
|
1862
|
+
}
|
|
1863
|
+
|
|
1864
|
+
namespace ManualEntry {
|
|
1865
|
+
type Mode = 'automatic' | 'custom';
|
|
1866
|
+
}
|
|
1867
|
+
|
|
1547
1868
|
type Permission =
|
|
1548
1869
|
| 'balances'
|
|
1549
1870
|
| 'ownership'
|
|
1550
1871
|
| 'payment_method'
|
|
1551
1872
|
| 'transactions';
|
|
1552
1873
|
|
|
1553
|
-
type Prefetch =
|
|
1874
|
+
type Prefetch =
|
|
1875
|
+
| 'balances'
|
|
1876
|
+
| 'inferred_balances'
|
|
1877
|
+
| 'ownership'
|
|
1878
|
+
| 'transactions';
|
|
1554
1879
|
}
|
|
1555
1880
|
|
|
1556
1881
|
interface MandateOptions {
|
|
@@ -1575,6 +1900,31 @@ declare module 'stripe' {
|
|
|
1575
1900
|
}
|
|
1576
1901
|
}
|
|
1577
1902
|
|
|
1903
|
+
interface SetupDetails {
|
|
1904
|
+
/**
|
|
1905
|
+
* Benefit details for this SetupIntent
|
|
1906
|
+
*/
|
|
1907
|
+
benefit?: SetupDetails.Benefit;
|
|
1908
|
+
}
|
|
1909
|
+
|
|
1910
|
+
namespace SetupDetails {
|
|
1911
|
+
interface Benefit {
|
|
1912
|
+
/**
|
|
1913
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
1914
|
+
*/
|
|
1915
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
1916
|
+
}
|
|
1917
|
+
|
|
1918
|
+
namespace Benefit {
|
|
1919
|
+
interface FrMealVoucher {
|
|
1920
|
+
/**
|
|
1921
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
1922
|
+
*/
|
|
1923
|
+
siret: string;
|
|
1924
|
+
}
|
|
1925
|
+
}
|
|
1926
|
+
}
|
|
1927
|
+
|
|
1578
1928
|
interface SingleUse {
|
|
1579
1929
|
/**
|
|
1580
1930
|
* Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
|
|
@@ -1617,6 +1967,13 @@ declare module 'stripe' {
|
|
|
1617
1967
|
*/
|
|
1618
1968
|
customer?: string;
|
|
1619
1969
|
|
|
1970
|
+
/**
|
|
1971
|
+
* ID of the Account this SetupIntent belongs to, if one exists.
|
|
1972
|
+
*
|
|
1973
|
+
* If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.
|
|
1974
|
+
*/
|
|
1975
|
+
customer_account?: string;
|
|
1976
|
+
|
|
1620
1977
|
/**
|
|
1621
1978
|
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1622
1979
|
*/
|
|
@@ -1671,6 +2028,11 @@ declare module 'stripe' {
|
|
|
1671
2028
|
* The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
|
|
1672
2029
|
*/
|
|
1673
2030
|
payment_method_types?: Array<string>;
|
|
2031
|
+
|
|
2032
|
+
/**
|
|
2033
|
+
* Provides industry-specific information about the SetupIntent.
|
|
2034
|
+
*/
|
|
2035
|
+
setup_details?: SetupIntentUpdateParams.SetupDetails;
|
|
1674
2036
|
}
|
|
1675
2037
|
|
|
1676
2038
|
namespace SetupIntentUpdateParams {
|
|
@@ -1694,7 +2056,9 @@ declare module 'stripe' {
|
|
|
1694
2056
|
| 'eps'
|
|
1695
2057
|
| 'fpx'
|
|
1696
2058
|
| 'giropay'
|
|
2059
|
+
| 'gopay'
|
|
1697
2060
|
| 'grabpay'
|
|
2061
|
+
| 'id_bank_transfer'
|
|
1698
2062
|
| 'ideal'
|
|
1699
2063
|
| 'kakao_pay'
|
|
1700
2064
|
| 'klarna'
|
|
@@ -1711,13 +2075,19 @@ declare module 'stripe' {
|
|
|
1711
2075
|
| 'payco'
|
|
1712
2076
|
| 'paynow'
|
|
1713
2077
|
| 'paypal'
|
|
2078
|
+
| 'paypay'
|
|
2079
|
+
| 'payto'
|
|
1714
2080
|
| 'pix'
|
|
1715
2081
|
| 'promptpay'
|
|
2082
|
+
| 'qris'
|
|
2083
|
+
| 'rechnung'
|
|
1716
2084
|
| 'revolut_pay'
|
|
1717
2085
|
| 'samsung_pay'
|
|
1718
2086
|
| 'satispay'
|
|
1719
2087
|
| 'sepa_debit'
|
|
2088
|
+
| 'shopeepay'
|
|
1720
2089
|
| 'sofort'
|
|
2090
|
+
| 'stripe_balance'
|
|
1721
2091
|
| 'swish'
|
|
1722
2092
|
| 'twint'
|
|
1723
2093
|
| 'us_bank_account'
|
|
@@ -1827,11 +2197,21 @@ declare module 'stripe' {
|
|
|
1827
2197
|
*/
|
|
1828
2198
|
giropay?: PaymentMethodData.Giropay;
|
|
1829
2199
|
|
|
2200
|
+
/**
|
|
2201
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
2202
|
+
*/
|
|
2203
|
+
gopay?: PaymentMethodData.Gopay;
|
|
2204
|
+
|
|
1830
2205
|
/**
|
|
1831
2206
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
1832
2207
|
*/
|
|
1833
2208
|
grabpay?: PaymentMethodData.Grabpay;
|
|
1834
2209
|
|
|
2210
|
+
/**
|
|
2211
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
2212
|
+
*/
|
|
2213
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
2214
|
+
|
|
1835
2215
|
/**
|
|
1836
2216
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
1837
2217
|
*/
|
|
@@ -1927,6 +2307,16 @@ declare module 'stripe' {
|
|
|
1927
2307
|
*/
|
|
1928
2308
|
paypal?: PaymentMethodData.Paypal;
|
|
1929
2309
|
|
|
2310
|
+
/**
|
|
2311
|
+
* If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
|
|
2312
|
+
*/
|
|
2313
|
+
paypay?: PaymentMethodData.Paypay;
|
|
2314
|
+
|
|
2315
|
+
/**
|
|
2316
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
2317
|
+
*/
|
|
2318
|
+
payto?: PaymentMethodData.Payto;
|
|
2319
|
+
|
|
1930
2320
|
/**
|
|
1931
2321
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
1932
2322
|
*/
|
|
@@ -1937,11 +2327,21 @@ declare module 'stripe' {
|
|
|
1937
2327
|
*/
|
|
1938
2328
|
promptpay?: PaymentMethodData.Promptpay;
|
|
1939
2329
|
|
|
2330
|
+
/**
|
|
2331
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
2332
|
+
*/
|
|
2333
|
+
qris?: PaymentMethodData.Qris;
|
|
2334
|
+
|
|
1940
2335
|
/**
|
|
1941
2336
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
1942
2337
|
*/
|
|
1943
2338
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
1944
2339
|
|
|
2340
|
+
/**
|
|
2341
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
2342
|
+
*/
|
|
2343
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
2344
|
+
|
|
1945
2345
|
/**
|
|
1946
2346
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
1947
2347
|
*/
|
|
@@ -1962,11 +2362,21 @@ declare module 'stripe' {
|
|
|
1962
2362
|
*/
|
|
1963
2363
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
1964
2364
|
|
|
2365
|
+
/**
|
|
2366
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
2367
|
+
*/
|
|
2368
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
2369
|
+
|
|
1965
2370
|
/**
|
|
1966
2371
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
1967
2372
|
*/
|
|
1968
2373
|
sofort?: PaymentMethodData.Sofort;
|
|
1969
2374
|
|
|
2375
|
+
/**
|
|
2376
|
+
* This hash contains details about the Stripe balance payment method.
|
|
2377
|
+
*/
|
|
2378
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
2379
|
+
|
|
1970
2380
|
/**
|
|
1971
2381
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
1972
2382
|
*/
|
|
@@ -2179,8 +2589,21 @@ declare module 'stripe' {
|
|
|
2179
2589
|
|
|
2180
2590
|
interface Giropay {}
|
|
2181
2591
|
|
|
2592
|
+
interface Gopay {}
|
|
2593
|
+
|
|
2182
2594
|
interface Grabpay {}
|
|
2183
2595
|
|
|
2596
|
+
interface IdBankTransfer {
|
|
2597
|
+
/**
|
|
2598
|
+
* Bank where the account is held.
|
|
2599
|
+
*/
|
|
2600
|
+
bank?: IdBankTransfer.Bank;
|
|
2601
|
+
}
|
|
2602
|
+
|
|
2603
|
+
namespace IdBankTransfer {
|
|
2604
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
2605
|
+
}
|
|
2606
|
+
|
|
2184
2607
|
interface Ideal {
|
|
2185
2608
|
/**
|
|
2186
2609
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -2338,10 +2761,31 @@ declare module 'stripe' {
|
|
|
2338
2761
|
|
|
2339
2762
|
interface Paypal {}
|
|
2340
2763
|
|
|
2764
|
+
interface Paypay {}
|
|
2765
|
+
|
|
2766
|
+
interface Payto {
|
|
2767
|
+
/**
|
|
2768
|
+
* The account number for the bank account.
|
|
2769
|
+
*/
|
|
2770
|
+
account_number?: string;
|
|
2771
|
+
|
|
2772
|
+
/**
|
|
2773
|
+
* Bank-State-Branch number of the bank account.
|
|
2774
|
+
*/
|
|
2775
|
+
bsb_number?: string;
|
|
2776
|
+
|
|
2777
|
+
/**
|
|
2778
|
+
* The PayID alias for the bank account.
|
|
2779
|
+
*/
|
|
2780
|
+
pay_id?: string;
|
|
2781
|
+
}
|
|
2782
|
+
|
|
2341
2783
|
interface Pix {}
|
|
2342
2784
|
|
|
2343
2785
|
interface Promptpay {}
|
|
2344
2786
|
|
|
2787
|
+
interface Qris {}
|
|
2788
|
+
|
|
2345
2789
|
interface RadarOptions {
|
|
2346
2790
|
/**
|
|
2347
2791
|
* 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.
|
|
@@ -2349,7 +2793,33 @@ declare module 'stripe' {
|
|
|
2349
2793
|
session?: string;
|
|
2350
2794
|
}
|
|
2351
2795
|
|
|
2352
|
-
interface
|
|
2796
|
+
interface Rechnung {
|
|
2797
|
+
/**
|
|
2798
|
+
* Customer's date of birth
|
|
2799
|
+
*/
|
|
2800
|
+
dob: Rechnung.Dob;
|
|
2801
|
+
}
|
|
2802
|
+
|
|
2803
|
+
namespace Rechnung {
|
|
2804
|
+
interface Dob {
|
|
2805
|
+
/**
|
|
2806
|
+
* The day of birth, between 1 and 31.
|
|
2807
|
+
*/
|
|
2808
|
+
day: number;
|
|
2809
|
+
|
|
2810
|
+
/**
|
|
2811
|
+
* The month of birth, between 1 and 12.
|
|
2812
|
+
*/
|
|
2813
|
+
month: number;
|
|
2814
|
+
|
|
2815
|
+
/**
|
|
2816
|
+
* The four-digit year of birth.
|
|
2817
|
+
*/
|
|
2818
|
+
year: number;
|
|
2819
|
+
}
|
|
2820
|
+
}
|
|
2821
|
+
|
|
2822
|
+
interface RevolutPay {}
|
|
2353
2823
|
|
|
2354
2824
|
interface SamsungPay {}
|
|
2355
2825
|
|
|
@@ -2362,6 +2832,8 @@ declare module 'stripe' {
|
|
|
2362
2832
|
iban: string;
|
|
2363
2833
|
}
|
|
2364
2834
|
|
|
2835
|
+
interface Shopeepay {}
|
|
2836
|
+
|
|
2365
2837
|
interface Sofort {
|
|
2366
2838
|
/**
|
|
2367
2839
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -2373,6 +2845,22 @@ declare module 'stripe' {
|
|
|
2373
2845
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
2374
2846
|
}
|
|
2375
2847
|
|
|
2848
|
+
interface StripeBalance {
|
|
2849
|
+
/**
|
|
2850
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
2851
|
+
*/
|
|
2852
|
+
account?: string;
|
|
2853
|
+
|
|
2854
|
+
/**
|
|
2855
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
2856
|
+
*/
|
|
2857
|
+
source_type?: StripeBalance.SourceType;
|
|
2858
|
+
}
|
|
2859
|
+
|
|
2860
|
+
namespace StripeBalance {
|
|
2861
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
2862
|
+
}
|
|
2863
|
+
|
|
2376
2864
|
interface Swish {}
|
|
2377
2865
|
|
|
2378
2866
|
interface Twint {}
|
|
@@ -2396,7 +2884,9 @@ declare module 'stripe' {
|
|
|
2396
2884
|
| 'eps'
|
|
2397
2885
|
| 'fpx'
|
|
2398
2886
|
| 'giropay'
|
|
2887
|
+
| 'gopay'
|
|
2399
2888
|
| 'grabpay'
|
|
2889
|
+
| 'id_bank_transfer'
|
|
2400
2890
|
| 'ideal'
|
|
2401
2891
|
| 'kakao_pay'
|
|
2402
2892
|
| 'klarna'
|
|
@@ -2414,13 +2904,19 @@ declare module 'stripe' {
|
|
|
2414
2904
|
| 'payco'
|
|
2415
2905
|
| 'paynow'
|
|
2416
2906
|
| 'paypal'
|
|
2907
|
+
| 'paypay'
|
|
2908
|
+
| 'payto'
|
|
2417
2909
|
| 'pix'
|
|
2418
2910
|
| 'promptpay'
|
|
2911
|
+
| 'qris'
|
|
2912
|
+
| 'rechnung'
|
|
2419
2913
|
| 'revolut_pay'
|
|
2420
2914
|
| 'samsung_pay'
|
|
2421
2915
|
| 'satispay'
|
|
2422
2916
|
| 'sepa_debit'
|
|
2917
|
+
| 'shopeepay'
|
|
2423
2918
|
| 'sofort'
|
|
2919
|
+
| 'stripe_balance'
|
|
2424
2920
|
| 'swish'
|
|
2425
2921
|
| 'twint'
|
|
2426
2922
|
| 'us_bank_account'
|
|
@@ -2506,6 +3002,16 @@ declare module 'stripe' {
|
|
|
2506
3002
|
*/
|
|
2507
3003
|
paypal?: PaymentMethodOptions.Paypal;
|
|
2508
3004
|
|
|
3005
|
+
/**
|
|
3006
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
3007
|
+
*/
|
|
3008
|
+
payto?: PaymentMethodOptions.Payto;
|
|
3009
|
+
|
|
3010
|
+
/**
|
|
3011
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
3012
|
+
*/
|
|
3013
|
+
pix?: PaymentMethodOptions.Pix;
|
|
3014
|
+
|
|
2509
3015
|
/**
|
|
2510
3016
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
2511
3017
|
*/
|
|
@@ -2953,6 +3459,150 @@ declare module 'stripe' {
|
|
|
2953
3459
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
2954
3460
|
*/
|
|
2955
3461
|
billing_agreement_id?: string;
|
|
3462
|
+
|
|
3463
|
+
currency?: string;
|
|
3464
|
+
|
|
3465
|
+
/**
|
|
3466
|
+
* The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
|
|
3467
|
+
*/
|
|
3468
|
+
subsellers?: Array<string>;
|
|
3469
|
+
}
|
|
3470
|
+
|
|
3471
|
+
interface Payto {
|
|
3472
|
+
/**
|
|
3473
|
+
* Additional fields for Mandate creation.
|
|
3474
|
+
*/
|
|
3475
|
+
mandate_options?: Payto.MandateOptions;
|
|
3476
|
+
}
|
|
3477
|
+
|
|
3478
|
+
namespace Payto {
|
|
3479
|
+
interface MandateOptions {
|
|
3480
|
+
/**
|
|
3481
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
3482
|
+
*/
|
|
3483
|
+
amount?: number;
|
|
3484
|
+
|
|
3485
|
+
/**
|
|
3486
|
+
* The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
|
3487
|
+
*/
|
|
3488
|
+
amount_type?: MandateOptions.AmountType;
|
|
3489
|
+
|
|
3490
|
+
/**
|
|
3491
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
3492
|
+
*/
|
|
3493
|
+
end_date?: string;
|
|
3494
|
+
|
|
3495
|
+
/**
|
|
3496
|
+
* The periodicity at which payments will be collected.
|
|
3497
|
+
*/
|
|
3498
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
3499
|
+
|
|
3500
|
+
/**
|
|
3501
|
+
* The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
3502
|
+
*/
|
|
3503
|
+
payments_per_period?: number;
|
|
3504
|
+
|
|
3505
|
+
/**
|
|
3506
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
3507
|
+
*/
|
|
3508
|
+
purpose?: MandateOptions.Purpose;
|
|
3509
|
+
|
|
3510
|
+
/**
|
|
3511
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
3512
|
+
*/
|
|
3513
|
+
start_date?: string;
|
|
3514
|
+
}
|
|
3515
|
+
|
|
3516
|
+
namespace MandateOptions {
|
|
3517
|
+
type AmountType = 'fixed' | 'maximum';
|
|
3518
|
+
|
|
3519
|
+
type PaymentSchedule =
|
|
3520
|
+
| 'adhoc'
|
|
3521
|
+
| 'annual'
|
|
3522
|
+
| 'daily'
|
|
3523
|
+
| 'fortnightly'
|
|
3524
|
+
| 'monthly'
|
|
3525
|
+
| 'quarterly'
|
|
3526
|
+
| 'semi_annual'
|
|
3527
|
+
| 'weekly';
|
|
3528
|
+
|
|
3529
|
+
type Purpose =
|
|
3530
|
+
| 'dependant_support'
|
|
3531
|
+
| 'government'
|
|
3532
|
+
| 'loan'
|
|
3533
|
+
| 'mortgage'
|
|
3534
|
+
| 'other'
|
|
3535
|
+
| 'pension'
|
|
3536
|
+
| 'personal'
|
|
3537
|
+
| 'retail'
|
|
3538
|
+
| 'salary'
|
|
3539
|
+
| 'tax'
|
|
3540
|
+
| 'utility';
|
|
3541
|
+
}
|
|
3542
|
+
}
|
|
3543
|
+
|
|
3544
|
+
interface Pix {
|
|
3545
|
+
/**
|
|
3546
|
+
* Additional fields for mandate creation.
|
|
3547
|
+
*/
|
|
3548
|
+
mandate_options?: Pix.MandateOptions;
|
|
3549
|
+
}
|
|
3550
|
+
|
|
3551
|
+
namespace Pix {
|
|
3552
|
+
interface MandateOptions {
|
|
3553
|
+
/**
|
|
3554
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
3555
|
+
*/
|
|
3556
|
+
amount?: number;
|
|
3557
|
+
|
|
3558
|
+
/**
|
|
3559
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
3560
|
+
*/
|
|
3561
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
3562
|
+
|
|
3563
|
+
/**
|
|
3564
|
+
* Type of amount. Defaults to `maximum`.
|
|
3565
|
+
*/
|
|
3566
|
+
amount_type?: MandateOptions.AmountType;
|
|
3567
|
+
|
|
3568
|
+
/**
|
|
3569
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
3570
|
+
*/
|
|
3571
|
+
currency?: string;
|
|
3572
|
+
|
|
3573
|
+
/**
|
|
3574
|
+
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
3575
|
+
*/
|
|
3576
|
+
end_date?: string;
|
|
3577
|
+
|
|
3578
|
+
/**
|
|
3579
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
3580
|
+
*/
|
|
3581
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
3582
|
+
|
|
3583
|
+
/**
|
|
3584
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
3585
|
+
*/
|
|
3586
|
+
reference?: string;
|
|
3587
|
+
|
|
3588
|
+
/**
|
|
3589
|
+
* Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
|
|
3590
|
+
*/
|
|
3591
|
+
start_date?: string;
|
|
3592
|
+
}
|
|
3593
|
+
|
|
3594
|
+
namespace MandateOptions {
|
|
3595
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
3596
|
+
|
|
3597
|
+
type AmountType = 'fixed' | 'maximum';
|
|
3598
|
+
|
|
3599
|
+
type PaymentSchedule =
|
|
3600
|
+
| 'halfyearly'
|
|
3601
|
+
| 'monthly'
|
|
3602
|
+
| 'quarterly'
|
|
3603
|
+
| 'weekly'
|
|
3604
|
+
| 'yearly';
|
|
3605
|
+
}
|
|
2956
3606
|
}
|
|
2957
3607
|
|
|
2958
3608
|
interface SepaDebit {
|
|
@@ -3000,6 +3650,11 @@ declare module 'stripe' {
|
|
|
3000
3650
|
*/
|
|
3001
3651
|
filters?: FinancialConnections.Filters;
|
|
3002
3652
|
|
|
3653
|
+
/**
|
|
3654
|
+
* Customize manual entry behavior
|
|
3655
|
+
*/
|
|
3656
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
3657
|
+
|
|
3003
3658
|
/**
|
|
3004
3659
|
* The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
|
|
3005
3660
|
*/
|
|
@@ -3022,19 +3677,39 @@ declare module 'stripe' {
|
|
|
3022
3677
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
3023
3678
|
*/
|
|
3024
3679
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
3680
|
+
|
|
3681
|
+
/**
|
|
3682
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
3683
|
+
*/
|
|
3684
|
+
institution?: string;
|
|
3025
3685
|
}
|
|
3026
3686
|
|
|
3027
3687
|
namespace Filters {
|
|
3028
3688
|
type AccountSubcategory = 'checking' | 'savings';
|
|
3029
3689
|
}
|
|
3030
3690
|
|
|
3691
|
+
interface ManualEntry {
|
|
3692
|
+
/**
|
|
3693
|
+
* Settings for configuring manual entry of account details.
|
|
3694
|
+
*/
|
|
3695
|
+
mode: ManualEntry.Mode;
|
|
3696
|
+
}
|
|
3697
|
+
|
|
3698
|
+
namespace ManualEntry {
|
|
3699
|
+
type Mode = 'automatic' | 'custom';
|
|
3700
|
+
}
|
|
3701
|
+
|
|
3031
3702
|
type Permission =
|
|
3032
3703
|
| 'balances'
|
|
3033
3704
|
| 'ownership'
|
|
3034
3705
|
| 'payment_method'
|
|
3035
3706
|
| 'transactions';
|
|
3036
3707
|
|
|
3037
|
-
type Prefetch =
|
|
3708
|
+
type Prefetch =
|
|
3709
|
+
| 'balances'
|
|
3710
|
+
| 'inferred_balances'
|
|
3711
|
+
| 'ownership'
|
|
3712
|
+
| 'transactions';
|
|
3038
3713
|
}
|
|
3039
3714
|
|
|
3040
3715
|
interface MandateOptions {
|
|
@@ -3058,6 +3733,31 @@ declare module 'stripe' {
|
|
|
3058
3733
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
3059
3734
|
}
|
|
3060
3735
|
}
|
|
3736
|
+
|
|
3737
|
+
interface SetupDetails {
|
|
3738
|
+
/**
|
|
3739
|
+
* Benefit details for this SetupIntent
|
|
3740
|
+
*/
|
|
3741
|
+
benefit?: SetupDetails.Benefit;
|
|
3742
|
+
}
|
|
3743
|
+
|
|
3744
|
+
namespace SetupDetails {
|
|
3745
|
+
interface Benefit {
|
|
3746
|
+
/**
|
|
3747
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
3748
|
+
*/
|
|
3749
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
3750
|
+
}
|
|
3751
|
+
|
|
3752
|
+
namespace Benefit {
|
|
3753
|
+
interface FrMealVoucher {
|
|
3754
|
+
/**
|
|
3755
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
3756
|
+
*/
|
|
3757
|
+
siret: string;
|
|
3758
|
+
}
|
|
3759
|
+
}
|
|
3760
|
+
}
|
|
3061
3761
|
}
|
|
3062
3762
|
|
|
3063
3763
|
interface SetupIntentListParams extends PaginationParams {
|
|
@@ -3078,6 +3778,11 @@ declare module 'stripe' {
|
|
|
3078
3778
|
*/
|
|
3079
3779
|
customer?: string;
|
|
3080
3780
|
|
|
3781
|
+
/**
|
|
3782
|
+
* Only return SetupIntents for the account specified by this customer ID.
|
|
3783
|
+
*/
|
|
3784
|
+
customer_account?: string;
|
|
3785
|
+
|
|
3081
3786
|
/**
|
|
3082
3787
|
* Specifies which fields in the response should be expanded.
|
|
3083
3788
|
*/
|
|
@@ -3146,6 +3851,11 @@ declare module 'stripe' {
|
|
|
3146
3851
|
*/
|
|
3147
3852
|
return_url?: string;
|
|
3148
3853
|
|
|
3854
|
+
/**
|
|
3855
|
+
* Provides industry-specific information about the SetupIntent.
|
|
3856
|
+
*/
|
|
3857
|
+
setup_details?: SetupIntentConfirmParams.SetupDetails;
|
|
3858
|
+
|
|
3149
3859
|
/**
|
|
3150
3860
|
* Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
|
|
3151
3861
|
*/
|
|
@@ -3303,11 +4013,21 @@ declare module 'stripe' {
|
|
|
3303
4013
|
*/
|
|
3304
4014
|
giropay?: PaymentMethodData.Giropay;
|
|
3305
4015
|
|
|
4016
|
+
/**
|
|
4017
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
4018
|
+
*/
|
|
4019
|
+
gopay?: PaymentMethodData.Gopay;
|
|
4020
|
+
|
|
3306
4021
|
/**
|
|
3307
4022
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
3308
4023
|
*/
|
|
3309
4024
|
grabpay?: PaymentMethodData.Grabpay;
|
|
3310
4025
|
|
|
4026
|
+
/**
|
|
4027
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
4028
|
+
*/
|
|
4029
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
4030
|
+
|
|
3311
4031
|
/**
|
|
3312
4032
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
3313
4033
|
*/
|
|
@@ -3403,6 +4123,16 @@ declare module 'stripe' {
|
|
|
3403
4123
|
*/
|
|
3404
4124
|
paypal?: PaymentMethodData.Paypal;
|
|
3405
4125
|
|
|
4126
|
+
/**
|
|
4127
|
+
* If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
|
|
4128
|
+
*/
|
|
4129
|
+
paypay?: PaymentMethodData.Paypay;
|
|
4130
|
+
|
|
4131
|
+
/**
|
|
4132
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
4133
|
+
*/
|
|
4134
|
+
payto?: PaymentMethodData.Payto;
|
|
4135
|
+
|
|
3406
4136
|
/**
|
|
3407
4137
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
3408
4138
|
*/
|
|
@@ -3413,11 +4143,21 @@ declare module 'stripe' {
|
|
|
3413
4143
|
*/
|
|
3414
4144
|
promptpay?: PaymentMethodData.Promptpay;
|
|
3415
4145
|
|
|
4146
|
+
/**
|
|
4147
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
4148
|
+
*/
|
|
4149
|
+
qris?: PaymentMethodData.Qris;
|
|
4150
|
+
|
|
3416
4151
|
/**
|
|
3417
4152
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
3418
4153
|
*/
|
|
3419
4154
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
3420
4155
|
|
|
4156
|
+
/**
|
|
4157
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
4158
|
+
*/
|
|
4159
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
4160
|
+
|
|
3421
4161
|
/**
|
|
3422
4162
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
3423
4163
|
*/
|
|
@@ -3438,11 +4178,21 @@ declare module 'stripe' {
|
|
|
3438
4178
|
*/
|
|
3439
4179
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
3440
4180
|
|
|
4181
|
+
/**
|
|
4182
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
4183
|
+
*/
|
|
4184
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
4185
|
+
|
|
3441
4186
|
/**
|
|
3442
4187
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
3443
4188
|
*/
|
|
3444
4189
|
sofort?: PaymentMethodData.Sofort;
|
|
3445
4190
|
|
|
4191
|
+
/**
|
|
4192
|
+
* This hash contains details about the Stripe balance payment method.
|
|
4193
|
+
*/
|
|
4194
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
4195
|
+
|
|
3446
4196
|
/**
|
|
3447
4197
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
3448
4198
|
*/
|
|
@@ -3655,8 +4405,21 @@ declare module 'stripe' {
|
|
|
3655
4405
|
|
|
3656
4406
|
interface Giropay {}
|
|
3657
4407
|
|
|
4408
|
+
interface Gopay {}
|
|
4409
|
+
|
|
3658
4410
|
interface Grabpay {}
|
|
3659
4411
|
|
|
4412
|
+
interface IdBankTransfer {
|
|
4413
|
+
/**
|
|
4414
|
+
* Bank where the account is held.
|
|
4415
|
+
*/
|
|
4416
|
+
bank?: IdBankTransfer.Bank;
|
|
4417
|
+
}
|
|
4418
|
+
|
|
4419
|
+
namespace IdBankTransfer {
|
|
4420
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
4421
|
+
}
|
|
4422
|
+
|
|
3660
4423
|
interface Ideal {
|
|
3661
4424
|
/**
|
|
3662
4425
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -3814,10 +4577,31 @@ declare module 'stripe' {
|
|
|
3814
4577
|
|
|
3815
4578
|
interface Paypal {}
|
|
3816
4579
|
|
|
4580
|
+
interface Paypay {}
|
|
4581
|
+
|
|
4582
|
+
interface Payto {
|
|
4583
|
+
/**
|
|
4584
|
+
* The account number for the bank account.
|
|
4585
|
+
*/
|
|
4586
|
+
account_number?: string;
|
|
4587
|
+
|
|
4588
|
+
/**
|
|
4589
|
+
* Bank-State-Branch number of the bank account.
|
|
4590
|
+
*/
|
|
4591
|
+
bsb_number?: string;
|
|
4592
|
+
|
|
4593
|
+
/**
|
|
4594
|
+
* The PayID alias for the bank account.
|
|
4595
|
+
*/
|
|
4596
|
+
pay_id?: string;
|
|
4597
|
+
}
|
|
4598
|
+
|
|
3817
4599
|
interface Pix {}
|
|
3818
4600
|
|
|
3819
4601
|
interface Promptpay {}
|
|
3820
4602
|
|
|
4603
|
+
interface Qris {}
|
|
4604
|
+
|
|
3821
4605
|
interface RadarOptions {
|
|
3822
4606
|
/**
|
|
3823
4607
|
* 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.
|
|
@@ -3825,6 +4609,32 @@ declare module 'stripe' {
|
|
|
3825
4609
|
session?: string;
|
|
3826
4610
|
}
|
|
3827
4611
|
|
|
4612
|
+
interface Rechnung {
|
|
4613
|
+
/**
|
|
4614
|
+
* Customer's date of birth
|
|
4615
|
+
*/
|
|
4616
|
+
dob: Rechnung.Dob;
|
|
4617
|
+
}
|
|
4618
|
+
|
|
4619
|
+
namespace Rechnung {
|
|
4620
|
+
interface Dob {
|
|
4621
|
+
/**
|
|
4622
|
+
* The day of birth, between 1 and 31.
|
|
4623
|
+
*/
|
|
4624
|
+
day: number;
|
|
4625
|
+
|
|
4626
|
+
/**
|
|
4627
|
+
* The month of birth, between 1 and 12.
|
|
4628
|
+
*/
|
|
4629
|
+
month: number;
|
|
4630
|
+
|
|
4631
|
+
/**
|
|
4632
|
+
* The four-digit year of birth.
|
|
4633
|
+
*/
|
|
4634
|
+
year: number;
|
|
4635
|
+
}
|
|
4636
|
+
}
|
|
4637
|
+
|
|
3828
4638
|
interface RevolutPay {}
|
|
3829
4639
|
|
|
3830
4640
|
interface SamsungPay {}
|
|
@@ -3838,6 +4648,8 @@ declare module 'stripe' {
|
|
|
3838
4648
|
iban: string;
|
|
3839
4649
|
}
|
|
3840
4650
|
|
|
4651
|
+
interface Shopeepay {}
|
|
4652
|
+
|
|
3841
4653
|
interface Sofort {
|
|
3842
4654
|
/**
|
|
3843
4655
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -3849,6 +4661,22 @@ declare module 'stripe' {
|
|
|
3849
4661
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
3850
4662
|
}
|
|
3851
4663
|
|
|
4664
|
+
interface StripeBalance {
|
|
4665
|
+
/**
|
|
4666
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
4667
|
+
*/
|
|
4668
|
+
account?: string;
|
|
4669
|
+
|
|
4670
|
+
/**
|
|
4671
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
4672
|
+
*/
|
|
4673
|
+
source_type?: StripeBalance.SourceType;
|
|
4674
|
+
}
|
|
4675
|
+
|
|
4676
|
+
namespace StripeBalance {
|
|
4677
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
4678
|
+
}
|
|
4679
|
+
|
|
3852
4680
|
interface Swish {}
|
|
3853
4681
|
|
|
3854
4682
|
interface Twint {}
|
|
@@ -3872,7 +4700,9 @@ declare module 'stripe' {
|
|
|
3872
4700
|
| 'eps'
|
|
3873
4701
|
| 'fpx'
|
|
3874
4702
|
| 'giropay'
|
|
4703
|
+
| 'gopay'
|
|
3875
4704
|
| 'grabpay'
|
|
4705
|
+
| 'id_bank_transfer'
|
|
3876
4706
|
| 'ideal'
|
|
3877
4707
|
| 'kakao_pay'
|
|
3878
4708
|
| 'klarna'
|
|
@@ -3890,13 +4720,19 @@ declare module 'stripe' {
|
|
|
3890
4720
|
| 'payco'
|
|
3891
4721
|
| 'paynow'
|
|
3892
4722
|
| 'paypal'
|
|
4723
|
+
| 'paypay'
|
|
4724
|
+
| 'payto'
|
|
3893
4725
|
| 'pix'
|
|
3894
4726
|
| 'promptpay'
|
|
4727
|
+
| 'qris'
|
|
4728
|
+
| 'rechnung'
|
|
3895
4729
|
| 'revolut_pay'
|
|
3896
4730
|
| 'samsung_pay'
|
|
3897
4731
|
| 'satispay'
|
|
3898
4732
|
| 'sepa_debit'
|
|
4733
|
+
| 'shopeepay'
|
|
3899
4734
|
| 'sofort'
|
|
4735
|
+
| 'stripe_balance'
|
|
3900
4736
|
| 'swish'
|
|
3901
4737
|
| 'twint'
|
|
3902
4738
|
| 'us_bank_account'
|
|
@@ -3982,6 +4818,16 @@ declare module 'stripe' {
|
|
|
3982
4818
|
*/
|
|
3983
4819
|
paypal?: PaymentMethodOptions.Paypal;
|
|
3984
4820
|
|
|
4821
|
+
/**
|
|
4822
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
4823
|
+
*/
|
|
4824
|
+
payto?: PaymentMethodOptions.Payto;
|
|
4825
|
+
|
|
4826
|
+
/**
|
|
4827
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
4828
|
+
*/
|
|
4829
|
+
pix?: PaymentMethodOptions.Pix;
|
|
4830
|
+
|
|
3985
4831
|
/**
|
|
3986
4832
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
3987
4833
|
*/
|
|
@@ -4429,6 +5275,150 @@ declare module 'stripe' {
|
|
|
4429
5275
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
4430
5276
|
*/
|
|
4431
5277
|
billing_agreement_id?: string;
|
|
5278
|
+
|
|
5279
|
+
currency?: string;
|
|
5280
|
+
|
|
5281
|
+
/**
|
|
5282
|
+
* The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
|
|
5283
|
+
*/
|
|
5284
|
+
subsellers?: Array<string>;
|
|
5285
|
+
}
|
|
5286
|
+
|
|
5287
|
+
interface Payto {
|
|
5288
|
+
/**
|
|
5289
|
+
* Additional fields for Mandate creation.
|
|
5290
|
+
*/
|
|
5291
|
+
mandate_options?: Payto.MandateOptions;
|
|
5292
|
+
}
|
|
5293
|
+
|
|
5294
|
+
namespace Payto {
|
|
5295
|
+
interface MandateOptions {
|
|
5296
|
+
/**
|
|
5297
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
5298
|
+
*/
|
|
5299
|
+
amount?: number;
|
|
5300
|
+
|
|
5301
|
+
/**
|
|
5302
|
+
* The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
|
5303
|
+
*/
|
|
5304
|
+
amount_type?: MandateOptions.AmountType;
|
|
5305
|
+
|
|
5306
|
+
/**
|
|
5307
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
5308
|
+
*/
|
|
5309
|
+
end_date?: string;
|
|
5310
|
+
|
|
5311
|
+
/**
|
|
5312
|
+
* The periodicity at which payments will be collected.
|
|
5313
|
+
*/
|
|
5314
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
5315
|
+
|
|
5316
|
+
/**
|
|
5317
|
+
* The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
5318
|
+
*/
|
|
5319
|
+
payments_per_period?: number;
|
|
5320
|
+
|
|
5321
|
+
/**
|
|
5322
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
5323
|
+
*/
|
|
5324
|
+
purpose?: MandateOptions.Purpose;
|
|
5325
|
+
|
|
5326
|
+
/**
|
|
5327
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
5328
|
+
*/
|
|
5329
|
+
start_date?: string;
|
|
5330
|
+
}
|
|
5331
|
+
|
|
5332
|
+
namespace MandateOptions {
|
|
5333
|
+
type AmountType = 'fixed' | 'maximum';
|
|
5334
|
+
|
|
5335
|
+
type PaymentSchedule =
|
|
5336
|
+
| 'adhoc'
|
|
5337
|
+
| 'annual'
|
|
5338
|
+
| 'daily'
|
|
5339
|
+
| 'fortnightly'
|
|
5340
|
+
| 'monthly'
|
|
5341
|
+
| 'quarterly'
|
|
5342
|
+
| 'semi_annual'
|
|
5343
|
+
| 'weekly';
|
|
5344
|
+
|
|
5345
|
+
type Purpose =
|
|
5346
|
+
| 'dependant_support'
|
|
5347
|
+
| 'government'
|
|
5348
|
+
| 'loan'
|
|
5349
|
+
| 'mortgage'
|
|
5350
|
+
| 'other'
|
|
5351
|
+
| 'pension'
|
|
5352
|
+
| 'personal'
|
|
5353
|
+
| 'retail'
|
|
5354
|
+
| 'salary'
|
|
5355
|
+
| 'tax'
|
|
5356
|
+
| 'utility';
|
|
5357
|
+
}
|
|
5358
|
+
}
|
|
5359
|
+
|
|
5360
|
+
interface Pix {
|
|
5361
|
+
/**
|
|
5362
|
+
* Additional fields for mandate creation.
|
|
5363
|
+
*/
|
|
5364
|
+
mandate_options?: Pix.MandateOptions;
|
|
5365
|
+
}
|
|
5366
|
+
|
|
5367
|
+
namespace Pix {
|
|
5368
|
+
interface MandateOptions {
|
|
5369
|
+
/**
|
|
5370
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
5371
|
+
*/
|
|
5372
|
+
amount?: number;
|
|
5373
|
+
|
|
5374
|
+
/**
|
|
5375
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
5376
|
+
*/
|
|
5377
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
5378
|
+
|
|
5379
|
+
/**
|
|
5380
|
+
* Type of amount. Defaults to `maximum`.
|
|
5381
|
+
*/
|
|
5382
|
+
amount_type?: MandateOptions.AmountType;
|
|
5383
|
+
|
|
5384
|
+
/**
|
|
5385
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
5386
|
+
*/
|
|
5387
|
+
currency?: string;
|
|
5388
|
+
|
|
5389
|
+
/**
|
|
5390
|
+
* Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
|
5391
|
+
*/
|
|
5392
|
+
end_date?: string;
|
|
5393
|
+
|
|
5394
|
+
/**
|
|
5395
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
5396
|
+
*/
|
|
5397
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
5398
|
+
|
|
5399
|
+
/**
|
|
5400
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
5401
|
+
*/
|
|
5402
|
+
reference?: string;
|
|
5403
|
+
|
|
5404
|
+
/**
|
|
5405
|
+
* Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
|
|
5406
|
+
*/
|
|
5407
|
+
start_date?: string;
|
|
5408
|
+
}
|
|
5409
|
+
|
|
5410
|
+
namespace MandateOptions {
|
|
5411
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
5412
|
+
|
|
5413
|
+
type AmountType = 'fixed' | 'maximum';
|
|
5414
|
+
|
|
5415
|
+
type PaymentSchedule =
|
|
5416
|
+
| 'halfyearly'
|
|
5417
|
+
| 'monthly'
|
|
5418
|
+
| 'quarterly'
|
|
5419
|
+
| 'weekly'
|
|
5420
|
+
| 'yearly';
|
|
5421
|
+
}
|
|
4432
5422
|
}
|
|
4433
5423
|
|
|
4434
5424
|
interface SepaDebit {
|
|
@@ -4476,6 +5466,11 @@ declare module 'stripe' {
|
|
|
4476
5466
|
*/
|
|
4477
5467
|
filters?: FinancialConnections.Filters;
|
|
4478
5468
|
|
|
5469
|
+
/**
|
|
5470
|
+
* Customize manual entry behavior
|
|
5471
|
+
*/
|
|
5472
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
5473
|
+
|
|
4479
5474
|
/**
|
|
4480
5475
|
* The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
|
|
4481
5476
|
*/
|
|
@@ -4498,19 +5493,39 @@ declare module 'stripe' {
|
|
|
4498
5493
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
4499
5494
|
*/
|
|
4500
5495
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
5496
|
+
|
|
5497
|
+
/**
|
|
5498
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
5499
|
+
*/
|
|
5500
|
+
institution?: string;
|
|
4501
5501
|
}
|
|
4502
5502
|
|
|
4503
5503
|
namespace Filters {
|
|
4504
5504
|
type AccountSubcategory = 'checking' | 'savings';
|
|
4505
5505
|
}
|
|
4506
5506
|
|
|
5507
|
+
interface ManualEntry {
|
|
5508
|
+
/**
|
|
5509
|
+
* Settings for configuring manual entry of account details.
|
|
5510
|
+
*/
|
|
5511
|
+
mode: ManualEntry.Mode;
|
|
5512
|
+
}
|
|
5513
|
+
|
|
5514
|
+
namespace ManualEntry {
|
|
5515
|
+
type Mode = 'automatic' | 'custom';
|
|
5516
|
+
}
|
|
5517
|
+
|
|
4507
5518
|
type Permission =
|
|
4508
5519
|
| 'balances'
|
|
4509
5520
|
| 'ownership'
|
|
4510
5521
|
| 'payment_method'
|
|
4511
5522
|
| 'transactions';
|
|
4512
5523
|
|
|
4513
|
-
type Prefetch =
|
|
5524
|
+
type Prefetch =
|
|
5525
|
+
| 'balances'
|
|
5526
|
+
| 'inferred_balances'
|
|
5527
|
+
| 'ownership'
|
|
5528
|
+
| 'transactions';
|
|
4514
5529
|
}
|
|
4515
5530
|
|
|
4516
5531
|
interface MandateOptions {
|
|
@@ -4534,6 +5549,31 @@ declare module 'stripe' {
|
|
|
4534
5549
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
4535
5550
|
}
|
|
4536
5551
|
}
|
|
5552
|
+
|
|
5553
|
+
interface SetupDetails {
|
|
5554
|
+
/**
|
|
5555
|
+
* Benefit details for this SetupIntent
|
|
5556
|
+
*/
|
|
5557
|
+
benefit?: SetupDetails.Benefit;
|
|
5558
|
+
}
|
|
5559
|
+
|
|
5560
|
+
namespace SetupDetails {
|
|
5561
|
+
interface Benefit {
|
|
5562
|
+
/**
|
|
5563
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
5564
|
+
*/
|
|
5565
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
5566
|
+
}
|
|
5567
|
+
|
|
5568
|
+
namespace Benefit {
|
|
5569
|
+
interface FrMealVoucher {
|
|
5570
|
+
/**
|
|
5571
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
5572
|
+
*/
|
|
5573
|
+
siret: string;
|
|
5574
|
+
}
|
|
5575
|
+
}
|
|
5576
|
+
}
|
|
4537
5577
|
}
|
|
4538
5578
|
|
|
4539
5579
|
interface SetupIntentVerifyMicrodepositsParams {
|