stripe 18.5.0 → 18.6.0-alpha.1
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 +1413 -11
- package/OPENAPI_VERSION +1 -1
- package/README.md +1 -0
- package/VERSION +1 -1
- package/cjs/Error.js +115 -1
- package/cjs/RequestSender.js +7 -4
- package/cjs/apiVersion.js +2 -3
- package/cjs/resources/AccountNotices.js +21 -0
- package/cjs/resources/BalanceSettings.js +10 -0
- package/cjs/resources/Billing/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/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/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/PaymentAttemptRecords.js +17 -0
- package/cjs/resources/PaymentIntents.js +13 -0
- package/cjs/resources/PaymentRecords.js +29 -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.js +17 -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 +16 -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 +12 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +28 -0
- package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +24 -0
- package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
- package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +25 -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/TransactionEntries.js +17 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +25 -0
- package/cjs/resources/V2/Reporting/ReportRuns.js +13 -0
- package/cjs/resources/V2/Reporting/Reports.js +12 -0
- package/cjs/resources/V2/Tax/AutomaticRules.js +22 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
- package/cjs/resources.js +142 -8
- package/cjs/stripe.core.js +27 -1
- package/esm/Error.js +100 -0
- package/esm/RequestSender.js +7 -4
- package/esm/apiVersion.js +1 -2
- package/esm/resources/AccountNotices.js +18 -0
- package/esm/resources/BalanceSettings.js +7 -0
- package/esm/resources/Billing/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/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/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/PaymentAttemptRecords.js +14 -0
- package/esm/resources/PaymentIntents.js +13 -0
- package/esm/resources/PaymentRecords.js +26 -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.js +14 -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 +13 -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 +9 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +25 -0
- package/esm/resources/V2/Core/Vault/UsBankAccounts.js +21 -0
- package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
- package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +22 -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/TransactionEntries.js +14 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +22 -0
- package/esm/resources/V2/Reporting/ReportRuns.js +10 -0
- package/esm/resources/V2/Reporting/Reports.js +9 -0
- package/esm/resources/V2/Tax/AutomaticRules.js +19 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
- package/esm/resources.js +126 -0
- package/esm/stripe.core.js +27 -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 +212 -1
- package/types/AccountsResource.d.ts +544 -0
- package/types/BalanceSettings.d.ts +97 -0
- package/types/BalanceSettingsResource.d.ts +119 -0
- package/types/Billing/AlertTriggereds.d.ts +16 -1
- package/types/Billing/Alerts.d.ts +116 -1
- package/types/Billing/AlertsResource.d.ts +93 -2
- 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 +43 -2
- package/types/Billing/MeterUsage.d.ts +32 -0
- package/types/Billing/MeterUsageResource.d.ts +685 -0
- package/types/Billing/MeterUsageRows.d.ts +49 -0
- package/types/BillingPortal/Sessions.d.ts +5 -0
- package/types/BillingPortal/SessionsResource.d.ts +12 -4
- 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 +5 -0
- package/types/CashBalances.d.ts +5 -0
- package/types/Charges.d.ts +171 -10
- package/types/ChargesResource.d.ts +1406 -0
- package/types/Checkout/Sessions.d.ts +432 -2
- package/types/Checkout/SessionsResource.d.ts +570 -2
- package/types/ConfirmationTokens.d.ts +125 -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 +5 -0
- package/types/CustomerSessionsResource.d.ts +6 -1
- package/types/Customers.d.ts +2 -0
- package/types/CustomersResource.d.ts +8 -0
- package/types/Discounts.d.ts +10 -0
- package/types/Disputes.d.ts +29 -0
- package/types/Errors.d.ts +85 -0
- package/types/EventTypes.d.ts +664 -0
- package/types/Events.d.ts +97 -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/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 +5 -0
- package/types/InvoicePaymentsResource.d.ts +10 -1
- package/types/Invoices.d.ts +187 -4
- package/types/InvoicesResource.d.ts +1535 -19
- package/types/Issuing/CardholdersResource.d.ts +2 -1
- package/types/Issuing/CardsResource.d.ts +0 -10
- 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 +2311 -0
- package/types/PaymentAttemptRecordsResource.d.ts +52 -0
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +116 -0
- package/types/PaymentIntents.d.ts +836 -3
- package/types/PaymentIntentsResource.d.ts +11610 -5775
- package/types/PaymentLinks.d.ts +6 -0
- package/types/PaymentLinksResource.d.ts +12 -0
- package/types/PaymentMethodConfigurations.d.ts +180 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +250 -0
- package/types/PaymentMethods.d.ts +130 -0
- package/types/PaymentMethodsResource.d.ts +167 -2
- package/types/PaymentRecords.d.ts +2304 -0
- package/types/PaymentRecordsResource.d.ts +476 -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 +1751 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +892 -0
- package/types/Quotes.d.ts +594 -1
- package/types/QuotesResource.d.ts +2577 -232
- package/types/Refunds.d.ts +14 -0
- package/types/SetupAttempts.d.ts +51 -1
- package/types/SetupIntents.d.ts +210 -2
- package/types/SetupIntentsResource.d.ts +938 -4
- package/types/Sources.d.ts +29 -0
- package/types/SubscriptionItems.d.ts +21 -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 +140 -1
- package/types/SubscriptionsResource.d.ts +498 -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 +5 -0
- package/types/TransfersResource.d.ts +5 -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 +354 -0
- package/types/V2/Billing/CadencesResource.d.ts +489 -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 +458 -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 +574 -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 +163 -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/PricingPlanSubscriptions.d.ts +134 -0
- package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +93 -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 +138 -0
- package/types/V2/Billing/RateCardSubscriptions.d.ts +134 -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 +209 -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 +240 -0
- package/types/V2/Billing/ServiceActionsResource.d.ts +302 -0
- package/types/V2/Core/AccountLinks.d.ts +168 -0
- package/types/V2/Core/AccountLinksResource.d.ts +152 -0
- package/types/V2/Core/Accounts/PersonsResource.d.ts +3812 -0
- package/types/V2/Core/Accounts.d.ts +8862 -0
- package/types/V2/Core/AccountsResource.d.ts +10704 -0
- package/types/V2/Core/ClaimableSandboxes.d.ts +349 -0
- package/types/V2/Core/ClaimableSandboxesResource.d.ts +310 -0
- package/types/V2/Core/Persons.d.ts +1888 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +172 -0
- package/types/V2/Core/Vault/UsBankAccounts.d.ts +70 -0
- package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +123 -0
- package/types/V2/EventTypes.d.ts +4015 -5
- package/types/V2/Events.d.ts +7 -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 +585 -0
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +331 -0
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +314 -0
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +289 -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 +168 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +278 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +242 -0
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +296 -0
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +251 -0
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +208 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +160 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +87 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +262 -0
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +176 -0
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -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 +179 -0
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +174 -0
- package/types/V2/Reporting/ReportRuns.d.ts +178 -0
- package/types/V2/Reporting/ReportRunsResource.d.ts +99 -0
- package/types/V2/Reporting/Reports.d.ts +120 -0
- package/types/V2/Reporting/ReportsResource.d.ts +30 -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 +68 -0
- package/types/WebhookEndpointsResource.d.ts +78 -0
- package/types/Webhooks.d.ts +2 -0
- package/types/index.d.ts +265 -0
- package/types/lib.d.ts +11 -1
- package/types/test/typescriptTest.ts +3 -3
|
@@ -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
|
*/
|
|
@@ -286,11 +293,21 @@ declare module 'stripe' {
|
|
|
286
293
|
*/
|
|
287
294
|
giropay?: PaymentMethodData.Giropay;
|
|
288
295
|
|
|
296
|
+
/**
|
|
297
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
298
|
+
*/
|
|
299
|
+
gopay?: PaymentMethodData.Gopay;
|
|
300
|
+
|
|
289
301
|
/**
|
|
290
302
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
291
303
|
*/
|
|
292
304
|
grabpay?: PaymentMethodData.Grabpay;
|
|
293
305
|
|
|
306
|
+
/**
|
|
307
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
308
|
+
*/
|
|
309
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
310
|
+
|
|
294
311
|
/**
|
|
295
312
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
296
313
|
*/
|
|
@@ -326,6 +343,11 @@ declare module 'stripe' {
|
|
|
326
343
|
*/
|
|
327
344
|
link?: PaymentMethodData.Link;
|
|
328
345
|
|
|
346
|
+
/**
|
|
347
|
+
* If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
|
|
348
|
+
*/
|
|
349
|
+
mb_way?: PaymentMethodData.MbWay;
|
|
350
|
+
|
|
329
351
|
/**
|
|
330
352
|
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
331
353
|
*/
|
|
@@ -381,6 +403,11 @@ declare module 'stripe' {
|
|
|
381
403
|
*/
|
|
382
404
|
paypal?: PaymentMethodData.Paypal;
|
|
383
405
|
|
|
406
|
+
/**
|
|
407
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
408
|
+
*/
|
|
409
|
+
payto?: PaymentMethodData.Payto;
|
|
410
|
+
|
|
384
411
|
/**
|
|
385
412
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
386
413
|
*/
|
|
@@ -391,11 +418,21 @@ declare module 'stripe' {
|
|
|
391
418
|
*/
|
|
392
419
|
promptpay?: PaymentMethodData.Promptpay;
|
|
393
420
|
|
|
421
|
+
/**
|
|
422
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
423
|
+
*/
|
|
424
|
+
qris?: PaymentMethodData.Qris;
|
|
425
|
+
|
|
394
426
|
/**
|
|
395
427
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
396
428
|
*/
|
|
397
429
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
398
430
|
|
|
431
|
+
/**
|
|
432
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
433
|
+
*/
|
|
434
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
435
|
+
|
|
399
436
|
/**
|
|
400
437
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
401
438
|
*/
|
|
@@ -416,11 +453,21 @@ declare module 'stripe' {
|
|
|
416
453
|
*/
|
|
417
454
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
418
455
|
|
|
456
|
+
/**
|
|
457
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
458
|
+
*/
|
|
459
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
460
|
+
|
|
419
461
|
/**
|
|
420
462
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
421
463
|
*/
|
|
422
464
|
sofort?: PaymentMethodData.Sofort;
|
|
423
465
|
|
|
466
|
+
/**
|
|
467
|
+
* This hash contains details about the Stripe balance payment method.
|
|
468
|
+
*/
|
|
469
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
470
|
+
|
|
424
471
|
/**
|
|
425
472
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
426
473
|
*/
|
|
@@ -633,8 +680,21 @@ declare module 'stripe' {
|
|
|
633
680
|
|
|
634
681
|
interface Giropay {}
|
|
635
682
|
|
|
683
|
+
interface Gopay {}
|
|
684
|
+
|
|
636
685
|
interface Grabpay {}
|
|
637
686
|
|
|
687
|
+
interface IdBankTransfer {
|
|
688
|
+
/**
|
|
689
|
+
* Bank where the account is held.
|
|
690
|
+
*/
|
|
691
|
+
bank?: IdBankTransfer.Bank;
|
|
692
|
+
}
|
|
693
|
+
|
|
694
|
+
namespace IdBankTransfer {
|
|
695
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
696
|
+
}
|
|
697
|
+
|
|
638
698
|
interface Ideal {
|
|
639
699
|
/**
|
|
640
700
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -699,6 +759,8 @@ declare module 'stripe' {
|
|
|
699
759
|
|
|
700
760
|
interface Link {}
|
|
701
761
|
|
|
762
|
+
interface MbWay {}
|
|
763
|
+
|
|
702
764
|
interface Mobilepay {}
|
|
703
765
|
|
|
704
766
|
interface Multibanco {}
|
|
@@ -790,10 +852,29 @@ declare module 'stripe' {
|
|
|
790
852
|
|
|
791
853
|
interface Paypal {}
|
|
792
854
|
|
|
855
|
+
interface Payto {
|
|
856
|
+
/**
|
|
857
|
+
* The account number for the bank account.
|
|
858
|
+
*/
|
|
859
|
+
account_number?: string;
|
|
860
|
+
|
|
861
|
+
/**
|
|
862
|
+
* Bank-State-Branch number of the bank account.
|
|
863
|
+
*/
|
|
864
|
+
bsb_number?: string;
|
|
865
|
+
|
|
866
|
+
/**
|
|
867
|
+
* The PayID alias for the bank account.
|
|
868
|
+
*/
|
|
869
|
+
pay_id?: string;
|
|
870
|
+
}
|
|
871
|
+
|
|
793
872
|
interface Pix {}
|
|
794
873
|
|
|
795
874
|
interface Promptpay {}
|
|
796
875
|
|
|
876
|
+
interface Qris {}
|
|
877
|
+
|
|
797
878
|
interface RadarOptions {
|
|
798
879
|
/**
|
|
799
880
|
* 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.
|
|
@@ -801,6 +882,32 @@ declare module 'stripe' {
|
|
|
801
882
|
session?: string;
|
|
802
883
|
}
|
|
803
884
|
|
|
885
|
+
interface Rechnung {
|
|
886
|
+
/**
|
|
887
|
+
* Customer's date of birth
|
|
888
|
+
*/
|
|
889
|
+
dob: Rechnung.Dob;
|
|
890
|
+
}
|
|
891
|
+
|
|
892
|
+
namespace Rechnung {
|
|
893
|
+
interface Dob {
|
|
894
|
+
/**
|
|
895
|
+
* The day of birth, between 1 and 31.
|
|
896
|
+
*/
|
|
897
|
+
day: number;
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* The month of birth, between 1 and 12.
|
|
901
|
+
*/
|
|
902
|
+
month: number;
|
|
903
|
+
|
|
904
|
+
/**
|
|
905
|
+
* The four-digit year of birth.
|
|
906
|
+
*/
|
|
907
|
+
year: number;
|
|
908
|
+
}
|
|
909
|
+
}
|
|
910
|
+
|
|
804
911
|
interface RevolutPay {}
|
|
805
912
|
|
|
806
913
|
interface SamsungPay {}
|
|
@@ -814,6 +921,8 @@ declare module 'stripe' {
|
|
|
814
921
|
iban: string;
|
|
815
922
|
}
|
|
816
923
|
|
|
924
|
+
interface Shopeepay {}
|
|
925
|
+
|
|
817
926
|
interface Sofort {
|
|
818
927
|
/**
|
|
819
928
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -825,6 +934,22 @@ declare module 'stripe' {
|
|
|
825
934
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
826
935
|
}
|
|
827
936
|
|
|
937
|
+
interface StripeBalance {
|
|
938
|
+
/**
|
|
939
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
940
|
+
*/
|
|
941
|
+
account?: string;
|
|
942
|
+
|
|
943
|
+
/**
|
|
944
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
945
|
+
*/
|
|
946
|
+
source_type?: StripeBalance.SourceType;
|
|
947
|
+
}
|
|
948
|
+
|
|
949
|
+
namespace StripeBalance {
|
|
950
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
951
|
+
}
|
|
952
|
+
|
|
828
953
|
interface Swish {}
|
|
829
954
|
|
|
830
955
|
interface Twint {}
|
|
@@ -848,13 +973,16 @@ declare module 'stripe' {
|
|
|
848
973
|
| 'eps'
|
|
849
974
|
| 'fpx'
|
|
850
975
|
| 'giropay'
|
|
976
|
+
| 'gopay'
|
|
851
977
|
| 'grabpay'
|
|
978
|
+
| 'id_bank_transfer'
|
|
852
979
|
| 'ideal'
|
|
853
980
|
| 'kakao_pay'
|
|
854
981
|
| 'klarna'
|
|
855
982
|
| 'konbini'
|
|
856
983
|
| 'kr_card'
|
|
857
984
|
| 'link'
|
|
985
|
+
| 'mb_way'
|
|
858
986
|
| 'mobilepay'
|
|
859
987
|
| 'multibanco'
|
|
860
988
|
| 'naver_pay'
|
|
@@ -865,13 +993,18 @@ declare module 'stripe' {
|
|
|
865
993
|
| 'payco'
|
|
866
994
|
| 'paynow'
|
|
867
995
|
| 'paypal'
|
|
996
|
+
| 'payto'
|
|
868
997
|
| 'pix'
|
|
869
998
|
| 'promptpay'
|
|
999
|
+
| 'qris'
|
|
1000
|
+
| 'rechnung'
|
|
870
1001
|
| 'revolut_pay'
|
|
871
1002
|
| 'samsung_pay'
|
|
872
1003
|
| 'satispay'
|
|
873
1004
|
| 'sepa_debit'
|
|
1005
|
+
| 'shopeepay'
|
|
874
1006
|
| 'sofort'
|
|
1007
|
+
| 'stripe_balance'
|
|
875
1008
|
| 'swish'
|
|
876
1009
|
| 'twint'
|
|
877
1010
|
| 'us_bank_account'
|
|
@@ -957,6 +1090,16 @@ declare module 'stripe' {
|
|
|
957
1090
|
*/
|
|
958
1091
|
paypal?: PaymentMethodOptions.Paypal;
|
|
959
1092
|
|
|
1093
|
+
/**
|
|
1094
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
1095
|
+
*/
|
|
1096
|
+
payto?: PaymentMethodOptions.Payto;
|
|
1097
|
+
|
|
1098
|
+
/**
|
|
1099
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
1100
|
+
*/
|
|
1101
|
+
pix?: PaymentMethodOptions.Pix;
|
|
1102
|
+
|
|
960
1103
|
/**
|
|
961
1104
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
962
1105
|
*/
|
|
@@ -1404,6 +1547,150 @@ declare module 'stripe' {
|
|
|
1404
1547
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
1405
1548
|
*/
|
|
1406
1549
|
billing_agreement_id?: string;
|
|
1550
|
+
|
|
1551
|
+
currency?: string;
|
|
1552
|
+
|
|
1553
|
+
/**
|
|
1554
|
+
* 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.
|
|
1555
|
+
*/
|
|
1556
|
+
subsellers?: Array<string>;
|
|
1557
|
+
}
|
|
1558
|
+
|
|
1559
|
+
interface Payto {
|
|
1560
|
+
/**
|
|
1561
|
+
* Additional fields for Mandate creation.
|
|
1562
|
+
*/
|
|
1563
|
+
mandate_options?: Payto.MandateOptions;
|
|
1564
|
+
}
|
|
1565
|
+
|
|
1566
|
+
namespace Payto {
|
|
1567
|
+
interface MandateOptions {
|
|
1568
|
+
/**
|
|
1569
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
1570
|
+
*/
|
|
1571
|
+
amount?: number;
|
|
1572
|
+
|
|
1573
|
+
/**
|
|
1574
|
+
* 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.
|
|
1575
|
+
*/
|
|
1576
|
+
amount_type?: MandateOptions.AmountType;
|
|
1577
|
+
|
|
1578
|
+
/**
|
|
1579
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
1580
|
+
*/
|
|
1581
|
+
end_date?: string;
|
|
1582
|
+
|
|
1583
|
+
/**
|
|
1584
|
+
* The periodicity at which payments will be collected.
|
|
1585
|
+
*/
|
|
1586
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1587
|
+
|
|
1588
|
+
/**
|
|
1589
|
+
* 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.
|
|
1590
|
+
*/
|
|
1591
|
+
payments_per_period?: number;
|
|
1592
|
+
|
|
1593
|
+
/**
|
|
1594
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
1595
|
+
*/
|
|
1596
|
+
purpose?: MandateOptions.Purpose;
|
|
1597
|
+
|
|
1598
|
+
/**
|
|
1599
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
1600
|
+
*/
|
|
1601
|
+
start_date?: string;
|
|
1602
|
+
}
|
|
1603
|
+
|
|
1604
|
+
namespace MandateOptions {
|
|
1605
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1606
|
+
|
|
1607
|
+
type PaymentSchedule =
|
|
1608
|
+
| 'adhoc'
|
|
1609
|
+
| 'annual'
|
|
1610
|
+
| 'daily'
|
|
1611
|
+
| 'fortnightly'
|
|
1612
|
+
| 'monthly'
|
|
1613
|
+
| 'quarterly'
|
|
1614
|
+
| 'semi_annual'
|
|
1615
|
+
| 'weekly';
|
|
1616
|
+
|
|
1617
|
+
type Purpose =
|
|
1618
|
+
| 'dependant_support'
|
|
1619
|
+
| 'government'
|
|
1620
|
+
| 'loan'
|
|
1621
|
+
| 'mortgage'
|
|
1622
|
+
| 'other'
|
|
1623
|
+
| 'pension'
|
|
1624
|
+
| 'personal'
|
|
1625
|
+
| 'retail'
|
|
1626
|
+
| 'salary'
|
|
1627
|
+
| 'tax'
|
|
1628
|
+
| 'utility';
|
|
1629
|
+
}
|
|
1630
|
+
}
|
|
1631
|
+
|
|
1632
|
+
interface Pix {
|
|
1633
|
+
/**
|
|
1634
|
+
* Additional fields for mandate creation.
|
|
1635
|
+
*/
|
|
1636
|
+
mandate_options?: Pix.MandateOptions;
|
|
1637
|
+
}
|
|
1638
|
+
|
|
1639
|
+
namespace Pix {
|
|
1640
|
+
interface MandateOptions {
|
|
1641
|
+
/**
|
|
1642
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
1643
|
+
*/
|
|
1644
|
+
amount?: number;
|
|
1645
|
+
|
|
1646
|
+
/**
|
|
1647
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
1648
|
+
*/
|
|
1649
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
1650
|
+
|
|
1651
|
+
/**
|
|
1652
|
+
* Type of amount. Defaults to `maximum`.
|
|
1653
|
+
*/
|
|
1654
|
+
amount_type?: MandateOptions.AmountType;
|
|
1655
|
+
|
|
1656
|
+
/**
|
|
1657
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
1658
|
+
*/
|
|
1659
|
+
currency?: string;
|
|
1660
|
+
|
|
1661
|
+
/**
|
|
1662
|
+
* 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.
|
|
1663
|
+
*/
|
|
1664
|
+
end_date?: string;
|
|
1665
|
+
|
|
1666
|
+
/**
|
|
1667
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
1668
|
+
*/
|
|
1669
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1670
|
+
|
|
1671
|
+
/**
|
|
1672
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
1673
|
+
*/
|
|
1674
|
+
reference?: string;
|
|
1675
|
+
|
|
1676
|
+
/**
|
|
1677
|
+
* 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.
|
|
1678
|
+
*/
|
|
1679
|
+
start_date?: string;
|
|
1680
|
+
}
|
|
1681
|
+
|
|
1682
|
+
namespace MandateOptions {
|
|
1683
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
1684
|
+
|
|
1685
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1686
|
+
|
|
1687
|
+
type PaymentSchedule =
|
|
1688
|
+
| 'halfyearly'
|
|
1689
|
+
| 'monthly'
|
|
1690
|
+
| 'quarterly'
|
|
1691
|
+
| 'weekly'
|
|
1692
|
+
| 'yearly';
|
|
1693
|
+
}
|
|
1407
1694
|
}
|
|
1408
1695
|
|
|
1409
1696
|
interface SepaDebit {
|
|
@@ -1451,6 +1738,11 @@ declare module 'stripe' {
|
|
|
1451
1738
|
*/
|
|
1452
1739
|
filters?: FinancialConnections.Filters;
|
|
1453
1740
|
|
|
1741
|
+
/**
|
|
1742
|
+
* Customize manual entry behavior
|
|
1743
|
+
*/
|
|
1744
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
1745
|
+
|
|
1454
1746
|
/**
|
|
1455
1747
|
* 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`.
|
|
1456
1748
|
*/
|
|
@@ -1473,19 +1765,39 @@ declare module 'stripe' {
|
|
|
1473
1765
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1474
1766
|
*/
|
|
1475
1767
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1768
|
+
|
|
1769
|
+
/**
|
|
1770
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
1771
|
+
*/
|
|
1772
|
+
institution?: string;
|
|
1476
1773
|
}
|
|
1477
1774
|
|
|
1478
1775
|
namespace Filters {
|
|
1479
1776
|
type AccountSubcategory = 'checking' | 'savings';
|
|
1480
1777
|
}
|
|
1481
1778
|
|
|
1779
|
+
interface ManualEntry {
|
|
1780
|
+
/**
|
|
1781
|
+
* Settings for configuring manual entry of account details.
|
|
1782
|
+
*/
|
|
1783
|
+
mode: ManualEntry.Mode;
|
|
1784
|
+
}
|
|
1785
|
+
|
|
1786
|
+
namespace ManualEntry {
|
|
1787
|
+
type Mode = 'automatic' | 'custom';
|
|
1788
|
+
}
|
|
1789
|
+
|
|
1482
1790
|
type Permission =
|
|
1483
1791
|
| 'balances'
|
|
1484
1792
|
| 'ownership'
|
|
1485
1793
|
| 'payment_method'
|
|
1486
1794
|
| 'transactions';
|
|
1487
1795
|
|
|
1488
|
-
type Prefetch =
|
|
1796
|
+
type Prefetch =
|
|
1797
|
+
| 'balances'
|
|
1798
|
+
| 'inferred_balances'
|
|
1799
|
+
| 'ownership'
|
|
1800
|
+
| 'transactions';
|
|
1489
1801
|
}
|
|
1490
1802
|
|
|
1491
1803
|
interface MandateOptions {
|
|
@@ -1552,6 +1864,13 @@ declare module 'stripe' {
|
|
|
1552
1864
|
*/
|
|
1553
1865
|
customer?: string;
|
|
1554
1866
|
|
|
1867
|
+
/**
|
|
1868
|
+
* ID of the Account this SetupIntent belongs to, if one exists.
|
|
1869
|
+
*
|
|
1870
|
+
* 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.
|
|
1871
|
+
*/
|
|
1872
|
+
customer_account?: string;
|
|
1873
|
+
|
|
1555
1874
|
/**
|
|
1556
1875
|
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1557
1876
|
*/
|
|
@@ -1705,11 +2024,21 @@ declare module 'stripe' {
|
|
|
1705
2024
|
*/
|
|
1706
2025
|
giropay?: PaymentMethodData.Giropay;
|
|
1707
2026
|
|
|
2027
|
+
/**
|
|
2028
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
2029
|
+
*/
|
|
2030
|
+
gopay?: PaymentMethodData.Gopay;
|
|
2031
|
+
|
|
1708
2032
|
/**
|
|
1709
2033
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
1710
2034
|
*/
|
|
1711
2035
|
grabpay?: PaymentMethodData.Grabpay;
|
|
1712
2036
|
|
|
2037
|
+
/**
|
|
2038
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
2039
|
+
*/
|
|
2040
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
2041
|
+
|
|
1713
2042
|
/**
|
|
1714
2043
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
1715
2044
|
*/
|
|
@@ -1745,6 +2074,11 @@ declare module 'stripe' {
|
|
|
1745
2074
|
*/
|
|
1746
2075
|
link?: PaymentMethodData.Link;
|
|
1747
2076
|
|
|
2077
|
+
/**
|
|
2078
|
+
* If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
|
|
2079
|
+
*/
|
|
2080
|
+
mb_way?: PaymentMethodData.MbWay;
|
|
2081
|
+
|
|
1748
2082
|
/**
|
|
1749
2083
|
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
1750
2084
|
*/
|
|
@@ -1800,6 +2134,11 @@ declare module 'stripe' {
|
|
|
1800
2134
|
*/
|
|
1801
2135
|
paypal?: PaymentMethodData.Paypal;
|
|
1802
2136
|
|
|
2137
|
+
/**
|
|
2138
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
2139
|
+
*/
|
|
2140
|
+
payto?: PaymentMethodData.Payto;
|
|
2141
|
+
|
|
1803
2142
|
/**
|
|
1804
2143
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
1805
2144
|
*/
|
|
@@ -1810,11 +2149,21 @@ declare module 'stripe' {
|
|
|
1810
2149
|
*/
|
|
1811
2150
|
promptpay?: PaymentMethodData.Promptpay;
|
|
1812
2151
|
|
|
2152
|
+
/**
|
|
2153
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
2154
|
+
*/
|
|
2155
|
+
qris?: PaymentMethodData.Qris;
|
|
2156
|
+
|
|
1813
2157
|
/**
|
|
1814
2158
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
1815
2159
|
*/
|
|
1816
2160
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
1817
2161
|
|
|
2162
|
+
/**
|
|
2163
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
2164
|
+
*/
|
|
2165
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
2166
|
+
|
|
1818
2167
|
/**
|
|
1819
2168
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
1820
2169
|
*/
|
|
@@ -1835,11 +2184,21 @@ declare module 'stripe' {
|
|
|
1835
2184
|
*/
|
|
1836
2185
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
1837
2186
|
|
|
2187
|
+
/**
|
|
2188
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
2189
|
+
*/
|
|
2190
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
2191
|
+
|
|
1838
2192
|
/**
|
|
1839
2193
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
1840
2194
|
*/
|
|
1841
2195
|
sofort?: PaymentMethodData.Sofort;
|
|
1842
2196
|
|
|
2197
|
+
/**
|
|
2198
|
+
* This hash contains details about the Stripe balance payment method.
|
|
2199
|
+
*/
|
|
2200
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
2201
|
+
|
|
1843
2202
|
/**
|
|
1844
2203
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
1845
2204
|
*/
|
|
@@ -2052,8 +2411,21 @@ declare module 'stripe' {
|
|
|
2052
2411
|
|
|
2053
2412
|
interface Giropay {}
|
|
2054
2413
|
|
|
2414
|
+
interface Gopay {}
|
|
2415
|
+
|
|
2055
2416
|
interface Grabpay {}
|
|
2056
2417
|
|
|
2418
|
+
interface IdBankTransfer {
|
|
2419
|
+
/**
|
|
2420
|
+
* Bank where the account is held.
|
|
2421
|
+
*/
|
|
2422
|
+
bank?: IdBankTransfer.Bank;
|
|
2423
|
+
}
|
|
2424
|
+
|
|
2425
|
+
namespace IdBankTransfer {
|
|
2426
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
2427
|
+
}
|
|
2428
|
+
|
|
2057
2429
|
interface Ideal {
|
|
2058
2430
|
/**
|
|
2059
2431
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -2118,6 +2490,8 @@ declare module 'stripe' {
|
|
|
2118
2490
|
|
|
2119
2491
|
interface Link {}
|
|
2120
2492
|
|
|
2493
|
+
interface MbWay {}
|
|
2494
|
+
|
|
2121
2495
|
interface Mobilepay {}
|
|
2122
2496
|
|
|
2123
2497
|
interface Multibanco {}
|
|
@@ -2209,10 +2583,29 @@ declare module 'stripe' {
|
|
|
2209
2583
|
|
|
2210
2584
|
interface Paypal {}
|
|
2211
2585
|
|
|
2586
|
+
interface Payto {
|
|
2587
|
+
/**
|
|
2588
|
+
* The account number for the bank account.
|
|
2589
|
+
*/
|
|
2590
|
+
account_number?: string;
|
|
2591
|
+
|
|
2592
|
+
/**
|
|
2593
|
+
* Bank-State-Branch number of the bank account.
|
|
2594
|
+
*/
|
|
2595
|
+
bsb_number?: string;
|
|
2596
|
+
|
|
2597
|
+
/**
|
|
2598
|
+
* The PayID alias for the bank account.
|
|
2599
|
+
*/
|
|
2600
|
+
pay_id?: string;
|
|
2601
|
+
}
|
|
2602
|
+
|
|
2212
2603
|
interface Pix {}
|
|
2213
2604
|
|
|
2214
2605
|
interface Promptpay {}
|
|
2215
2606
|
|
|
2607
|
+
interface Qris {}
|
|
2608
|
+
|
|
2216
2609
|
interface RadarOptions {
|
|
2217
2610
|
/**
|
|
2218
2611
|
* 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.
|
|
@@ -2220,6 +2613,32 @@ declare module 'stripe' {
|
|
|
2220
2613
|
session?: string;
|
|
2221
2614
|
}
|
|
2222
2615
|
|
|
2616
|
+
interface Rechnung {
|
|
2617
|
+
/**
|
|
2618
|
+
* Customer's date of birth
|
|
2619
|
+
*/
|
|
2620
|
+
dob: Rechnung.Dob;
|
|
2621
|
+
}
|
|
2622
|
+
|
|
2623
|
+
namespace Rechnung {
|
|
2624
|
+
interface Dob {
|
|
2625
|
+
/**
|
|
2626
|
+
* The day of birth, between 1 and 31.
|
|
2627
|
+
*/
|
|
2628
|
+
day: number;
|
|
2629
|
+
|
|
2630
|
+
/**
|
|
2631
|
+
* The month of birth, between 1 and 12.
|
|
2632
|
+
*/
|
|
2633
|
+
month: number;
|
|
2634
|
+
|
|
2635
|
+
/**
|
|
2636
|
+
* The four-digit year of birth.
|
|
2637
|
+
*/
|
|
2638
|
+
year: number;
|
|
2639
|
+
}
|
|
2640
|
+
}
|
|
2641
|
+
|
|
2223
2642
|
interface RevolutPay {}
|
|
2224
2643
|
|
|
2225
2644
|
interface SamsungPay {}
|
|
@@ -2233,6 +2652,8 @@ declare module 'stripe' {
|
|
|
2233
2652
|
iban: string;
|
|
2234
2653
|
}
|
|
2235
2654
|
|
|
2655
|
+
interface Shopeepay {}
|
|
2656
|
+
|
|
2236
2657
|
interface Sofort {
|
|
2237
2658
|
/**
|
|
2238
2659
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -2244,7 +2665,23 @@ declare module 'stripe' {
|
|
|
2244
2665
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
2245
2666
|
}
|
|
2246
2667
|
|
|
2247
|
-
interface
|
|
2668
|
+
interface StripeBalance {
|
|
2669
|
+
/**
|
|
2670
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
2671
|
+
*/
|
|
2672
|
+
account?: string;
|
|
2673
|
+
|
|
2674
|
+
/**
|
|
2675
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
2676
|
+
*/
|
|
2677
|
+
source_type?: StripeBalance.SourceType;
|
|
2678
|
+
}
|
|
2679
|
+
|
|
2680
|
+
namespace StripeBalance {
|
|
2681
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
2682
|
+
}
|
|
2683
|
+
|
|
2684
|
+
interface Swish {}
|
|
2248
2685
|
|
|
2249
2686
|
interface Twint {}
|
|
2250
2687
|
|
|
@@ -2267,13 +2704,16 @@ declare module 'stripe' {
|
|
|
2267
2704
|
| 'eps'
|
|
2268
2705
|
| 'fpx'
|
|
2269
2706
|
| 'giropay'
|
|
2707
|
+
| 'gopay'
|
|
2270
2708
|
| 'grabpay'
|
|
2709
|
+
| 'id_bank_transfer'
|
|
2271
2710
|
| 'ideal'
|
|
2272
2711
|
| 'kakao_pay'
|
|
2273
2712
|
| 'klarna'
|
|
2274
2713
|
| 'konbini'
|
|
2275
2714
|
| 'kr_card'
|
|
2276
2715
|
| 'link'
|
|
2716
|
+
| 'mb_way'
|
|
2277
2717
|
| 'mobilepay'
|
|
2278
2718
|
| 'multibanco'
|
|
2279
2719
|
| 'naver_pay'
|
|
@@ -2284,13 +2724,18 @@ declare module 'stripe' {
|
|
|
2284
2724
|
| 'payco'
|
|
2285
2725
|
| 'paynow'
|
|
2286
2726
|
| 'paypal'
|
|
2727
|
+
| 'payto'
|
|
2287
2728
|
| 'pix'
|
|
2288
2729
|
| 'promptpay'
|
|
2730
|
+
| 'qris'
|
|
2731
|
+
| 'rechnung'
|
|
2289
2732
|
| 'revolut_pay'
|
|
2290
2733
|
| 'samsung_pay'
|
|
2291
2734
|
| 'satispay'
|
|
2292
2735
|
| 'sepa_debit'
|
|
2736
|
+
| 'shopeepay'
|
|
2293
2737
|
| 'sofort'
|
|
2738
|
+
| 'stripe_balance'
|
|
2294
2739
|
| 'swish'
|
|
2295
2740
|
| 'twint'
|
|
2296
2741
|
| 'us_bank_account'
|
|
@@ -2376,6 +2821,16 @@ declare module 'stripe' {
|
|
|
2376
2821
|
*/
|
|
2377
2822
|
paypal?: PaymentMethodOptions.Paypal;
|
|
2378
2823
|
|
|
2824
|
+
/**
|
|
2825
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
2826
|
+
*/
|
|
2827
|
+
payto?: PaymentMethodOptions.Payto;
|
|
2828
|
+
|
|
2829
|
+
/**
|
|
2830
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
2831
|
+
*/
|
|
2832
|
+
pix?: PaymentMethodOptions.Pix;
|
|
2833
|
+
|
|
2379
2834
|
/**
|
|
2380
2835
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
2381
2836
|
*/
|
|
@@ -2823,6 +3278,150 @@ declare module 'stripe' {
|
|
|
2823
3278
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
2824
3279
|
*/
|
|
2825
3280
|
billing_agreement_id?: string;
|
|
3281
|
+
|
|
3282
|
+
currency?: string;
|
|
3283
|
+
|
|
3284
|
+
/**
|
|
3285
|
+
* 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.
|
|
3286
|
+
*/
|
|
3287
|
+
subsellers?: Array<string>;
|
|
3288
|
+
}
|
|
3289
|
+
|
|
3290
|
+
interface Payto {
|
|
3291
|
+
/**
|
|
3292
|
+
* Additional fields for Mandate creation.
|
|
3293
|
+
*/
|
|
3294
|
+
mandate_options?: Payto.MandateOptions;
|
|
3295
|
+
}
|
|
3296
|
+
|
|
3297
|
+
namespace Payto {
|
|
3298
|
+
interface MandateOptions {
|
|
3299
|
+
/**
|
|
3300
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
3301
|
+
*/
|
|
3302
|
+
amount?: number;
|
|
3303
|
+
|
|
3304
|
+
/**
|
|
3305
|
+
* 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.
|
|
3306
|
+
*/
|
|
3307
|
+
amount_type?: MandateOptions.AmountType;
|
|
3308
|
+
|
|
3309
|
+
/**
|
|
3310
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
3311
|
+
*/
|
|
3312
|
+
end_date?: string;
|
|
3313
|
+
|
|
3314
|
+
/**
|
|
3315
|
+
* The periodicity at which payments will be collected.
|
|
3316
|
+
*/
|
|
3317
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
3318
|
+
|
|
3319
|
+
/**
|
|
3320
|
+
* 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.
|
|
3321
|
+
*/
|
|
3322
|
+
payments_per_period?: number;
|
|
3323
|
+
|
|
3324
|
+
/**
|
|
3325
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
3326
|
+
*/
|
|
3327
|
+
purpose?: MandateOptions.Purpose;
|
|
3328
|
+
|
|
3329
|
+
/**
|
|
3330
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
3331
|
+
*/
|
|
3332
|
+
start_date?: string;
|
|
3333
|
+
}
|
|
3334
|
+
|
|
3335
|
+
namespace MandateOptions {
|
|
3336
|
+
type AmountType = 'fixed' | 'maximum';
|
|
3337
|
+
|
|
3338
|
+
type PaymentSchedule =
|
|
3339
|
+
| 'adhoc'
|
|
3340
|
+
| 'annual'
|
|
3341
|
+
| 'daily'
|
|
3342
|
+
| 'fortnightly'
|
|
3343
|
+
| 'monthly'
|
|
3344
|
+
| 'quarterly'
|
|
3345
|
+
| 'semi_annual'
|
|
3346
|
+
| 'weekly';
|
|
3347
|
+
|
|
3348
|
+
type Purpose =
|
|
3349
|
+
| 'dependant_support'
|
|
3350
|
+
| 'government'
|
|
3351
|
+
| 'loan'
|
|
3352
|
+
| 'mortgage'
|
|
3353
|
+
| 'other'
|
|
3354
|
+
| 'pension'
|
|
3355
|
+
| 'personal'
|
|
3356
|
+
| 'retail'
|
|
3357
|
+
| 'salary'
|
|
3358
|
+
| 'tax'
|
|
3359
|
+
| 'utility';
|
|
3360
|
+
}
|
|
3361
|
+
}
|
|
3362
|
+
|
|
3363
|
+
interface Pix {
|
|
3364
|
+
/**
|
|
3365
|
+
* Additional fields for mandate creation.
|
|
3366
|
+
*/
|
|
3367
|
+
mandate_options?: Pix.MandateOptions;
|
|
3368
|
+
}
|
|
3369
|
+
|
|
3370
|
+
namespace Pix {
|
|
3371
|
+
interface MandateOptions {
|
|
3372
|
+
/**
|
|
3373
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
3374
|
+
*/
|
|
3375
|
+
amount?: number;
|
|
3376
|
+
|
|
3377
|
+
/**
|
|
3378
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
3379
|
+
*/
|
|
3380
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
3381
|
+
|
|
3382
|
+
/**
|
|
3383
|
+
* Type of amount. Defaults to `maximum`.
|
|
3384
|
+
*/
|
|
3385
|
+
amount_type?: MandateOptions.AmountType;
|
|
3386
|
+
|
|
3387
|
+
/**
|
|
3388
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
3389
|
+
*/
|
|
3390
|
+
currency?: string;
|
|
3391
|
+
|
|
3392
|
+
/**
|
|
3393
|
+
* 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.
|
|
3394
|
+
*/
|
|
3395
|
+
end_date?: string;
|
|
3396
|
+
|
|
3397
|
+
/**
|
|
3398
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
3399
|
+
*/
|
|
3400
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
3401
|
+
|
|
3402
|
+
/**
|
|
3403
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
3404
|
+
*/
|
|
3405
|
+
reference?: string;
|
|
3406
|
+
|
|
3407
|
+
/**
|
|
3408
|
+
* 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.
|
|
3409
|
+
*/
|
|
3410
|
+
start_date?: string;
|
|
3411
|
+
}
|
|
3412
|
+
|
|
3413
|
+
namespace MandateOptions {
|
|
3414
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
3415
|
+
|
|
3416
|
+
type AmountType = 'fixed' | 'maximum';
|
|
3417
|
+
|
|
3418
|
+
type PaymentSchedule =
|
|
3419
|
+
| 'halfyearly'
|
|
3420
|
+
| 'monthly'
|
|
3421
|
+
| 'quarterly'
|
|
3422
|
+
| 'weekly'
|
|
3423
|
+
| 'yearly';
|
|
3424
|
+
}
|
|
2826
3425
|
}
|
|
2827
3426
|
|
|
2828
3427
|
interface SepaDebit {
|
|
@@ -2870,6 +3469,11 @@ declare module 'stripe' {
|
|
|
2870
3469
|
*/
|
|
2871
3470
|
filters?: FinancialConnections.Filters;
|
|
2872
3471
|
|
|
3472
|
+
/**
|
|
3473
|
+
* Customize manual entry behavior
|
|
3474
|
+
*/
|
|
3475
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
3476
|
+
|
|
2873
3477
|
/**
|
|
2874
3478
|
* 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`.
|
|
2875
3479
|
*/
|
|
@@ -2892,19 +3496,39 @@ declare module 'stripe' {
|
|
|
2892
3496
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
2893
3497
|
*/
|
|
2894
3498
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
3499
|
+
|
|
3500
|
+
/**
|
|
3501
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
3502
|
+
*/
|
|
3503
|
+
institution?: string;
|
|
2895
3504
|
}
|
|
2896
3505
|
|
|
2897
3506
|
namespace Filters {
|
|
2898
3507
|
type AccountSubcategory = 'checking' | 'savings';
|
|
2899
3508
|
}
|
|
2900
3509
|
|
|
3510
|
+
interface ManualEntry {
|
|
3511
|
+
/**
|
|
3512
|
+
* Settings for configuring manual entry of account details.
|
|
3513
|
+
*/
|
|
3514
|
+
mode: ManualEntry.Mode;
|
|
3515
|
+
}
|
|
3516
|
+
|
|
3517
|
+
namespace ManualEntry {
|
|
3518
|
+
type Mode = 'automatic' | 'custom';
|
|
3519
|
+
}
|
|
3520
|
+
|
|
2901
3521
|
type Permission =
|
|
2902
3522
|
| 'balances'
|
|
2903
3523
|
| 'ownership'
|
|
2904
3524
|
| 'payment_method'
|
|
2905
3525
|
| 'transactions';
|
|
2906
3526
|
|
|
2907
|
-
type Prefetch =
|
|
3527
|
+
type Prefetch =
|
|
3528
|
+
| 'balances'
|
|
3529
|
+
| 'inferred_balances'
|
|
3530
|
+
| 'ownership'
|
|
3531
|
+
| 'transactions';
|
|
2908
3532
|
}
|
|
2909
3533
|
|
|
2910
3534
|
interface MandateOptions {
|
|
@@ -2948,6 +3572,11 @@ declare module 'stripe' {
|
|
|
2948
3572
|
*/
|
|
2949
3573
|
customer?: string;
|
|
2950
3574
|
|
|
3575
|
+
/**
|
|
3576
|
+
* Only return SetupIntents for the account specified by this customer ID.
|
|
3577
|
+
*/
|
|
3578
|
+
customer_account?: string;
|
|
3579
|
+
|
|
2951
3580
|
/**
|
|
2952
3581
|
* Specifies which fields in the response should be expanded.
|
|
2953
3582
|
*/
|
|
@@ -3173,11 +3802,21 @@ declare module 'stripe' {
|
|
|
3173
3802
|
*/
|
|
3174
3803
|
giropay?: PaymentMethodData.Giropay;
|
|
3175
3804
|
|
|
3805
|
+
/**
|
|
3806
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
3807
|
+
*/
|
|
3808
|
+
gopay?: PaymentMethodData.Gopay;
|
|
3809
|
+
|
|
3176
3810
|
/**
|
|
3177
3811
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
3178
3812
|
*/
|
|
3179
3813
|
grabpay?: PaymentMethodData.Grabpay;
|
|
3180
3814
|
|
|
3815
|
+
/**
|
|
3816
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
3817
|
+
*/
|
|
3818
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
3819
|
+
|
|
3181
3820
|
/**
|
|
3182
3821
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
3183
3822
|
*/
|
|
@@ -3213,6 +3852,11 @@ declare module 'stripe' {
|
|
|
3213
3852
|
*/
|
|
3214
3853
|
link?: PaymentMethodData.Link;
|
|
3215
3854
|
|
|
3855
|
+
/**
|
|
3856
|
+
* If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
|
|
3857
|
+
*/
|
|
3858
|
+
mb_way?: PaymentMethodData.MbWay;
|
|
3859
|
+
|
|
3216
3860
|
/**
|
|
3217
3861
|
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
|
3218
3862
|
*/
|
|
@@ -3268,6 +3912,11 @@ declare module 'stripe' {
|
|
|
3268
3912
|
*/
|
|
3269
3913
|
paypal?: PaymentMethodData.Paypal;
|
|
3270
3914
|
|
|
3915
|
+
/**
|
|
3916
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
3917
|
+
*/
|
|
3918
|
+
payto?: PaymentMethodData.Payto;
|
|
3919
|
+
|
|
3271
3920
|
/**
|
|
3272
3921
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
3273
3922
|
*/
|
|
@@ -3278,11 +3927,21 @@ declare module 'stripe' {
|
|
|
3278
3927
|
*/
|
|
3279
3928
|
promptpay?: PaymentMethodData.Promptpay;
|
|
3280
3929
|
|
|
3930
|
+
/**
|
|
3931
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
3932
|
+
*/
|
|
3933
|
+
qris?: PaymentMethodData.Qris;
|
|
3934
|
+
|
|
3281
3935
|
/**
|
|
3282
3936
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
3283
3937
|
*/
|
|
3284
3938
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
3285
3939
|
|
|
3940
|
+
/**
|
|
3941
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
3942
|
+
*/
|
|
3943
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
3944
|
+
|
|
3286
3945
|
/**
|
|
3287
3946
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
3288
3947
|
*/
|
|
@@ -3303,11 +3962,21 @@ declare module 'stripe' {
|
|
|
3303
3962
|
*/
|
|
3304
3963
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
3305
3964
|
|
|
3965
|
+
/**
|
|
3966
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
3967
|
+
*/
|
|
3968
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
3969
|
+
|
|
3306
3970
|
/**
|
|
3307
3971
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
3308
3972
|
*/
|
|
3309
3973
|
sofort?: PaymentMethodData.Sofort;
|
|
3310
3974
|
|
|
3975
|
+
/**
|
|
3976
|
+
* This hash contains details about the Stripe balance payment method.
|
|
3977
|
+
*/
|
|
3978
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
3979
|
+
|
|
3311
3980
|
/**
|
|
3312
3981
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
3313
3982
|
*/
|
|
@@ -3520,8 +4189,21 @@ declare module 'stripe' {
|
|
|
3520
4189
|
|
|
3521
4190
|
interface Giropay {}
|
|
3522
4191
|
|
|
4192
|
+
interface Gopay {}
|
|
4193
|
+
|
|
3523
4194
|
interface Grabpay {}
|
|
3524
4195
|
|
|
4196
|
+
interface IdBankTransfer {
|
|
4197
|
+
/**
|
|
4198
|
+
* Bank where the account is held.
|
|
4199
|
+
*/
|
|
4200
|
+
bank?: IdBankTransfer.Bank;
|
|
4201
|
+
}
|
|
4202
|
+
|
|
4203
|
+
namespace IdBankTransfer {
|
|
4204
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
4205
|
+
}
|
|
4206
|
+
|
|
3525
4207
|
interface Ideal {
|
|
3526
4208
|
/**
|
|
3527
4209
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -3586,6 +4268,8 @@ declare module 'stripe' {
|
|
|
3586
4268
|
|
|
3587
4269
|
interface Link {}
|
|
3588
4270
|
|
|
4271
|
+
interface MbWay {}
|
|
4272
|
+
|
|
3589
4273
|
interface Mobilepay {}
|
|
3590
4274
|
|
|
3591
4275
|
interface Multibanco {}
|
|
@@ -3677,10 +4361,29 @@ declare module 'stripe' {
|
|
|
3677
4361
|
|
|
3678
4362
|
interface Paypal {}
|
|
3679
4363
|
|
|
4364
|
+
interface Payto {
|
|
4365
|
+
/**
|
|
4366
|
+
* The account number for the bank account.
|
|
4367
|
+
*/
|
|
4368
|
+
account_number?: string;
|
|
4369
|
+
|
|
4370
|
+
/**
|
|
4371
|
+
* Bank-State-Branch number of the bank account.
|
|
4372
|
+
*/
|
|
4373
|
+
bsb_number?: string;
|
|
4374
|
+
|
|
4375
|
+
/**
|
|
4376
|
+
* The PayID alias for the bank account.
|
|
4377
|
+
*/
|
|
4378
|
+
pay_id?: string;
|
|
4379
|
+
}
|
|
4380
|
+
|
|
3680
4381
|
interface Pix {}
|
|
3681
4382
|
|
|
3682
4383
|
interface Promptpay {}
|
|
3683
4384
|
|
|
4385
|
+
interface Qris {}
|
|
4386
|
+
|
|
3684
4387
|
interface RadarOptions {
|
|
3685
4388
|
/**
|
|
3686
4389
|
* 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.
|
|
@@ -3688,6 +4391,32 @@ declare module 'stripe' {
|
|
|
3688
4391
|
session?: string;
|
|
3689
4392
|
}
|
|
3690
4393
|
|
|
4394
|
+
interface Rechnung {
|
|
4395
|
+
/**
|
|
4396
|
+
* Customer's date of birth
|
|
4397
|
+
*/
|
|
4398
|
+
dob: Rechnung.Dob;
|
|
4399
|
+
}
|
|
4400
|
+
|
|
4401
|
+
namespace Rechnung {
|
|
4402
|
+
interface Dob {
|
|
4403
|
+
/**
|
|
4404
|
+
* The day of birth, between 1 and 31.
|
|
4405
|
+
*/
|
|
4406
|
+
day: number;
|
|
4407
|
+
|
|
4408
|
+
/**
|
|
4409
|
+
* The month of birth, between 1 and 12.
|
|
4410
|
+
*/
|
|
4411
|
+
month: number;
|
|
4412
|
+
|
|
4413
|
+
/**
|
|
4414
|
+
* The four-digit year of birth.
|
|
4415
|
+
*/
|
|
4416
|
+
year: number;
|
|
4417
|
+
}
|
|
4418
|
+
}
|
|
4419
|
+
|
|
3691
4420
|
interface RevolutPay {}
|
|
3692
4421
|
|
|
3693
4422
|
interface SamsungPay {}
|
|
@@ -3701,6 +4430,8 @@ declare module 'stripe' {
|
|
|
3701
4430
|
iban: string;
|
|
3702
4431
|
}
|
|
3703
4432
|
|
|
4433
|
+
interface Shopeepay {}
|
|
4434
|
+
|
|
3704
4435
|
interface Sofort {
|
|
3705
4436
|
/**
|
|
3706
4437
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -3712,6 +4443,22 @@ declare module 'stripe' {
|
|
|
3712
4443
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
3713
4444
|
}
|
|
3714
4445
|
|
|
4446
|
+
interface StripeBalance {
|
|
4447
|
+
/**
|
|
4448
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
4449
|
+
*/
|
|
4450
|
+
account?: string;
|
|
4451
|
+
|
|
4452
|
+
/**
|
|
4453
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
4454
|
+
*/
|
|
4455
|
+
source_type?: StripeBalance.SourceType;
|
|
4456
|
+
}
|
|
4457
|
+
|
|
4458
|
+
namespace StripeBalance {
|
|
4459
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
4460
|
+
}
|
|
4461
|
+
|
|
3715
4462
|
interface Swish {}
|
|
3716
4463
|
|
|
3717
4464
|
interface Twint {}
|
|
@@ -3735,13 +4482,16 @@ declare module 'stripe' {
|
|
|
3735
4482
|
| 'eps'
|
|
3736
4483
|
| 'fpx'
|
|
3737
4484
|
| 'giropay'
|
|
4485
|
+
| 'gopay'
|
|
3738
4486
|
| 'grabpay'
|
|
4487
|
+
| 'id_bank_transfer'
|
|
3739
4488
|
| 'ideal'
|
|
3740
4489
|
| 'kakao_pay'
|
|
3741
4490
|
| 'klarna'
|
|
3742
4491
|
| 'konbini'
|
|
3743
4492
|
| 'kr_card'
|
|
3744
4493
|
| 'link'
|
|
4494
|
+
| 'mb_way'
|
|
3745
4495
|
| 'mobilepay'
|
|
3746
4496
|
| 'multibanco'
|
|
3747
4497
|
| 'naver_pay'
|
|
@@ -3752,13 +4502,18 @@ declare module 'stripe' {
|
|
|
3752
4502
|
| 'payco'
|
|
3753
4503
|
| 'paynow'
|
|
3754
4504
|
| 'paypal'
|
|
4505
|
+
| 'payto'
|
|
3755
4506
|
| 'pix'
|
|
3756
4507
|
| 'promptpay'
|
|
4508
|
+
| 'qris'
|
|
4509
|
+
| 'rechnung'
|
|
3757
4510
|
| 'revolut_pay'
|
|
3758
4511
|
| 'samsung_pay'
|
|
3759
4512
|
| 'satispay'
|
|
3760
4513
|
| 'sepa_debit'
|
|
4514
|
+
| 'shopeepay'
|
|
3761
4515
|
| 'sofort'
|
|
4516
|
+
| 'stripe_balance'
|
|
3762
4517
|
| 'swish'
|
|
3763
4518
|
| 'twint'
|
|
3764
4519
|
| 'us_bank_account'
|
|
@@ -3844,6 +4599,16 @@ declare module 'stripe' {
|
|
|
3844
4599
|
*/
|
|
3845
4600
|
paypal?: PaymentMethodOptions.Paypal;
|
|
3846
4601
|
|
|
4602
|
+
/**
|
|
4603
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
4604
|
+
*/
|
|
4605
|
+
payto?: PaymentMethodOptions.Payto;
|
|
4606
|
+
|
|
4607
|
+
/**
|
|
4608
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
4609
|
+
*/
|
|
4610
|
+
pix?: PaymentMethodOptions.Pix;
|
|
4611
|
+
|
|
3847
4612
|
/**
|
|
3848
4613
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
3849
4614
|
*/
|
|
@@ -4291,6 +5056,150 @@ declare module 'stripe' {
|
|
|
4291
5056
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
4292
5057
|
*/
|
|
4293
5058
|
billing_agreement_id?: string;
|
|
5059
|
+
|
|
5060
|
+
currency?: string;
|
|
5061
|
+
|
|
5062
|
+
/**
|
|
5063
|
+
* 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.
|
|
5064
|
+
*/
|
|
5065
|
+
subsellers?: Array<string>;
|
|
5066
|
+
}
|
|
5067
|
+
|
|
5068
|
+
interface Payto {
|
|
5069
|
+
/**
|
|
5070
|
+
* Additional fields for Mandate creation.
|
|
5071
|
+
*/
|
|
5072
|
+
mandate_options?: Payto.MandateOptions;
|
|
5073
|
+
}
|
|
5074
|
+
|
|
5075
|
+
namespace Payto {
|
|
5076
|
+
interface MandateOptions {
|
|
5077
|
+
/**
|
|
5078
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
5079
|
+
*/
|
|
5080
|
+
amount?: number;
|
|
5081
|
+
|
|
5082
|
+
/**
|
|
5083
|
+
* 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.
|
|
5084
|
+
*/
|
|
5085
|
+
amount_type?: MandateOptions.AmountType;
|
|
5086
|
+
|
|
5087
|
+
/**
|
|
5088
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
5089
|
+
*/
|
|
5090
|
+
end_date?: string;
|
|
5091
|
+
|
|
5092
|
+
/**
|
|
5093
|
+
* The periodicity at which payments will be collected.
|
|
5094
|
+
*/
|
|
5095
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
5096
|
+
|
|
5097
|
+
/**
|
|
5098
|
+
* 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.
|
|
5099
|
+
*/
|
|
5100
|
+
payments_per_period?: number;
|
|
5101
|
+
|
|
5102
|
+
/**
|
|
5103
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
5104
|
+
*/
|
|
5105
|
+
purpose?: MandateOptions.Purpose;
|
|
5106
|
+
|
|
5107
|
+
/**
|
|
5108
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
5109
|
+
*/
|
|
5110
|
+
start_date?: string;
|
|
5111
|
+
}
|
|
5112
|
+
|
|
5113
|
+
namespace MandateOptions {
|
|
5114
|
+
type AmountType = 'fixed' | 'maximum';
|
|
5115
|
+
|
|
5116
|
+
type PaymentSchedule =
|
|
5117
|
+
| 'adhoc'
|
|
5118
|
+
| 'annual'
|
|
5119
|
+
| 'daily'
|
|
5120
|
+
| 'fortnightly'
|
|
5121
|
+
| 'monthly'
|
|
5122
|
+
| 'quarterly'
|
|
5123
|
+
| 'semi_annual'
|
|
5124
|
+
| 'weekly';
|
|
5125
|
+
|
|
5126
|
+
type Purpose =
|
|
5127
|
+
| 'dependant_support'
|
|
5128
|
+
| 'government'
|
|
5129
|
+
| 'loan'
|
|
5130
|
+
| 'mortgage'
|
|
5131
|
+
| 'other'
|
|
5132
|
+
| 'pension'
|
|
5133
|
+
| 'personal'
|
|
5134
|
+
| 'retail'
|
|
5135
|
+
| 'salary'
|
|
5136
|
+
| 'tax'
|
|
5137
|
+
| 'utility';
|
|
5138
|
+
}
|
|
5139
|
+
}
|
|
5140
|
+
|
|
5141
|
+
interface Pix {
|
|
5142
|
+
/**
|
|
5143
|
+
* Additional fields for mandate creation.
|
|
5144
|
+
*/
|
|
5145
|
+
mandate_options?: Pix.MandateOptions;
|
|
5146
|
+
}
|
|
5147
|
+
|
|
5148
|
+
namespace Pix {
|
|
5149
|
+
interface MandateOptions {
|
|
5150
|
+
/**
|
|
5151
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
5152
|
+
*/
|
|
5153
|
+
amount?: number;
|
|
5154
|
+
|
|
5155
|
+
/**
|
|
5156
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
5157
|
+
*/
|
|
5158
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
5159
|
+
|
|
5160
|
+
/**
|
|
5161
|
+
* Type of amount. Defaults to `maximum`.
|
|
5162
|
+
*/
|
|
5163
|
+
amount_type?: MandateOptions.AmountType;
|
|
5164
|
+
|
|
5165
|
+
/**
|
|
5166
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
5167
|
+
*/
|
|
5168
|
+
currency?: string;
|
|
5169
|
+
|
|
5170
|
+
/**
|
|
5171
|
+
* 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.
|
|
5172
|
+
*/
|
|
5173
|
+
end_date?: string;
|
|
5174
|
+
|
|
5175
|
+
/**
|
|
5176
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
5177
|
+
*/
|
|
5178
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
5179
|
+
|
|
5180
|
+
/**
|
|
5181
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
5182
|
+
*/
|
|
5183
|
+
reference?: string;
|
|
5184
|
+
|
|
5185
|
+
/**
|
|
5186
|
+
* 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.
|
|
5187
|
+
*/
|
|
5188
|
+
start_date?: string;
|
|
5189
|
+
}
|
|
5190
|
+
|
|
5191
|
+
namespace MandateOptions {
|
|
5192
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
5193
|
+
|
|
5194
|
+
type AmountType = 'fixed' | 'maximum';
|
|
5195
|
+
|
|
5196
|
+
type PaymentSchedule =
|
|
5197
|
+
| 'halfyearly'
|
|
5198
|
+
| 'monthly'
|
|
5199
|
+
| 'quarterly'
|
|
5200
|
+
| 'weekly'
|
|
5201
|
+
| 'yearly';
|
|
5202
|
+
}
|
|
4294
5203
|
}
|
|
4295
5204
|
|
|
4296
5205
|
interface SepaDebit {
|
|
@@ -4338,6 +5247,11 @@ declare module 'stripe' {
|
|
|
4338
5247
|
*/
|
|
4339
5248
|
filters?: FinancialConnections.Filters;
|
|
4340
5249
|
|
|
5250
|
+
/**
|
|
5251
|
+
* Customize manual entry behavior
|
|
5252
|
+
*/
|
|
5253
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
5254
|
+
|
|
4341
5255
|
/**
|
|
4342
5256
|
* 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`.
|
|
4343
5257
|
*/
|
|
@@ -4360,19 +5274,39 @@ declare module 'stripe' {
|
|
|
4360
5274
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
4361
5275
|
*/
|
|
4362
5276
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
5277
|
+
|
|
5278
|
+
/**
|
|
5279
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
5280
|
+
*/
|
|
5281
|
+
institution?: string;
|
|
4363
5282
|
}
|
|
4364
5283
|
|
|
4365
5284
|
namespace Filters {
|
|
4366
5285
|
type AccountSubcategory = 'checking' | 'savings';
|
|
4367
5286
|
}
|
|
4368
5287
|
|
|
5288
|
+
interface ManualEntry {
|
|
5289
|
+
/**
|
|
5290
|
+
* Settings for configuring manual entry of account details.
|
|
5291
|
+
*/
|
|
5292
|
+
mode: ManualEntry.Mode;
|
|
5293
|
+
}
|
|
5294
|
+
|
|
5295
|
+
namespace ManualEntry {
|
|
5296
|
+
type Mode = 'automatic' | 'custom';
|
|
5297
|
+
}
|
|
5298
|
+
|
|
4369
5299
|
type Permission =
|
|
4370
5300
|
| 'balances'
|
|
4371
5301
|
| 'ownership'
|
|
4372
5302
|
| 'payment_method'
|
|
4373
5303
|
| 'transactions';
|
|
4374
5304
|
|
|
4375
|
-
type Prefetch =
|
|
5305
|
+
type Prefetch =
|
|
5306
|
+
| 'balances'
|
|
5307
|
+
| 'inferred_balances'
|
|
5308
|
+
| 'ownership'
|
|
5309
|
+
| 'transactions';
|
|
4376
5310
|
}
|
|
4377
5311
|
|
|
4378
5312
|
interface MandateOptions {
|