stripe 20.0.0 → 20.1.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 +1902 -12
- package/OPENAPI_VERSION +1 -1
- package/README.md +1 -0
- package/VERSION +1 -1
- package/cjs/Error.js +115 -1
- package/cjs/apiVersion.js +2 -3
- package/cjs/resources/AccountNotices.js +21 -0
- package/cjs/resources/BalanceTransfers.js +9 -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/Issuing/Programs.js +22 -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/Radar/AccountEvaluations.js +20 -0
- package/cjs/resources/SubscriptionSchedules.js +4 -0
- package/cjs/resources/Subscriptions.js +4 -0
- package/cjs/resources/Tax/Forms.js +20 -0
- package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
- package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +16 -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/AccountTokens.js +13 -0
- package/cjs/resources/V2/Core/Accounts/PersonTokens.js +16 -0
- package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
- package/cjs/resources/V2/Core/Accounts.js +27 -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/CurrencyConversions.js +21 -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/Reporting/ReportRuns.js +13 -0
- package/cjs/resources/V2/Reporting/Reports.js +12 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +12 -0
- package/cjs/resources.js +156 -8
- package/cjs/stripe.core.js +1 -1
- package/esm/Error.js +100 -0
- package/esm/apiVersion.js +1 -2
- package/esm/resources/AccountNotices.js +18 -0
- package/esm/resources/BalanceTransfers.js +6 -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/Issuing/Programs.js +19 -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/Radar/AccountEvaluations.js +17 -0
- package/esm/resources/SubscriptionSchedules.js +4 -0
- package/esm/resources/Subscriptions.js +4 -0
- package/esm/resources/Tax/Forms.js +17 -0
- package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
- package/esm/resources/TestHelpers/Capital/FinancingOffers.js +13 -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/AccountTokens.js +10 -0
- package/esm/resources/V2/Core/Accounts/PersonTokens.js +13 -0
- package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
- package/esm/resources/V2/Core/Accounts.js +24 -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/CurrencyConversions.js +18 -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/Reporting/ReportRuns.js +10 -0
- package/esm/resources/V2/Reporting/Reports.js +9 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +9 -0
- package/esm/resources.js +142 -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 +232 -1
- package/types/AccountsResource.d.ts +674 -0
- package/types/ApplicationFees.d.ts +6 -1
- package/types/Balance.d.ts +82 -0
- package/types/BalanceTransactions.d.ts +2 -1
- package/types/BalanceTransfers.d.ts +122 -0
- package/types/BalanceTransfersResource.d.ts +87 -0
- 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 +190 -0
- package/types/ChargesResource.d.ts +3855 -75
- 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 +35 -0
- package/types/CouponsResource.d.ts +23 -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 +419 -0
- package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +599 -0
- package/types/Discounts.d.ts +20 -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 +96 -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 +127 -2
- package/types/InvoiceItemsResource.d.ts +117 -6
- package/types/InvoiceLineItems.d.ts +171 -3
- package/types/Invoices.d.ts +216 -4
- package/types/InvoicesResource.d.ts +1787 -10
- 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/Programs.d.ts +42 -0
- package/types/Issuing/ProgramsResource.d.ts +96 -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 +5505 -0
- package/types/PaymentAttemptRecords.d.ts +141 -0
- package/types/PaymentIntents.d.ts +779 -3
- package/types/PaymentIntentsResource.d.ts +19573 -6528
- 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 +199 -2
- package/types/PaymentRecords.d.ts +141 -0
- package/types/Persons.d.ts +30 -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 +651 -0
- package/types/QuotePreviewInvoices.d.ts +1784 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +1034 -0
- package/types/Quotes.d.ts +876 -1
- package/types/QuotesResource.d.ts +3255 -292
- package/types/Radar/AccountEvaluations.d.ts +88 -0
- package/types/Radar/AccountEvaluationsResource.d.ts +148 -0
- 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 +39 -0
- package/types/SubscriptionItemsResource.d.ts +143 -0
- package/types/SubscriptionSchedules.d.ts +329 -0
- package/types/SubscriptionSchedulesResource.d.ts +1525 -59
- package/types/Subscriptions.d.ts +284 -1
- package/types/SubscriptionsResource.d.ts +779 -8
- 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/ReaderCollectedData.d.ts +51 -0
- package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
- package/types/Terminal/Readers.d.ts +20 -0
- package/types/TestHelpers/Capital/FinancingOffersResource.d.ts +130 -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/TokensResource.d.ts +44 -0
- package/types/Transfers.d.ts +9 -0
- package/types/TransfersResource.d.ts +7 -0
- package/types/TransitBalances.d.ts +40 -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 +735 -0
- package/types/V2/Billing/CadencesResource.d.ts +516 -0
- package/types/V2/Billing/CollectionSettingVersions.d.ts +318 -0
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
- package/types/V2/Billing/CollectionSettings.d.ts +341 -0
- package/types/V2/Billing/CollectionSettingsResource.d.ts +683 -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 +298 -0
- package/types/V2/Billing/ServiceActionsResource.d.ts +394 -0
- package/types/V2/Core/AccountLinks.d.ts +168 -0
- package/types/V2/Core/AccountLinksResource.d.ts +152 -0
- package/types/V2/Core/AccountPersonTokens.d.ts +44 -0
- package/types/V2/Core/AccountPersons.d.ts +616 -0
- package/types/V2/Core/AccountTokens.d.ts +44 -0
- package/types/V2/Core/AccountTokensResource.d.ts +1315 -0
- package/types/V2/Core/Accounts/PersonTokensResource.d.ts +509 -0
- package/types/V2/Core/Accounts/PersonsResource.d.ts +1165 -0
- package/types/V2/Core/Accounts.d.ts +8018 -0
- package/types/V2/Core/AccountsResource.d.ts +6997 -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 +4715 -9
- package/types/V2/Core/Events.d.ts +9 -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 +46 -0
- package/types/V2/MoneyManagement/Adjustments.d.ts +122 -0
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
- package/types/V2/MoneyManagement/CurrencyConversions.d.ts +98 -0
- package/types/V2/MoneyManagement/CurrencyConversionsResource.d.ts +141 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +186 -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 +250 -0
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +156 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +222 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +127 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +323 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +259 -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 +296 -0
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +225 -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 +331 -0
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +210 -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 +200 -0
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
- package/types/V2/MoneyManagement/Transactions.d.ts +227 -0
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
- package/types/V2/Payments/OffSessionPayments.d.ts +249 -0
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +306 -0
- package/types/V2/Reporting/ReportRuns.d.ts +154 -0
- package/types/V2/Reporting/ReportRunsResource.d.ts +75 -0
- package/types/V2/Reporting/Reports.d.ts +120 -0
- package/types/V2/Reporting/ReportsResource.d.ts +30 -0
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +85 -0
- package/types/V2/TestHelpers/MoneyManagementResource.d.ts +49 -0
- package/types/WebhookEndpointsResource.d.ts +76 -0
- package/types/Webhooks.d.ts +2 -0
- package/types/apiVersion.d.ts +1 -2
- package/types/index.d.ts +241 -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.
|
|
@@ -855,10 +928,31 @@ declare module 'stripe' {
|
|
|
855
928
|
|
|
856
929
|
interface Paypal {}
|
|
857
930
|
|
|
931
|
+
interface Paypay {}
|
|
932
|
+
|
|
933
|
+
interface Payto {
|
|
934
|
+
/**
|
|
935
|
+
* The account number for the bank account.
|
|
936
|
+
*/
|
|
937
|
+
account_number?: string;
|
|
938
|
+
|
|
939
|
+
/**
|
|
940
|
+
* Bank-State-Branch number of the bank account.
|
|
941
|
+
*/
|
|
942
|
+
bsb_number?: string;
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* The PayID alias for the bank account.
|
|
946
|
+
*/
|
|
947
|
+
pay_id?: string;
|
|
948
|
+
}
|
|
949
|
+
|
|
858
950
|
interface Pix {}
|
|
859
951
|
|
|
860
952
|
interface Promptpay {}
|
|
861
953
|
|
|
954
|
+
interface Qris {}
|
|
955
|
+
|
|
862
956
|
interface RadarOptions {
|
|
863
957
|
/**
|
|
864
958
|
* 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.
|
|
@@ -866,6 +960,32 @@ declare module 'stripe' {
|
|
|
866
960
|
session?: string;
|
|
867
961
|
}
|
|
868
962
|
|
|
963
|
+
interface Rechnung {
|
|
964
|
+
/**
|
|
965
|
+
* Customer's date of birth
|
|
966
|
+
*/
|
|
967
|
+
dob: Rechnung.Dob;
|
|
968
|
+
}
|
|
969
|
+
|
|
970
|
+
namespace Rechnung {
|
|
971
|
+
interface Dob {
|
|
972
|
+
/**
|
|
973
|
+
* The day of birth, between 1 and 31.
|
|
974
|
+
*/
|
|
975
|
+
day: number;
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
* The month of birth, between 1 and 12.
|
|
979
|
+
*/
|
|
980
|
+
month: number;
|
|
981
|
+
|
|
982
|
+
/**
|
|
983
|
+
* The four-digit year of birth.
|
|
984
|
+
*/
|
|
985
|
+
year: number;
|
|
986
|
+
}
|
|
987
|
+
}
|
|
988
|
+
|
|
869
989
|
interface RevolutPay {}
|
|
870
990
|
|
|
871
991
|
interface SamsungPay {}
|
|
@@ -879,6 +999,8 @@ declare module 'stripe' {
|
|
|
879
999
|
iban: string;
|
|
880
1000
|
}
|
|
881
1001
|
|
|
1002
|
+
interface Shopeepay {}
|
|
1003
|
+
|
|
882
1004
|
interface Sofort {
|
|
883
1005
|
/**
|
|
884
1006
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -890,6 +1012,22 @@ declare module 'stripe' {
|
|
|
890
1012
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
891
1013
|
}
|
|
892
1014
|
|
|
1015
|
+
interface StripeBalance {
|
|
1016
|
+
/**
|
|
1017
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
1018
|
+
*/
|
|
1019
|
+
account?: string;
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
1023
|
+
*/
|
|
1024
|
+
source_type?: StripeBalance.SourceType;
|
|
1025
|
+
}
|
|
1026
|
+
|
|
1027
|
+
namespace StripeBalance {
|
|
1028
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
1029
|
+
}
|
|
1030
|
+
|
|
893
1031
|
interface Swish {}
|
|
894
1032
|
|
|
895
1033
|
interface Twint {}
|
|
@@ -913,7 +1051,9 @@ declare module 'stripe' {
|
|
|
913
1051
|
| 'eps'
|
|
914
1052
|
| 'fpx'
|
|
915
1053
|
| 'giropay'
|
|
1054
|
+
| 'gopay'
|
|
916
1055
|
| 'grabpay'
|
|
1056
|
+
| 'id_bank_transfer'
|
|
917
1057
|
| 'ideal'
|
|
918
1058
|
| 'kakao_pay'
|
|
919
1059
|
| 'klarna'
|
|
@@ -931,13 +1071,19 @@ declare module 'stripe' {
|
|
|
931
1071
|
| 'payco'
|
|
932
1072
|
| 'paynow'
|
|
933
1073
|
| 'paypal'
|
|
1074
|
+
| 'paypay'
|
|
1075
|
+
| 'payto'
|
|
934
1076
|
| 'pix'
|
|
935
1077
|
| 'promptpay'
|
|
1078
|
+
| 'qris'
|
|
1079
|
+
| 'rechnung'
|
|
936
1080
|
| 'revolut_pay'
|
|
937
1081
|
| 'samsung_pay'
|
|
938
1082
|
| 'satispay'
|
|
939
1083
|
| 'sepa_debit'
|
|
1084
|
+
| 'shopeepay'
|
|
940
1085
|
| 'sofort'
|
|
1086
|
+
| 'stripe_balance'
|
|
941
1087
|
| 'swish'
|
|
942
1088
|
| 'twint'
|
|
943
1089
|
| 'us_bank_account'
|
|
@@ -1023,6 +1169,16 @@ declare module 'stripe' {
|
|
|
1023
1169
|
*/
|
|
1024
1170
|
paypal?: PaymentMethodOptions.Paypal;
|
|
1025
1171
|
|
|
1172
|
+
/**
|
|
1173
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
1174
|
+
*/
|
|
1175
|
+
payto?: PaymentMethodOptions.Payto;
|
|
1176
|
+
|
|
1177
|
+
/**
|
|
1178
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
1179
|
+
*/
|
|
1180
|
+
pix?: PaymentMethodOptions.Pix;
|
|
1181
|
+
|
|
1026
1182
|
/**
|
|
1027
1183
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
1028
1184
|
*/
|
|
@@ -1470,6 +1626,150 @@ declare module 'stripe' {
|
|
|
1470
1626
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
1471
1627
|
*/
|
|
1472
1628
|
billing_agreement_id?: string;
|
|
1629
|
+
|
|
1630
|
+
currency?: string;
|
|
1631
|
+
|
|
1632
|
+
/**
|
|
1633
|
+
* 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.
|
|
1634
|
+
*/
|
|
1635
|
+
subsellers?: Array<string>;
|
|
1636
|
+
}
|
|
1637
|
+
|
|
1638
|
+
interface Payto {
|
|
1639
|
+
/**
|
|
1640
|
+
* Additional fields for Mandate creation.
|
|
1641
|
+
*/
|
|
1642
|
+
mandate_options?: Payto.MandateOptions;
|
|
1643
|
+
}
|
|
1644
|
+
|
|
1645
|
+
namespace Payto {
|
|
1646
|
+
interface MandateOptions {
|
|
1647
|
+
/**
|
|
1648
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
1649
|
+
*/
|
|
1650
|
+
amount?: number;
|
|
1651
|
+
|
|
1652
|
+
/**
|
|
1653
|
+
* 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. Defaults to `maximum`.
|
|
1654
|
+
*/
|
|
1655
|
+
amount_type?: MandateOptions.AmountType;
|
|
1656
|
+
|
|
1657
|
+
/**
|
|
1658
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
1659
|
+
*/
|
|
1660
|
+
end_date?: string;
|
|
1661
|
+
|
|
1662
|
+
/**
|
|
1663
|
+
* The periodicity at which payments will be collected. Defaults to `adhoc`.
|
|
1664
|
+
*/
|
|
1665
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1666
|
+
|
|
1667
|
+
/**
|
|
1668
|
+
* 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.
|
|
1669
|
+
*/
|
|
1670
|
+
payments_per_period?: number;
|
|
1671
|
+
|
|
1672
|
+
/**
|
|
1673
|
+
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
1674
|
+
*/
|
|
1675
|
+
purpose?: MandateOptions.Purpose;
|
|
1676
|
+
|
|
1677
|
+
/**
|
|
1678
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
1679
|
+
*/
|
|
1680
|
+
start_date?: string;
|
|
1681
|
+
}
|
|
1682
|
+
|
|
1683
|
+
namespace MandateOptions {
|
|
1684
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1685
|
+
|
|
1686
|
+
type PaymentSchedule =
|
|
1687
|
+
| 'adhoc'
|
|
1688
|
+
| 'annual'
|
|
1689
|
+
| 'daily'
|
|
1690
|
+
| 'fortnightly'
|
|
1691
|
+
| 'monthly'
|
|
1692
|
+
| 'quarterly'
|
|
1693
|
+
| 'semi_annual'
|
|
1694
|
+
| 'weekly';
|
|
1695
|
+
|
|
1696
|
+
type Purpose =
|
|
1697
|
+
| 'dependant_support'
|
|
1698
|
+
| 'government'
|
|
1699
|
+
| 'loan'
|
|
1700
|
+
| 'mortgage'
|
|
1701
|
+
| 'other'
|
|
1702
|
+
| 'pension'
|
|
1703
|
+
| 'personal'
|
|
1704
|
+
| 'retail'
|
|
1705
|
+
| 'salary'
|
|
1706
|
+
| 'tax'
|
|
1707
|
+
| 'utility';
|
|
1708
|
+
}
|
|
1709
|
+
}
|
|
1710
|
+
|
|
1711
|
+
interface Pix {
|
|
1712
|
+
/**
|
|
1713
|
+
* Additional fields for mandate creation.
|
|
1714
|
+
*/
|
|
1715
|
+
mandate_options?: Pix.MandateOptions;
|
|
1716
|
+
}
|
|
1717
|
+
|
|
1718
|
+
namespace Pix {
|
|
1719
|
+
interface MandateOptions {
|
|
1720
|
+
/**
|
|
1721
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
1722
|
+
*/
|
|
1723
|
+
amount?: number;
|
|
1724
|
+
|
|
1725
|
+
/**
|
|
1726
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
1727
|
+
*/
|
|
1728
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
1729
|
+
|
|
1730
|
+
/**
|
|
1731
|
+
* Type of amount. Defaults to `maximum`.
|
|
1732
|
+
*/
|
|
1733
|
+
amount_type?: MandateOptions.AmountType;
|
|
1734
|
+
|
|
1735
|
+
/**
|
|
1736
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
1737
|
+
*/
|
|
1738
|
+
currency?: string;
|
|
1739
|
+
|
|
1740
|
+
/**
|
|
1741
|
+
* 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.
|
|
1742
|
+
*/
|
|
1743
|
+
end_date?: string;
|
|
1744
|
+
|
|
1745
|
+
/**
|
|
1746
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
1747
|
+
*/
|
|
1748
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1749
|
+
|
|
1750
|
+
/**
|
|
1751
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
1752
|
+
*/
|
|
1753
|
+
reference?: string;
|
|
1754
|
+
|
|
1755
|
+
/**
|
|
1756
|
+
* 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.
|
|
1757
|
+
*/
|
|
1758
|
+
start_date?: string;
|
|
1759
|
+
}
|
|
1760
|
+
|
|
1761
|
+
namespace MandateOptions {
|
|
1762
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
1763
|
+
|
|
1764
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1765
|
+
|
|
1766
|
+
type PaymentSchedule =
|
|
1767
|
+
| 'halfyearly'
|
|
1768
|
+
| 'monthly'
|
|
1769
|
+
| 'quarterly'
|
|
1770
|
+
| 'weekly'
|
|
1771
|
+
| 'yearly';
|
|
1772
|
+
}
|
|
1473
1773
|
}
|
|
1474
1774
|
|
|
1475
1775
|
interface SepaDebit {
|
|
@@ -1517,6 +1817,11 @@ declare module 'stripe' {
|
|
|
1517
1817
|
*/
|
|
1518
1818
|
filters?: FinancialConnections.Filters;
|
|
1519
1819
|
|
|
1820
|
+
/**
|
|
1821
|
+
* Customize manual entry behavior
|
|
1822
|
+
*/
|
|
1823
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
1824
|
+
|
|
1520
1825
|
/**
|
|
1521
1826
|
* 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`.
|
|
1522
1827
|
*/
|
|
@@ -1539,19 +1844,39 @@ declare module 'stripe' {
|
|
|
1539
1844
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1540
1845
|
*/
|
|
1541
1846
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1847
|
+
|
|
1848
|
+
/**
|
|
1849
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
1850
|
+
*/
|
|
1851
|
+
institution?: string;
|
|
1542
1852
|
}
|
|
1543
1853
|
|
|
1544
1854
|
namespace Filters {
|
|
1545
1855
|
type AccountSubcategory = 'checking' | 'savings';
|
|
1546
1856
|
}
|
|
1547
1857
|
|
|
1858
|
+
interface ManualEntry {
|
|
1859
|
+
/**
|
|
1860
|
+
* Settings for configuring manual entry of account details.
|
|
1861
|
+
*/
|
|
1862
|
+
mode: ManualEntry.Mode;
|
|
1863
|
+
}
|
|
1864
|
+
|
|
1865
|
+
namespace ManualEntry {
|
|
1866
|
+
type Mode = 'automatic' | 'custom';
|
|
1867
|
+
}
|
|
1868
|
+
|
|
1548
1869
|
type Permission =
|
|
1549
1870
|
| 'balances'
|
|
1550
1871
|
| 'ownership'
|
|
1551
1872
|
| 'payment_method'
|
|
1552
1873
|
| 'transactions';
|
|
1553
1874
|
|
|
1554
|
-
type Prefetch =
|
|
1875
|
+
type Prefetch =
|
|
1876
|
+
| 'balances'
|
|
1877
|
+
| 'inferred_balances'
|
|
1878
|
+
| 'ownership'
|
|
1879
|
+
| 'transactions';
|
|
1555
1880
|
}
|
|
1556
1881
|
|
|
1557
1882
|
interface MandateOptions {
|
|
@@ -1576,6 +1901,31 @@ declare module 'stripe' {
|
|
|
1576
1901
|
}
|
|
1577
1902
|
}
|
|
1578
1903
|
|
|
1904
|
+
interface SetupDetails {
|
|
1905
|
+
/**
|
|
1906
|
+
* Benefit details for this SetupIntent
|
|
1907
|
+
*/
|
|
1908
|
+
benefit?: SetupDetails.Benefit;
|
|
1909
|
+
}
|
|
1910
|
+
|
|
1911
|
+
namespace SetupDetails {
|
|
1912
|
+
interface Benefit {
|
|
1913
|
+
/**
|
|
1914
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
1915
|
+
*/
|
|
1916
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
1917
|
+
}
|
|
1918
|
+
|
|
1919
|
+
namespace Benefit {
|
|
1920
|
+
interface FrMealVoucher {
|
|
1921
|
+
/**
|
|
1922
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
1923
|
+
*/
|
|
1924
|
+
siret: string;
|
|
1925
|
+
}
|
|
1926
|
+
}
|
|
1927
|
+
}
|
|
1928
|
+
|
|
1579
1929
|
interface SingleUse {
|
|
1580
1930
|
/**
|
|
1581
1931
|
* 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).
|
|
@@ -1618,6 +1968,13 @@ declare module 'stripe' {
|
|
|
1618
1968
|
*/
|
|
1619
1969
|
customer?: string;
|
|
1620
1970
|
|
|
1971
|
+
/**
|
|
1972
|
+
* ID of the Account this SetupIntent belongs to, if one exists.
|
|
1973
|
+
*
|
|
1974
|
+
* 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.
|
|
1975
|
+
*/
|
|
1976
|
+
customer_account?: string;
|
|
1977
|
+
|
|
1621
1978
|
/**
|
|
1622
1979
|
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1623
1980
|
*/
|
|
@@ -1672,6 +2029,11 @@ declare module 'stripe' {
|
|
|
1672
2029
|
* 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).
|
|
1673
2030
|
*/
|
|
1674
2031
|
payment_method_types?: Array<string>;
|
|
2032
|
+
|
|
2033
|
+
/**
|
|
2034
|
+
* Provides industry-specific information about the SetupIntent.
|
|
2035
|
+
*/
|
|
2036
|
+
setup_details?: SetupIntentUpdateParams.SetupDetails;
|
|
1675
2037
|
}
|
|
1676
2038
|
|
|
1677
2039
|
namespace SetupIntentUpdateParams {
|
|
@@ -1695,7 +2057,9 @@ declare module 'stripe' {
|
|
|
1695
2057
|
| 'eps'
|
|
1696
2058
|
| 'fpx'
|
|
1697
2059
|
| 'giropay'
|
|
2060
|
+
| 'gopay'
|
|
1698
2061
|
| 'grabpay'
|
|
2062
|
+
| 'id_bank_transfer'
|
|
1699
2063
|
| 'ideal'
|
|
1700
2064
|
| 'kakao_pay'
|
|
1701
2065
|
| 'klarna'
|
|
@@ -1712,13 +2076,19 @@ declare module 'stripe' {
|
|
|
1712
2076
|
| 'payco'
|
|
1713
2077
|
| 'paynow'
|
|
1714
2078
|
| 'paypal'
|
|
2079
|
+
| 'paypay'
|
|
2080
|
+
| 'payto'
|
|
1715
2081
|
| 'pix'
|
|
1716
2082
|
| 'promptpay'
|
|
2083
|
+
| 'qris'
|
|
2084
|
+
| 'rechnung'
|
|
1717
2085
|
| 'revolut_pay'
|
|
1718
2086
|
| 'samsung_pay'
|
|
1719
2087
|
| 'satispay'
|
|
1720
2088
|
| 'sepa_debit'
|
|
2089
|
+
| 'shopeepay'
|
|
1721
2090
|
| 'sofort'
|
|
2091
|
+
| 'stripe_balance'
|
|
1722
2092
|
| 'swish'
|
|
1723
2093
|
| 'twint'
|
|
1724
2094
|
| 'us_bank_account'
|
|
@@ -1828,11 +2198,21 @@ declare module 'stripe' {
|
|
|
1828
2198
|
*/
|
|
1829
2199
|
giropay?: PaymentMethodData.Giropay;
|
|
1830
2200
|
|
|
2201
|
+
/**
|
|
2202
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
2203
|
+
*/
|
|
2204
|
+
gopay?: PaymentMethodData.Gopay;
|
|
2205
|
+
|
|
1831
2206
|
/**
|
|
1832
2207
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
1833
2208
|
*/
|
|
1834
2209
|
grabpay?: PaymentMethodData.Grabpay;
|
|
1835
2210
|
|
|
2211
|
+
/**
|
|
2212
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
2213
|
+
*/
|
|
2214
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
2215
|
+
|
|
1836
2216
|
/**
|
|
1837
2217
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
1838
2218
|
*/
|
|
@@ -1928,6 +2308,16 @@ declare module 'stripe' {
|
|
|
1928
2308
|
*/
|
|
1929
2309
|
paypal?: PaymentMethodData.Paypal;
|
|
1930
2310
|
|
|
2311
|
+
/**
|
|
2312
|
+
* If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
|
|
2313
|
+
*/
|
|
2314
|
+
paypay?: PaymentMethodData.Paypay;
|
|
2315
|
+
|
|
2316
|
+
/**
|
|
2317
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
2318
|
+
*/
|
|
2319
|
+
payto?: PaymentMethodData.Payto;
|
|
2320
|
+
|
|
1931
2321
|
/**
|
|
1932
2322
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
1933
2323
|
*/
|
|
@@ -1938,11 +2328,21 @@ declare module 'stripe' {
|
|
|
1938
2328
|
*/
|
|
1939
2329
|
promptpay?: PaymentMethodData.Promptpay;
|
|
1940
2330
|
|
|
2331
|
+
/**
|
|
2332
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
2333
|
+
*/
|
|
2334
|
+
qris?: PaymentMethodData.Qris;
|
|
2335
|
+
|
|
1941
2336
|
/**
|
|
1942
2337
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
1943
2338
|
*/
|
|
1944
2339
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
1945
2340
|
|
|
2341
|
+
/**
|
|
2342
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
2343
|
+
*/
|
|
2344
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
2345
|
+
|
|
1946
2346
|
/**
|
|
1947
2347
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
1948
2348
|
*/
|
|
@@ -1963,11 +2363,21 @@ declare module 'stripe' {
|
|
|
1963
2363
|
*/
|
|
1964
2364
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
1965
2365
|
|
|
2366
|
+
/**
|
|
2367
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
2368
|
+
*/
|
|
2369
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
2370
|
+
|
|
1966
2371
|
/**
|
|
1967
2372
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
1968
2373
|
*/
|
|
1969
2374
|
sofort?: PaymentMethodData.Sofort;
|
|
1970
2375
|
|
|
2376
|
+
/**
|
|
2377
|
+
* This hash contains details about the Stripe balance payment method.
|
|
2378
|
+
*/
|
|
2379
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
2380
|
+
|
|
1971
2381
|
/**
|
|
1972
2382
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
1973
2383
|
*/
|
|
@@ -2180,8 +2590,21 @@ declare module 'stripe' {
|
|
|
2180
2590
|
|
|
2181
2591
|
interface Giropay {}
|
|
2182
2592
|
|
|
2593
|
+
interface Gopay {}
|
|
2594
|
+
|
|
2183
2595
|
interface Grabpay {}
|
|
2184
2596
|
|
|
2597
|
+
interface IdBankTransfer {
|
|
2598
|
+
/**
|
|
2599
|
+
* Bank where the account is held.
|
|
2600
|
+
*/
|
|
2601
|
+
bank?: IdBankTransfer.Bank;
|
|
2602
|
+
}
|
|
2603
|
+
|
|
2604
|
+
namespace IdBankTransfer {
|
|
2605
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
2606
|
+
}
|
|
2607
|
+
|
|
2185
2608
|
interface Ideal {
|
|
2186
2609
|
/**
|
|
2187
2610
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -2340,10 +2763,31 @@ declare module 'stripe' {
|
|
|
2340
2763
|
|
|
2341
2764
|
interface Paypal {}
|
|
2342
2765
|
|
|
2766
|
+
interface Paypay {}
|
|
2767
|
+
|
|
2768
|
+
interface Payto {
|
|
2769
|
+
/**
|
|
2770
|
+
* The account number for the bank account.
|
|
2771
|
+
*/
|
|
2772
|
+
account_number?: string;
|
|
2773
|
+
|
|
2774
|
+
/**
|
|
2775
|
+
* Bank-State-Branch number of the bank account.
|
|
2776
|
+
*/
|
|
2777
|
+
bsb_number?: string;
|
|
2778
|
+
|
|
2779
|
+
/**
|
|
2780
|
+
* The PayID alias for the bank account.
|
|
2781
|
+
*/
|
|
2782
|
+
pay_id?: string;
|
|
2783
|
+
}
|
|
2784
|
+
|
|
2343
2785
|
interface Pix {}
|
|
2344
2786
|
|
|
2345
2787
|
interface Promptpay {}
|
|
2346
2788
|
|
|
2789
|
+
interface Qris {}
|
|
2790
|
+
|
|
2347
2791
|
interface RadarOptions {
|
|
2348
2792
|
/**
|
|
2349
2793
|
* 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.
|
|
@@ -2351,7 +2795,33 @@ declare module 'stripe' {
|
|
|
2351
2795
|
session?: string;
|
|
2352
2796
|
}
|
|
2353
2797
|
|
|
2354
|
-
interface
|
|
2798
|
+
interface Rechnung {
|
|
2799
|
+
/**
|
|
2800
|
+
* Customer's date of birth
|
|
2801
|
+
*/
|
|
2802
|
+
dob: Rechnung.Dob;
|
|
2803
|
+
}
|
|
2804
|
+
|
|
2805
|
+
namespace Rechnung {
|
|
2806
|
+
interface Dob {
|
|
2807
|
+
/**
|
|
2808
|
+
* The day of birth, between 1 and 31.
|
|
2809
|
+
*/
|
|
2810
|
+
day: number;
|
|
2811
|
+
|
|
2812
|
+
/**
|
|
2813
|
+
* The month of birth, between 1 and 12.
|
|
2814
|
+
*/
|
|
2815
|
+
month: number;
|
|
2816
|
+
|
|
2817
|
+
/**
|
|
2818
|
+
* The four-digit year of birth.
|
|
2819
|
+
*/
|
|
2820
|
+
year: number;
|
|
2821
|
+
}
|
|
2822
|
+
}
|
|
2823
|
+
|
|
2824
|
+
interface RevolutPay {}
|
|
2355
2825
|
|
|
2356
2826
|
interface SamsungPay {}
|
|
2357
2827
|
|
|
@@ -2364,6 +2834,8 @@ declare module 'stripe' {
|
|
|
2364
2834
|
iban: string;
|
|
2365
2835
|
}
|
|
2366
2836
|
|
|
2837
|
+
interface Shopeepay {}
|
|
2838
|
+
|
|
2367
2839
|
interface Sofort {
|
|
2368
2840
|
/**
|
|
2369
2841
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -2375,6 +2847,22 @@ declare module 'stripe' {
|
|
|
2375
2847
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
2376
2848
|
}
|
|
2377
2849
|
|
|
2850
|
+
interface StripeBalance {
|
|
2851
|
+
/**
|
|
2852
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
2853
|
+
*/
|
|
2854
|
+
account?: string;
|
|
2855
|
+
|
|
2856
|
+
/**
|
|
2857
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
2858
|
+
*/
|
|
2859
|
+
source_type?: StripeBalance.SourceType;
|
|
2860
|
+
}
|
|
2861
|
+
|
|
2862
|
+
namespace StripeBalance {
|
|
2863
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
2864
|
+
}
|
|
2865
|
+
|
|
2378
2866
|
interface Swish {}
|
|
2379
2867
|
|
|
2380
2868
|
interface Twint {}
|
|
@@ -2398,7 +2886,9 @@ declare module 'stripe' {
|
|
|
2398
2886
|
| 'eps'
|
|
2399
2887
|
| 'fpx'
|
|
2400
2888
|
| 'giropay'
|
|
2889
|
+
| 'gopay'
|
|
2401
2890
|
| 'grabpay'
|
|
2891
|
+
| 'id_bank_transfer'
|
|
2402
2892
|
| 'ideal'
|
|
2403
2893
|
| 'kakao_pay'
|
|
2404
2894
|
| 'klarna'
|
|
@@ -2416,13 +2906,19 @@ declare module 'stripe' {
|
|
|
2416
2906
|
| 'payco'
|
|
2417
2907
|
| 'paynow'
|
|
2418
2908
|
| 'paypal'
|
|
2909
|
+
| 'paypay'
|
|
2910
|
+
| 'payto'
|
|
2419
2911
|
| 'pix'
|
|
2420
2912
|
| 'promptpay'
|
|
2913
|
+
| 'qris'
|
|
2914
|
+
| 'rechnung'
|
|
2421
2915
|
| 'revolut_pay'
|
|
2422
2916
|
| 'samsung_pay'
|
|
2423
2917
|
| 'satispay'
|
|
2424
2918
|
| 'sepa_debit'
|
|
2919
|
+
| 'shopeepay'
|
|
2425
2920
|
| 'sofort'
|
|
2921
|
+
| 'stripe_balance'
|
|
2426
2922
|
| 'swish'
|
|
2427
2923
|
| 'twint'
|
|
2428
2924
|
| 'us_bank_account'
|
|
@@ -2508,6 +3004,16 @@ declare module 'stripe' {
|
|
|
2508
3004
|
*/
|
|
2509
3005
|
paypal?: PaymentMethodOptions.Paypal;
|
|
2510
3006
|
|
|
3007
|
+
/**
|
|
3008
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
3009
|
+
*/
|
|
3010
|
+
payto?: PaymentMethodOptions.Payto;
|
|
3011
|
+
|
|
3012
|
+
/**
|
|
3013
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
3014
|
+
*/
|
|
3015
|
+
pix?: PaymentMethodOptions.Pix;
|
|
3016
|
+
|
|
2511
3017
|
/**
|
|
2512
3018
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
2513
3019
|
*/
|
|
@@ -2955,6 +3461,150 @@ declare module 'stripe' {
|
|
|
2955
3461
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
2956
3462
|
*/
|
|
2957
3463
|
billing_agreement_id?: string;
|
|
3464
|
+
|
|
3465
|
+
currency?: string;
|
|
3466
|
+
|
|
3467
|
+
/**
|
|
3468
|
+
* 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.
|
|
3469
|
+
*/
|
|
3470
|
+
subsellers?: Array<string>;
|
|
3471
|
+
}
|
|
3472
|
+
|
|
3473
|
+
interface Payto {
|
|
3474
|
+
/**
|
|
3475
|
+
* Additional fields for Mandate creation.
|
|
3476
|
+
*/
|
|
3477
|
+
mandate_options?: Payto.MandateOptions;
|
|
3478
|
+
}
|
|
3479
|
+
|
|
3480
|
+
namespace Payto {
|
|
3481
|
+
interface MandateOptions {
|
|
3482
|
+
/**
|
|
3483
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
3484
|
+
*/
|
|
3485
|
+
amount?: number;
|
|
3486
|
+
|
|
3487
|
+
/**
|
|
3488
|
+
* 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. Defaults to `maximum`.
|
|
3489
|
+
*/
|
|
3490
|
+
amount_type?: MandateOptions.AmountType;
|
|
3491
|
+
|
|
3492
|
+
/**
|
|
3493
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
3494
|
+
*/
|
|
3495
|
+
end_date?: string;
|
|
3496
|
+
|
|
3497
|
+
/**
|
|
3498
|
+
* The periodicity at which payments will be collected. Defaults to `adhoc`.
|
|
3499
|
+
*/
|
|
3500
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
3501
|
+
|
|
3502
|
+
/**
|
|
3503
|
+
* 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.
|
|
3504
|
+
*/
|
|
3505
|
+
payments_per_period?: number;
|
|
3506
|
+
|
|
3507
|
+
/**
|
|
3508
|
+
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
3509
|
+
*/
|
|
3510
|
+
purpose?: MandateOptions.Purpose;
|
|
3511
|
+
|
|
3512
|
+
/**
|
|
3513
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
3514
|
+
*/
|
|
3515
|
+
start_date?: string;
|
|
3516
|
+
}
|
|
3517
|
+
|
|
3518
|
+
namespace MandateOptions {
|
|
3519
|
+
type AmountType = 'fixed' | 'maximum';
|
|
3520
|
+
|
|
3521
|
+
type PaymentSchedule =
|
|
3522
|
+
| 'adhoc'
|
|
3523
|
+
| 'annual'
|
|
3524
|
+
| 'daily'
|
|
3525
|
+
| 'fortnightly'
|
|
3526
|
+
| 'monthly'
|
|
3527
|
+
| 'quarterly'
|
|
3528
|
+
| 'semi_annual'
|
|
3529
|
+
| 'weekly';
|
|
3530
|
+
|
|
3531
|
+
type Purpose =
|
|
3532
|
+
| 'dependant_support'
|
|
3533
|
+
| 'government'
|
|
3534
|
+
| 'loan'
|
|
3535
|
+
| 'mortgage'
|
|
3536
|
+
| 'other'
|
|
3537
|
+
| 'pension'
|
|
3538
|
+
| 'personal'
|
|
3539
|
+
| 'retail'
|
|
3540
|
+
| 'salary'
|
|
3541
|
+
| 'tax'
|
|
3542
|
+
| 'utility';
|
|
3543
|
+
}
|
|
3544
|
+
}
|
|
3545
|
+
|
|
3546
|
+
interface Pix {
|
|
3547
|
+
/**
|
|
3548
|
+
* Additional fields for mandate creation.
|
|
3549
|
+
*/
|
|
3550
|
+
mandate_options?: Pix.MandateOptions;
|
|
3551
|
+
}
|
|
3552
|
+
|
|
3553
|
+
namespace Pix {
|
|
3554
|
+
interface MandateOptions {
|
|
3555
|
+
/**
|
|
3556
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
3557
|
+
*/
|
|
3558
|
+
amount?: number;
|
|
3559
|
+
|
|
3560
|
+
/**
|
|
3561
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
3562
|
+
*/
|
|
3563
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
3564
|
+
|
|
3565
|
+
/**
|
|
3566
|
+
* Type of amount. Defaults to `maximum`.
|
|
3567
|
+
*/
|
|
3568
|
+
amount_type?: MandateOptions.AmountType;
|
|
3569
|
+
|
|
3570
|
+
/**
|
|
3571
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
3572
|
+
*/
|
|
3573
|
+
currency?: string;
|
|
3574
|
+
|
|
3575
|
+
/**
|
|
3576
|
+
* 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.
|
|
3577
|
+
*/
|
|
3578
|
+
end_date?: string;
|
|
3579
|
+
|
|
3580
|
+
/**
|
|
3581
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
3582
|
+
*/
|
|
3583
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
3584
|
+
|
|
3585
|
+
/**
|
|
3586
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
3587
|
+
*/
|
|
3588
|
+
reference?: string;
|
|
3589
|
+
|
|
3590
|
+
/**
|
|
3591
|
+
* 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.
|
|
3592
|
+
*/
|
|
3593
|
+
start_date?: string;
|
|
3594
|
+
}
|
|
3595
|
+
|
|
3596
|
+
namespace MandateOptions {
|
|
3597
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
3598
|
+
|
|
3599
|
+
type AmountType = 'fixed' | 'maximum';
|
|
3600
|
+
|
|
3601
|
+
type PaymentSchedule =
|
|
3602
|
+
| 'halfyearly'
|
|
3603
|
+
| 'monthly'
|
|
3604
|
+
| 'quarterly'
|
|
3605
|
+
| 'weekly'
|
|
3606
|
+
| 'yearly';
|
|
3607
|
+
}
|
|
2958
3608
|
}
|
|
2959
3609
|
|
|
2960
3610
|
interface SepaDebit {
|
|
@@ -3002,6 +3652,11 @@ declare module 'stripe' {
|
|
|
3002
3652
|
*/
|
|
3003
3653
|
filters?: FinancialConnections.Filters;
|
|
3004
3654
|
|
|
3655
|
+
/**
|
|
3656
|
+
* Customize manual entry behavior
|
|
3657
|
+
*/
|
|
3658
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
3659
|
+
|
|
3005
3660
|
/**
|
|
3006
3661
|
* 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`.
|
|
3007
3662
|
*/
|
|
@@ -3024,19 +3679,39 @@ declare module 'stripe' {
|
|
|
3024
3679
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
3025
3680
|
*/
|
|
3026
3681
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
3682
|
+
|
|
3683
|
+
/**
|
|
3684
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
3685
|
+
*/
|
|
3686
|
+
institution?: string;
|
|
3027
3687
|
}
|
|
3028
3688
|
|
|
3029
3689
|
namespace Filters {
|
|
3030
3690
|
type AccountSubcategory = 'checking' | 'savings';
|
|
3031
3691
|
}
|
|
3032
3692
|
|
|
3693
|
+
interface ManualEntry {
|
|
3694
|
+
/**
|
|
3695
|
+
* Settings for configuring manual entry of account details.
|
|
3696
|
+
*/
|
|
3697
|
+
mode: ManualEntry.Mode;
|
|
3698
|
+
}
|
|
3699
|
+
|
|
3700
|
+
namespace ManualEntry {
|
|
3701
|
+
type Mode = 'automatic' | 'custom';
|
|
3702
|
+
}
|
|
3703
|
+
|
|
3033
3704
|
type Permission =
|
|
3034
3705
|
| 'balances'
|
|
3035
3706
|
| 'ownership'
|
|
3036
3707
|
| 'payment_method'
|
|
3037
3708
|
| 'transactions';
|
|
3038
3709
|
|
|
3039
|
-
type Prefetch =
|
|
3710
|
+
type Prefetch =
|
|
3711
|
+
| 'balances'
|
|
3712
|
+
| 'inferred_balances'
|
|
3713
|
+
| 'ownership'
|
|
3714
|
+
| 'transactions';
|
|
3040
3715
|
}
|
|
3041
3716
|
|
|
3042
3717
|
interface MandateOptions {
|
|
@@ -3060,6 +3735,31 @@ declare module 'stripe' {
|
|
|
3060
3735
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
3061
3736
|
}
|
|
3062
3737
|
}
|
|
3738
|
+
|
|
3739
|
+
interface SetupDetails {
|
|
3740
|
+
/**
|
|
3741
|
+
* Benefit details for this SetupIntent
|
|
3742
|
+
*/
|
|
3743
|
+
benefit?: SetupDetails.Benefit;
|
|
3744
|
+
}
|
|
3745
|
+
|
|
3746
|
+
namespace SetupDetails {
|
|
3747
|
+
interface Benefit {
|
|
3748
|
+
/**
|
|
3749
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
3750
|
+
*/
|
|
3751
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
3752
|
+
}
|
|
3753
|
+
|
|
3754
|
+
namespace Benefit {
|
|
3755
|
+
interface FrMealVoucher {
|
|
3756
|
+
/**
|
|
3757
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
3758
|
+
*/
|
|
3759
|
+
siret: string;
|
|
3760
|
+
}
|
|
3761
|
+
}
|
|
3762
|
+
}
|
|
3063
3763
|
}
|
|
3064
3764
|
|
|
3065
3765
|
interface SetupIntentListParams extends PaginationParams {
|
|
@@ -3080,6 +3780,11 @@ declare module 'stripe' {
|
|
|
3080
3780
|
*/
|
|
3081
3781
|
customer?: string;
|
|
3082
3782
|
|
|
3783
|
+
/**
|
|
3784
|
+
* Only return SetupIntents for the account specified by this customer ID.
|
|
3785
|
+
*/
|
|
3786
|
+
customer_account?: string;
|
|
3787
|
+
|
|
3083
3788
|
/**
|
|
3084
3789
|
* Specifies which fields in the response should be expanded.
|
|
3085
3790
|
*/
|
|
@@ -3148,6 +3853,11 @@ declare module 'stripe' {
|
|
|
3148
3853
|
*/
|
|
3149
3854
|
return_url?: string;
|
|
3150
3855
|
|
|
3856
|
+
/**
|
|
3857
|
+
* Provides industry-specific information about the SetupIntent.
|
|
3858
|
+
*/
|
|
3859
|
+
setup_details?: SetupIntentConfirmParams.SetupDetails;
|
|
3860
|
+
|
|
3151
3861
|
/**
|
|
3152
3862
|
* Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
|
|
3153
3863
|
*/
|
|
@@ -3305,11 +4015,21 @@ declare module 'stripe' {
|
|
|
3305
4015
|
*/
|
|
3306
4016
|
giropay?: PaymentMethodData.Giropay;
|
|
3307
4017
|
|
|
4018
|
+
/**
|
|
4019
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
4020
|
+
*/
|
|
4021
|
+
gopay?: PaymentMethodData.Gopay;
|
|
4022
|
+
|
|
3308
4023
|
/**
|
|
3309
4024
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
3310
4025
|
*/
|
|
3311
4026
|
grabpay?: PaymentMethodData.Grabpay;
|
|
3312
4027
|
|
|
4028
|
+
/**
|
|
4029
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
4030
|
+
*/
|
|
4031
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
4032
|
+
|
|
3313
4033
|
/**
|
|
3314
4034
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
3315
4035
|
*/
|
|
@@ -3405,6 +4125,16 @@ declare module 'stripe' {
|
|
|
3405
4125
|
*/
|
|
3406
4126
|
paypal?: PaymentMethodData.Paypal;
|
|
3407
4127
|
|
|
4128
|
+
/**
|
|
4129
|
+
* If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
|
|
4130
|
+
*/
|
|
4131
|
+
paypay?: PaymentMethodData.Paypay;
|
|
4132
|
+
|
|
4133
|
+
/**
|
|
4134
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
4135
|
+
*/
|
|
4136
|
+
payto?: PaymentMethodData.Payto;
|
|
4137
|
+
|
|
3408
4138
|
/**
|
|
3409
4139
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
3410
4140
|
*/
|
|
@@ -3415,11 +4145,21 @@ declare module 'stripe' {
|
|
|
3415
4145
|
*/
|
|
3416
4146
|
promptpay?: PaymentMethodData.Promptpay;
|
|
3417
4147
|
|
|
4148
|
+
/**
|
|
4149
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
4150
|
+
*/
|
|
4151
|
+
qris?: PaymentMethodData.Qris;
|
|
4152
|
+
|
|
3418
4153
|
/**
|
|
3419
4154
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
3420
4155
|
*/
|
|
3421
4156
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
3422
4157
|
|
|
4158
|
+
/**
|
|
4159
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
4160
|
+
*/
|
|
4161
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
4162
|
+
|
|
3423
4163
|
/**
|
|
3424
4164
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
3425
4165
|
*/
|
|
@@ -3440,11 +4180,21 @@ declare module 'stripe' {
|
|
|
3440
4180
|
*/
|
|
3441
4181
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
3442
4182
|
|
|
4183
|
+
/**
|
|
4184
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
4185
|
+
*/
|
|
4186
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
4187
|
+
|
|
3443
4188
|
/**
|
|
3444
4189
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
3445
4190
|
*/
|
|
3446
4191
|
sofort?: PaymentMethodData.Sofort;
|
|
3447
4192
|
|
|
4193
|
+
/**
|
|
4194
|
+
* This hash contains details about the Stripe balance payment method.
|
|
4195
|
+
*/
|
|
4196
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
4197
|
+
|
|
3448
4198
|
/**
|
|
3449
4199
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
3450
4200
|
*/
|
|
@@ -3657,8 +4407,21 @@ declare module 'stripe' {
|
|
|
3657
4407
|
|
|
3658
4408
|
interface Giropay {}
|
|
3659
4409
|
|
|
4410
|
+
interface Gopay {}
|
|
4411
|
+
|
|
3660
4412
|
interface Grabpay {}
|
|
3661
4413
|
|
|
4414
|
+
interface IdBankTransfer {
|
|
4415
|
+
/**
|
|
4416
|
+
* Bank where the account is held.
|
|
4417
|
+
*/
|
|
4418
|
+
bank?: IdBankTransfer.Bank;
|
|
4419
|
+
}
|
|
4420
|
+
|
|
4421
|
+
namespace IdBankTransfer {
|
|
4422
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
4423
|
+
}
|
|
4424
|
+
|
|
3662
4425
|
interface Ideal {
|
|
3663
4426
|
/**
|
|
3664
4427
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -3817,10 +4580,31 @@ declare module 'stripe' {
|
|
|
3817
4580
|
|
|
3818
4581
|
interface Paypal {}
|
|
3819
4582
|
|
|
4583
|
+
interface Paypay {}
|
|
4584
|
+
|
|
4585
|
+
interface Payto {
|
|
4586
|
+
/**
|
|
4587
|
+
* The account number for the bank account.
|
|
4588
|
+
*/
|
|
4589
|
+
account_number?: string;
|
|
4590
|
+
|
|
4591
|
+
/**
|
|
4592
|
+
* Bank-State-Branch number of the bank account.
|
|
4593
|
+
*/
|
|
4594
|
+
bsb_number?: string;
|
|
4595
|
+
|
|
4596
|
+
/**
|
|
4597
|
+
* The PayID alias for the bank account.
|
|
4598
|
+
*/
|
|
4599
|
+
pay_id?: string;
|
|
4600
|
+
}
|
|
4601
|
+
|
|
3820
4602
|
interface Pix {}
|
|
3821
4603
|
|
|
3822
4604
|
interface Promptpay {}
|
|
3823
4605
|
|
|
4606
|
+
interface Qris {}
|
|
4607
|
+
|
|
3824
4608
|
interface RadarOptions {
|
|
3825
4609
|
/**
|
|
3826
4610
|
* 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.
|
|
@@ -3828,6 +4612,32 @@ declare module 'stripe' {
|
|
|
3828
4612
|
session?: string;
|
|
3829
4613
|
}
|
|
3830
4614
|
|
|
4615
|
+
interface Rechnung {
|
|
4616
|
+
/**
|
|
4617
|
+
* Customer's date of birth
|
|
4618
|
+
*/
|
|
4619
|
+
dob: Rechnung.Dob;
|
|
4620
|
+
}
|
|
4621
|
+
|
|
4622
|
+
namespace Rechnung {
|
|
4623
|
+
interface Dob {
|
|
4624
|
+
/**
|
|
4625
|
+
* The day of birth, between 1 and 31.
|
|
4626
|
+
*/
|
|
4627
|
+
day: number;
|
|
4628
|
+
|
|
4629
|
+
/**
|
|
4630
|
+
* The month of birth, between 1 and 12.
|
|
4631
|
+
*/
|
|
4632
|
+
month: number;
|
|
4633
|
+
|
|
4634
|
+
/**
|
|
4635
|
+
* The four-digit year of birth.
|
|
4636
|
+
*/
|
|
4637
|
+
year: number;
|
|
4638
|
+
}
|
|
4639
|
+
}
|
|
4640
|
+
|
|
3831
4641
|
interface RevolutPay {}
|
|
3832
4642
|
|
|
3833
4643
|
interface SamsungPay {}
|
|
@@ -3841,6 +4651,8 @@ declare module 'stripe' {
|
|
|
3841
4651
|
iban: string;
|
|
3842
4652
|
}
|
|
3843
4653
|
|
|
4654
|
+
interface Shopeepay {}
|
|
4655
|
+
|
|
3844
4656
|
interface Sofort {
|
|
3845
4657
|
/**
|
|
3846
4658
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -3852,6 +4664,22 @@ declare module 'stripe' {
|
|
|
3852
4664
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
3853
4665
|
}
|
|
3854
4666
|
|
|
4667
|
+
interface StripeBalance {
|
|
4668
|
+
/**
|
|
4669
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
4670
|
+
*/
|
|
4671
|
+
account?: string;
|
|
4672
|
+
|
|
4673
|
+
/**
|
|
4674
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
4675
|
+
*/
|
|
4676
|
+
source_type?: StripeBalance.SourceType;
|
|
4677
|
+
}
|
|
4678
|
+
|
|
4679
|
+
namespace StripeBalance {
|
|
4680
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
4681
|
+
}
|
|
4682
|
+
|
|
3855
4683
|
interface Swish {}
|
|
3856
4684
|
|
|
3857
4685
|
interface Twint {}
|
|
@@ -3875,7 +4703,9 @@ declare module 'stripe' {
|
|
|
3875
4703
|
| 'eps'
|
|
3876
4704
|
| 'fpx'
|
|
3877
4705
|
| 'giropay'
|
|
4706
|
+
| 'gopay'
|
|
3878
4707
|
| 'grabpay'
|
|
4708
|
+
| 'id_bank_transfer'
|
|
3879
4709
|
| 'ideal'
|
|
3880
4710
|
| 'kakao_pay'
|
|
3881
4711
|
| 'klarna'
|
|
@@ -3893,13 +4723,19 @@ declare module 'stripe' {
|
|
|
3893
4723
|
| 'payco'
|
|
3894
4724
|
| 'paynow'
|
|
3895
4725
|
| 'paypal'
|
|
4726
|
+
| 'paypay'
|
|
4727
|
+
| 'payto'
|
|
3896
4728
|
| 'pix'
|
|
3897
4729
|
| 'promptpay'
|
|
4730
|
+
| 'qris'
|
|
4731
|
+
| 'rechnung'
|
|
3898
4732
|
| 'revolut_pay'
|
|
3899
4733
|
| 'samsung_pay'
|
|
3900
4734
|
| 'satispay'
|
|
3901
4735
|
| 'sepa_debit'
|
|
4736
|
+
| 'shopeepay'
|
|
3902
4737
|
| 'sofort'
|
|
4738
|
+
| 'stripe_balance'
|
|
3903
4739
|
| 'swish'
|
|
3904
4740
|
| 'twint'
|
|
3905
4741
|
| 'us_bank_account'
|
|
@@ -3985,6 +4821,16 @@ declare module 'stripe' {
|
|
|
3985
4821
|
*/
|
|
3986
4822
|
paypal?: PaymentMethodOptions.Paypal;
|
|
3987
4823
|
|
|
4824
|
+
/**
|
|
4825
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
4826
|
+
*/
|
|
4827
|
+
payto?: PaymentMethodOptions.Payto;
|
|
4828
|
+
|
|
4829
|
+
/**
|
|
4830
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
4831
|
+
*/
|
|
4832
|
+
pix?: PaymentMethodOptions.Pix;
|
|
4833
|
+
|
|
3988
4834
|
/**
|
|
3989
4835
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
3990
4836
|
*/
|
|
@@ -4432,6 +5278,150 @@ declare module 'stripe' {
|
|
|
4432
5278
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
4433
5279
|
*/
|
|
4434
5280
|
billing_agreement_id?: string;
|
|
5281
|
+
|
|
5282
|
+
currency?: string;
|
|
5283
|
+
|
|
5284
|
+
/**
|
|
5285
|
+
* 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.
|
|
5286
|
+
*/
|
|
5287
|
+
subsellers?: Array<string>;
|
|
5288
|
+
}
|
|
5289
|
+
|
|
5290
|
+
interface Payto {
|
|
5291
|
+
/**
|
|
5292
|
+
* Additional fields for Mandate creation.
|
|
5293
|
+
*/
|
|
5294
|
+
mandate_options?: Payto.MandateOptions;
|
|
5295
|
+
}
|
|
5296
|
+
|
|
5297
|
+
namespace Payto {
|
|
5298
|
+
interface MandateOptions {
|
|
5299
|
+
/**
|
|
5300
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
5301
|
+
*/
|
|
5302
|
+
amount?: number;
|
|
5303
|
+
|
|
5304
|
+
/**
|
|
5305
|
+
* 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. Defaults to `maximum`.
|
|
5306
|
+
*/
|
|
5307
|
+
amount_type?: MandateOptions.AmountType;
|
|
5308
|
+
|
|
5309
|
+
/**
|
|
5310
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
5311
|
+
*/
|
|
5312
|
+
end_date?: string;
|
|
5313
|
+
|
|
5314
|
+
/**
|
|
5315
|
+
* The periodicity at which payments will be collected. Defaults to `adhoc`.
|
|
5316
|
+
*/
|
|
5317
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
5318
|
+
|
|
5319
|
+
/**
|
|
5320
|
+
* 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.
|
|
5321
|
+
*/
|
|
5322
|
+
payments_per_period?: number;
|
|
5323
|
+
|
|
5324
|
+
/**
|
|
5325
|
+
* The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
5326
|
+
*/
|
|
5327
|
+
purpose?: MandateOptions.Purpose;
|
|
5328
|
+
|
|
5329
|
+
/**
|
|
5330
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
5331
|
+
*/
|
|
5332
|
+
start_date?: string;
|
|
5333
|
+
}
|
|
5334
|
+
|
|
5335
|
+
namespace MandateOptions {
|
|
5336
|
+
type AmountType = 'fixed' | 'maximum';
|
|
5337
|
+
|
|
5338
|
+
type PaymentSchedule =
|
|
5339
|
+
| 'adhoc'
|
|
5340
|
+
| 'annual'
|
|
5341
|
+
| 'daily'
|
|
5342
|
+
| 'fortnightly'
|
|
5343
|
+
| 'monthly'
|
|
5344
|
+
| 'quarterly'
|
|
5345
|
+
| 'semi_annual'
|
|
5346
|
+
| 'weekly';
|
|
5347
|
+
|
|
5348
|
+
type Purpose =
|
|
5349
|
+
| 'dependant_support'
|
|
5350
|
+
| 'government'
|
|
5351
|
+
| 'loan'
|
|
5352
|
+
| 'mortgage'
|
|
5353
|
+
| 'other'
|
|
5354
|
+
| 'pension'
|
|
5355
|
+
| 'personal'
|
|
5356
|
+
| 'retail'
|
|
5357
|
+
| 'salary'
|
|
5358
|
+
| 'tax'
|
|
5359
|
+
| 'utility';
|
|
5360
|
+
}
|
|
5361
|
+
}
|
|
5362
|
+
|
|
5363
|
+
interface Pix {
|
|
5364
|
+
/**
|
|
5365
|
+
* Additional fields for mandate creation.
|
|
5366
|
+
*/
|
|
5367
|
+
mandate_options?: Pix.MandateOptions;
|
|
5368
|
+
}
|
|
5369
|
+
|
|
5370
|
+
namespace Pix {
|
|
5371
|
+
interface MandateOptions {
|
|
5372
|
+
/**
|
|
5373
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
5374
|
+
*/
|
|
5375
|
+
amount?: number;
|
|
5376
|
+
|
|
5377
|
+
/**
|
|
5378
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
5379
|
+
*/
|
|
5380
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
5381
|
+
|
|
5382
|
+
/**
|
|
5383
|
+
* Type of amount. Defaults to `maximum`.
|
|
5384
|
+
*/
|
|
5385
|
+
amount_type?: MandateOptions.AmountType;
|
|
5386
|
+
|
|
5387
|
+
/**
|
|
5388
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
5389
|
+
*/
|
|
5390
|
+
currency?: string;
|
|
5391
|
+
|
|
5392
|
+
/**
|
|
5393
|
+
* 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.
|
|
5394
|
+
*/
|
|
5395
|
+
end_date?: string;
|
|
5396
|
+
|
|
5397
|
+
/**
|
|
5398
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
5399
|
+
*/
|
|
5400
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
5401
|
+
|
|
5402
|
+
/**
|
|
5403
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
5404
|
+
*/
|
|
5405
|
+
reference?: string;
|
|
5406
|
+
|
|
5407
|
+
/**
|
|
5408
|
+
* 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.
|
|
5409
|
+
*/
|
|
5410
|
+
start_date?: string;
|
|
5411
|
+
}
|
|
5412
|
+
|
|
5413
|
+
namespace MandateOptions {
|
|
5414
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
5415
|
+
|
|
5416
|
+
type AmountType = 'fixed' | 'maximum';
|
|
5417
|
+
|
|
5418
|
+
type PaymentSchedule =
|
|
5419
|
+
| 'halfyearly'
|
|
5420
|
+
| 'monthly'
|
|
5421
|
+
| 'quarterly'
|
|
5422
|
+
| 'weekly'
|
|
5423
|
+
| 'yearly';
|
|
5424
|
+
}
|
|
4435
5425
|
}
|
|
4436
5426
|
|
|
4437
5427
|
interface SepaDebit {
|
|
@@ -4479,6 +5469,11 @@ declare module 'stripe' {
|
|
|
4479
5469
|
*/
|
|
4480
5470
|
filters?: FinancialConnections.Filters;
|
|
4481
5471
|
|
|
5472
|
+
/**
|
|
5473
|
+
* Customize manual entry behavior
|
|
5474
|
+
*/
|
|
5475
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
5476
|
+
|
|
4482
5477
|
/**
|
|
4483
5478
|
* 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`.
|
|
4484
5479
|
*/
|
|
@@ -4501,19 +5496,39 @@ declare module 'stripe' {
|
|
|
4501
5496
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
4502
5497
|
*/
|
|
4503
5498
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
5499
|
+
|
|
5500
|
+
/**
|
|
5501
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
5502
|
+
*/
|
|
5503
|
+
institution?: string;
|
|
4504
5504
|
}
|
|
4505
5505
|
|
|
4506
5506
|
namespace Filters {
|
|
4507
5507
|
type AccountSubcategory = 'checking' | 'savings';
|
|
4508
5508
|
}
|
|
4509
5509
|
|
|
5510
|
+
interface ManualEntry {
|
|
5511
|
+
/**
|
|
5512
|
+
* Settings for configuring manual entry of account details.
|
|
5513
|
+
*/
|
|
5514
|
+
mode: ManualEntry.Mode;
|
|
5515
|
+
}
|
|
5516
|
+
|
|
5517
|
+
namespace ManualEntry {
|
|
5518
|
+
type Mode = 'automatic' | 'custom';
|
|
5519
|
+
}
|
|
5520
|
+
|
|
4510
5521
|
type Permission =
|
|
4511
5522
|
| 'balances'
|
|
4512
5523
|
| 'ownership'
|
|
4513
5524
|
| 'payment_method'
|
|
4514
5525
|
| 'transactions';
|
|
4515
5526
|
|
|
4516
|
-
type Prefetch =
|
|
5527
|
+
type Prefetch =
|
|
5528
|
+
| 'balances'
|
|
5529
|
+
| 'inferred_balances'
|
|
5530
|
+
| 'ownership'
|
|
5531
|
+
| 'transactions';
|
|
4517
5532
|
}
|
|
4518
5533
|
|
|
4519
5534
|
interface MandateOptions {
|
|
@@ -4537,6 +5552,31 @@ declare module 'stripe' {
|
|
|
4537
5552
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
4538
5553
|
}
|
|
4539
5554
|
}
|
|
5555
|
+
|
|
5556
|
+
interface SetupDetails {
|
|
5557
|
+
/**
|
|
5558
|
+
* Benefit details for this SetupIntent
|
|
5559
|
+
*/
|
|
5560
|
+
benefit?: SetupDetails.Benefit;
|
|
5561
|
+
}
|
|
5562
|
+
|
|
5563
|
+
namespace SetupDetails {
|
|
5564
|
+
interface Benefit {
|
|
5565
|
+
/**
|
|
5566
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
5567
|
+
*/
|
|
5568
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
5569
|
+
}
|
|
5570
|
+
|
|
5571
|
+
namespace Benefit {
|
|
5572
|
+
interface FrMealVoucher {
|
|
5573
|
+
/**
|
|
5574
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
5575
|
+
*/
|
|
5576
|
+
siret: string;
|
|
5577
|
+
}
|
|
5578
|
+
}
|
|
5579
|
+
}
|
|
4540
5580
|
}
|
|
4541
5581
|
|
|
4542
5582
|
interface SetupIntentVerifyMicrodepositsParams {
|