stripe 19.1.0 → 19.2.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 +1568 -11
- 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/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/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/PaymentMethods.js +4 -0
- package/cjs/resources/PaymentRecords.js +33 -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 +21 -0
- package/cjs/resources/V2/Billing/PricingPlans/Components.js +29 -0
- package/cjs/resources/V2/Billing/PricingPlans/Versions.js +17 -0
- package/cjs/resources/V2/Billing/PricingPlans.js +29 -0
- package/cjs/resources/V2/Billing/Profiles.js +19 -0
- package/cjs/resources/V2/Billing/RateCardSubscriptions.js +29 -0
- package/cjs/resources/V2/Billing/RateCards/Rates.js +25 -0
- package/cjs/resources/V2/Billing/RateCards/Versions.js +17 -0
- package/cjs/resources/V2/Billing/RateCards.js +29 -0
- package/cjs/resources/V2/Billing/ServiceActions.js +20 -0
- package/cjs/resources/V2/Core/AccountLinks.js +9 -0
- package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
- package/cjs/resources/V2/Core/Accounts.js +25 -0
- package/cjs/resources/V2/Core/ClaimableSandboxes.js +16 -0
- package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +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/RecipientVerifications.js +20 -0
- package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
- package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
- package/cjs/resources/V2/Payments/OffSessionPayments.js +29 -0
- package/cjs/resources/V2/Tax/AutomaticRules.js +22 -0
- package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
- package/cjs/resources/V2/TestHelpers/MoneyManagement.js +12 -0
- package/cjs/resources.js +140 -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/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/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/PaymentMethods.js +4 -0
- package/esm/resources/PaymentRecords.js +30 -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 +18 -0
- package/esm/resources/V2/Billing/PricingPlans/Components.js +26 -0
- package/esm/resources/V2/Billing/PricingPlans/Versions.js +14 -0
- package/esm/resources/V2/Billing/PricingPlans.js +26 -0
- package/esm/resources/V2/Billing/Profiles.js +16 -0
- package/esm/resources/V2/Billing/RateCardSubscriptions.js +26 -0
- package/esm/resources/V2/Billing/RateCards/Rates.js +22 -0
- package/esm/resources/V2/Billing/RateCards/Versions.js +14 -0
- package/esm/resources/V2/Billing/RateCards.js +26 -0
- package/esm/resources/V2/Billing/ServiceActions.js +17 -0
- package/esm/resources/V2/Core/AccountLinks.js +6 -0
- package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
- package/esm/resources/V2/Core/Accounts.js +22 -0
- package/esm/resources/V2/Core/ClaimableSandboxes.js +13 -0
- package/esm/resources/V2/Core/Vault/GbBankAccounts.js +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/RecipientVerifications.js +17 -0
- package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
- package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
- package/esm/resources/V2/Payments/OffSessionPayments.js +26 -0
- package/esm/resources/V2/Tax/AutomaticRules.js +19 -0
- package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
- package/esm/resources/V2/TestHelpers/MoneyManagement.js +9 -0
- package/esm/resources.js +125 -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 +212 -1
- package/types/AccountsResource.d.ts +544 -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 +689 -0
- package/types/Billing/Analytics/MeterUsageRows.d.ts +51 -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 +43 -2
- 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 +19 -0
- package/types/CashBalances.d.ts +5 -0
- package/types/Charges.d.ts +180 -0
- package/types/ChargesResource.d.ts +1406 -0
- package/types/Checkout/Sessions.d.ts +427 -2
- package/types/Checkout/SessionsResource.d.ts +684 -2
- package/types/ConfirmationTokens.d.ts +139 -0
- package/types/Coupons.d.ts +33 -0
- package/types/CouponsResource.d.ts +21 -0
- package/types/CreditNoteLineItems.d.ts +17 -0
- package/types/CreditNotes.d.ts +31 -0
- package/types/CreditNotesResource.d.ts +83 -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 +40 -0
- package/types/DisputesResource.d.ts +11 -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 +204 -4
- package/types/InvoicesResource.d.ts +1652 -22
- package/types/Issuing/CardholdersResource.d.ts +2 -1
- package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
- package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
- package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
- package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
- package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
- package/types/Issuing/Settlements.d.ts +113 -0
- package/types/Issuing/Transactions.d.ts +5 -0
- package/types/Issuing/TransactionsResource.d.ts +5 -0
- package/types/LineItems.d.ts +49 -0
- package/types/Mandates.d.ts +135 -1
- package/types/MandatesResource.d.ts +31 -0
- package/types/Margins.d.ts +56 -0
- package/types/MarginsResource.d.ts +114 -0
- package/types/Orders.d.ts +1163 -0
- package/types/OrdersResource.d.ts +3139 -0
- package/types/PaymentAttemptRecords.d.ts +2360 -0
- package/types/PaymentAttemptRecordsResource.d.ts +52 -0
- package/types/PaymentIntentAmountDetailsLineItems.d.ts +116 -0
- package/types/PaymentIntents.d.ts +840 -3
- package/types/PaymentIntentsResource.d.ts +11825 -5923
- package/types/PaymentLinks.d.ts +7 -0
- package/types/PaymentLinksResource.d.ts +14 -0
- package/types/PaymentMethodBalances.d.ts +63 -0
- package/types/PaymentMethodConfigurations.d.ts +216 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +300 -0
- package/types/PaymentMethods.d.ts +144 -0
- package/types/PaymentMethodsResource.d.ts +187 -2
- package/types/PaymentRecords.d.ts +2353 -0
- package/types/PaymentRecordsResource.d.ts +559 -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 +1770 -0
- package/types/QuotePreviewSubscriptionSchedules.d.ts +908 -0
- package/types/Quotes.d.ts +594 -1
- package/types/QuotesResource.d.ts +2588 -243
- package/types/Refunds.d.ts +14 -0
- package/types/SetupAttempts.d.ts +51 -1
- package/types/SetupIntents.d.ts +231 -2
- package/types/SetupIntentsResource.d.ts +1028 -4
- package/types/Sources.d.ts +29 -0
- package/types/SubscriptionItems.d.ts +26 -0
- package/types/SubscriptionItemsResource.d.ts +109 -0
- package/types/SubscriptionSchedules.d.ts +205 -0
- package/types/SubscriptionSchedulesResource.d.ts +1233 -5
- package/types/Subscriptions.d.ts +263 -1
- package/types/SubscriptionsResource.d.ts +747 -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 +731 -0
- package/types/V2/Billing/CadencesResource.d.ts +516 -0
- package/types/V2/Billing/CollectionSettingVersions.d.ts +314 -0
- package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +62 -0
- package/types/V2/Billing/CollectionSettings.d.ts +337 -0
- package/types/V2/Billing/CollectionSettingsResource.d.ts +675 -0
- package/types/V2/Billing/CustomPricingUnits.d.ts +56 -0
- package/types/V2/Billing/CustomPricingUnitsResource.d.ts +122 -0
- package/types/V2/Billing/IntentActions.d.ts +459 -0
- package/types/V2/Billing/Intents/ActionsResource.d.ts +58 -0
- package/types/V2/Billing/Intents.d.ts +117 -0
- package/types/V2/Billing/IntentsResource.d.ts +575 -0
- package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +64 -0
- package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +28 -0
- package/types/V2/Billing/LicenseFeeVersions.d.ts +106 -0
- package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/LicenseFees.d.ts +164 -0
- package/types/V2/Billing/LicenseFeesResource.d.ts +290 -0
- package/types/V2/Billing/LicensedItems.d.ts +73 -0
- package/types/V2/Billing/LicensedItemsResource.d.ts +157 -0
- package/types/V2/Billing/MeteredItems.d.ts +101 -0
- package/types/V2/Billing/MeteredItemsResource.d.ts +189 -0
- package/types/V2/Billing/PricingPlanComponents.d.ts +109 -0
- package/types/V2/Billing/PricingPlanSubscriptions.d.ts +144 -0
- package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +118 -0
- package/types/V2/Billing/PricingPlanVersions.d.ts +49 -0
- package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +197 -0
- package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/PricingPlans.d.ts +84 -0
- package/types/V2/Billing/PricingPlansResource.d.ts +151 -0
- package/types/V2/Billing/Profiles.d.ts +70 -0
- package/types/V2/Billing/ProfilesResource.d.ts +150 -0
- package/types/V2/Billing/RateCardRates.d.ts +144 -0
- package/types/V2/Billing/RateCardSubscriptions.d.ts +144 -0
- package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +157 -0
- package/types/V2/Billing/RateCardVersions.d.ts +39 -0
- package/types/V2/Billing/RateCards/RatesResource.d.ts +203 -0
- package/types/V2/Billing/RateCards/VersionsResource.d.ts +58 -0
- package/types/V2/Billing/RateCards.d.ts +98 -0
- package/types/V2/Billing/RateCardsResource.d.ts +162 -0
- package/types/V2/Billing/ServiceActions.d.ts +274 -0
- package/types/V2/Billing/ServiceActionsResource.d.ts +370 -0
- package/types/V2/Core/AccountLinks.d.ts +168 -0
- package/types/V2/Core/AccountLinksResource.d.ts +152 -0
- package/types/V2/Core/AccountPersons.d.ts +615 -0
- package/types/V2/Core/Accounts/PersonsResource.d.ts +1153 -0
- package/types/V2/Core/Accounts.d.ts +6816 -0
- package/types/V2/Core/AccountsResource.d.ts +6000 -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 +8489 -10
- package/types/V2/Core/Events.d.ts +12 -0
- package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
- package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +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/FinancialAddressCreditSimulations.d.ts +27 -0
- package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
- package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
- package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
- package/types/V2/MoneyManagement/FinancialAccounts.d.ts +148 -0
- package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +147 -0
- package/types/V2/MoneyManagement/FinancialAddresses.d.ts +178 -0
- package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +126 -0
- package/types/V2/MoneyManagement/InboundTransfers.d.ts +206 -0
- package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +170 -0
- package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
- package/types/V2/MoneyManagement/OutboundPayments.d.ts +283 -0
- package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +247 -0
- package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
- package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +330 -0
- package/types/V2/MoneyManagement/OutboundTransfers.d.ts +256 -0
- package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +213 -0
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +201 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +93 -0
- package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
- package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
- package/types/V2/MoneyManagement/ReceivedCredits.d.ts +302 -0
- package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
- package/types/V2/MoneyManagement/ReceivedDebits.d.ts +181 -0
- package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
- package/types/V2/MoneyManagement/RecipientVerifications.d.ts +112 -0
- package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +77 -0
- package/types/V2/MoneyManagement/TransactionEntries.d.ts +162 -0
- package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
- package/types/V2/MoneyManagement/Transactions.d.ts +177 -0
- package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
- package/types/V2/Payments/OffSessionPayments.d.ts +326 -0
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +401 -0
- package/types/V2/Tax/AutomaticRules.d.ts +53 -0
- package/types/V2/Tax/AutomaticRulesResource.d.ts +102 -0
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +73 -0
- package/types/V2/TestHelpers/MoneyManagementResource.d.ts +48 -0
- package/types/WebhookEndpointsResource.d.ts +78 -0
- package/types/Webhooks.d.ts +2 -0
- package/types/apiVersion.d.ts +1 -2
- package/types/index.d.ts +219 -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
|
*/
|
|
@@ -97,6 +104,11 @@ declare module 'stripe' {
|
|
|
97
104
|
*/
|
|
98
105
|
return_url?: string;
|
|
99
106
|
|
|
107
|
+
/**
|
|
108
|
+
* Provides industry-specific information about the SetupIntent.
|
|
109
|
+
*/
|
|
110
|
+
setup_details?: SetupIntentCreateParams.SetupDetails;
|
|
111
|
+
|
|
100
112
|
/**
|
|
101
113
|
* If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.
|
|
102
114
|
*
|
|
@@ -286,11 +298,21 @@ declare module 'stripe' {
|
|
|
286
298
|
*/
|
|
287
299
|
giropay?: PaymentMethodData.Giropay;
|
|
288
300
|
|
|
301
|
+
/**
|
|
302
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
303
|
+
*/
|
|
304
|
+
gopay?: PaymentMethodData.Gopay;
|
|
305
|
+
|
|
289
306
|
/**
|
|
290
307
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
291
308
|
*/
|
|
292
309
|
grabpay?: PaymentMethodData.Grabpay;
|
|
293
310
|
|
|
311
|
+
/**
|
|
312
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
313
|
+
*/
|
|
314
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
315
|
+
|
|
294
316
|
/**
|
|
295
317
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
296
318
|
*/
|
|
@@ -386,6 +408,16 @@ declare module 'stripe' {
|
|
|
386
408
|
*/
|
|
387
409
|
paypal?: PaymentMethodData.Paypal;
|
|
388
410
|
|
|
411
|
+
/**
|
|
412
|
+
* If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
|
|
413
|
+
*/
|
|
414
|
+
paypay?: PaymentMethodData.Paypay;
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
418
|
+
*/
|
|
419
|
+
payto?: PaymentMethodData.Payto;
|
|
420
|
+
|
|
389
421
|
/**
|
|
390
422
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
391
423
|
*/
|
|
@@ -396,11 +428,21 @@ declare module 'stripe' {
|
|
|
396
428
|
*/
|
|
397
429
|
promptpay?: PaymentMethodData.Promptpay;
|
|
398
430
|
|
|
431
|
+
/**
|
|
432
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
433
|
+
*/
|
|
434
|
+
qris?: PaymentMethodData.Qris;
|
|
435
|
+
|
|
399
436
|
/**
|
|
400
437
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
401
438
|
*/
|
|
402
439
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
403
440
|
|
|
441
|
+
/**
|
|
442
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
443
|
+
*/
|
|
444
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
445
|
+
|
|
404
446
|
/**
|
|
405
447
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
406
448
|
*/
|
|
@@ -421,11 +463,21 @@ declare module 'stripe' {
|
|
|
421
463
|
*/
|
|
422
464
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
423
465
|
|
|
466
|
+
/**
|
|
467
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
468
|
+
*/
|
|
469
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
470
|
+
|
|
424
471
|
/**
|
|
425
472
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
426
473
|
*/
|
|
427
474
|
sofort?: PaymentMethodData.Sofort;
|
|
428
475
|
|
|
476
|
+
/**
|
|
477
|
+
* This hash contains details about the Stripe balance payment method.
|
|
478
|
+
*/
|
|
479
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
480
|
+
|
|
429
481
|
/**
|
|
430
482
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
431
483
|
*/
|
|
@@ -638,8 +690,21 @@ declare module 'stripe' {
|
|
|
638
690
|
|
|
639
691
|
interface Giropay {}
|
|
640
692
|
|
|
693
|
+
interface Gopay {}
|
|
694
|
+
|
|
641
695
|
interface Grabpay {}
|
|
642
696
|
|
|
697
|
+
interface IdBankTransfer {
|
|
698
|
+
/**
|
|
699
|
+
* Bank where the account is held.
|
|
700
|
+
*/
|
|
701
|
+
bank?: IdBankTransfer.Bank;
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
namespace IdBankTransfer {
|
|
705
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
706
|
+
}
|
|
707
|
+
|
|
643
708
|
interface Ideal {
|
|
644
709
|
/**
|
|
645
710
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -797,10 +862,31 @@ declare module 'stripe' {
|
|
|
797
862
|
|
|
798
863
|
interface Paypal {}
|
|
799
864
|
|
|
865
|
+
interface Paypay {}
|
|
866
|
+
|
|
867
|
+
interface Payto {
|
|
868
|
+
/**
|
|
869
|
+
* The account number for the bank account.
|
|
870
|
+
*/
|
|
871
|
+
account_number?: string;
|
|
872
|
+
|
|
873
|
+
/**
|
|
874
|
+
* Bank-State-Branch number of the bank account.
|
|
875
|
+
*/
|
|
876
|
+
bsb_number?: string;
|
|
877
|
+
|
|
878
|
+
/**
|
|
879
|
+
* The PayID alias for the bank account.
|
|
880
|
+
*/
|
|
881
|
+
pay_id?: string;
|
|
882
|
+
}
|
|
883
|
+
|
|
800
884
|
interface Pix {}
|
|
801
885
|
|
|
802
886
|
interface Promptpay {}
|
|
803
887
|
|
|
888
|
+
interface Qris {}
|
|
889
|
+
|
|
804
890
|
interface RadarOptions {
|
|
805
891
|
/**
|
|
806
892
|
* 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.
|
|
@@ -808,6 +894,32 @@ declare module 'stripe' {
|
|
|
808
894
|
session?: string;
|
|
809
895
|
}
|
|
810
896
|
|
|
897
|
+
interface Rechnung {
|
|
898
|
+
/**
|
|
899
|
+
* Customer's date of birth
|
|
900
|
+
*/
|
|
901
|
+
dob: Rechnung.Dob;
|
|
902
|
+
}
|
|
903
|
+
|
|
904
|
+
namespace Rechnung {
|
|
905
|
+
interface Dob {
|
|
906
|
+
/**
|
|
907
|
+
* The day of birth, between 1 and 31.
|
|
908
|
+
*/
|
|
909
|
+
day: number;
|
|
910
|
+
|
|
911
|
+
/**
|
|
912
|
+
* The month of birth, between 1 and 12.
|
|
913
|
+
*/
|
|
914
|
+
month: number;
|
|
915
|
+
|
|
916
|
+
/**
|
|
917
|
+
* The four-digit year of birth.
|
|
918
|
+
*/
|
|
919
|
+
year: number;
|
|
920
|
+
}
|
|
921
|
+
}
|
|
922
|
+
|
|
811
923
|
interface RevolutPay {}
|
|
812
924
|
|
|
813
925
|
interface SamsungPay {}
|
|
@@ -821,6 +933,8 @@ declare module 'stripe' {
|
|
|
821
933
|
iban: string;
|
|
822
934
|
}
|
|
823
935
|
|
|
936
|
+
interface Shopeepay {}
|
|
937
|
+
|
|
824
938
|
interface Sofort {
|
|
825
939
|
/**
|
|
826
940
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -832,6 +946,22 @@ declare module 'stripe' {
|
|
|
832
946
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
833
947
|
}
|
|
834
948
|
|
|
949
|
+
interface StripeBalance {
|
|
950
|
+
/**
|
|
951
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
952
|
+
*/
|
|
953
|
+
account?: string;
|
|
954
|
+
|
|
955
|
+
/**
|
|
956
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
957
|
+
*/
|
|
958
|
+
source_type?: StripeBalance.SourceType;
|
|
959
|
+
}
|
|
960
|
+
|
|
961
|
+
namespace StripeBalance {
|
|
962
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
963
|
+
}
|
|
964
|
+
|
|
835
965
|
interface Swish {}
|
|
836
966
|
|
|
837
967
|
interface Twint {}
|
|
@@ -855,7 +985,9 @@ declare module 'stripe' {
|
|
|
855
985
|
| 'eps'
|
|
856
986
|
| 'fpx'
|
|
857
987
|
| 'giropay'
|
|
988
|
+
| 'gopay'
|
|
858
989
|
| 'grabpay'
|
|
990
|
+
| 'id_bank_transfer'
|
|
859
991
|
| 'ideal'
|
|
860
992
|
| 'kakao_pay'
|
|
861
993
|
| 'klarna'
|
|
@@ -873,13 +1005,19 @@ declare module 'stripe' {
|
|
|
873
1005
|
| 'payco'
|
|
874
1006
|
| 'paynow'
|
|
875
1007
|
| 'paypal'
|
|
1008
|
+
| 'paypay'
|
|
1009
|
+
| 'payto'
|
|
876
1010
|
| 'pix'
|
|
877
1011
|
| 'promptpay'
|
|
1012
|
+
| 'qris'
|
|
1013
|
+
| 'rechnung'
|
|
878
1014
|
| 'revolut_pay'
|
|
879
1015
|
| 'samsung_pay'
|
|
880
1016
|
| 'satispay'
|
|
881
1017
|
| 'sepa_debit'
|
|
1018
|
+
| 'shopeepay'
|
|
882
1019
|
| 'sofort'
|
|
1020
|
+
| 'stripe_balance'
|
|
883
1021
|
| 'swish'
|
|
884
1022
|
| 'twint'
|
|
885
1023
|
| 'us_bank_account'
|
|
@@ -965,6 +1103,16 @@ declare module 'stripe' {
|
|
|
965
1103
|
*/
|
|
966
1104
|
paypal?: PaymentMethodOptions.Paypal;
|
|
967
1105
|
|
|
1106
|
+
/**
|
|
1107
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
1108
|
+
*/
|
|
1109
|
+
payto?: PaymentMethodOptions.Payto;
|
|
1110
|
+
|
|
1111
|
+
/**
|
|
1112
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
1113
|
+
*/
|
|
1114
|
+
pix?: PaymentMethodOptions.Pix;
|
|
1115
|
+
|
|
968
1116
|
/**
|
|
969
1117
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
970
1118
|
*/
|
|
@@ -1412,6 +1560,150 @@ declare module 'stripe' {
|
|
|
1412
1560
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
1413
1561
|
*/
|
|
1414
1562
|
billing_agreement_id?: string;
|
|
1563
|
+
|
|
1564
|
+
currency?: string;
|
|
1565
|
+
|
|
1566
|
+
/**
|
|
1567
|
+
* 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.
|
|
1568
|
+
*/
|
|
1569
|
+
subsellers?: Array<string>;
|
|
1570
|
+
}
|
|
1571
|
+
|
|
1572
|
+
interface Payto {
|
|
1573
|
+
/**
|
|
1574
|
+
* Additional fields for Mandate creation.
|
|
1575
|
+
*/
|
|
1576
|
+
mandate_options?: Payto.MandateOptions;
|
|
1577
|
+
}
|
|
1578
|
+
|
|
1579
|
+
namespace Payto {
|
|
1580
|
+
interface MandateOptions {
|
|
1581
|
+
/**
|
|
1582
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
1583
|
+
*/
|
|
1584
|
+
amount?: number;
|
|
1585
|
+
|
|
1586
|
+
/**
|
|
1587
|
+
* 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.
|
|
1588
|
+
*/
|
|
1589
|
+
amount_type?: MandateOptions.AmountType;
|
|
1590
|
+
|
|
1591
|
+
/**
|
|
1592
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
1593
|
+
*/
|
|
1594
|
+
end_date?: string;
|
|
1595
|
+
|
|
1596
|
+
/**
|
|
1597
|
+
* The periodicity at which payments will be collected.
|
|
1598
|
+
*/
|
|
1599
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1600
|
+
|
|
1601
|
+
/**
|
|
1602
|
+
* 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.
|
|
1603
|
+
*/
|
|
1604
|
+
payments_per_period?: number;
|
|
1605
|
+
|
|
1606
|
+
/**
|
|
1607
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
1608
|
+
*/
|
|
1609
|
+
purpose?: MandateOptions.Purpose;
|
|
1610
|
+
|
|
1611
|
+
/**
|
|
1612
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
1613
|
+
*/
|
|
1614
|
+
start_date?: string;
|
|
1615
|
+
}
|
|
1616
|
+
|
|
1617
|
+
namespace MandateOptions {
|
|
1618
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1619
|
+
|
|
1620
|
+
type PaymentSchedule =
|
|
1621
|
+
| 'adhoc'
|
|
1622
|
+
| 'annual'
|
|
1623
|
+
| 'daily'
|
|
1624
|
+
| 'fortnightly'
|
|
1625
|
+
| 'monthly'
|
|
1626
|
+
| 'quarterly'
|
|
1627
|
+
| 'semi_annual'
|
|
1628
|
+
| 'weekly';
|
|
1629
|
+
|
|
1630
|
+
type Purpose =
|
|
1631
|
+
| 'dependant_support'
|
|
1632
|
+
| 'government'
|
|
1633
|
+
| 'loan'
|
|
1634
|
+
| 'mortgage'
|
|
1635
|
+
| 'other'
|
|
1636
|
+
| 'pension'
|
|
1637
|
+
| 'personal'
|
|
1638
|
+
| 'retail'
|
|
1639
|
+
| 'salary'
|
|
1640
|
+
| 'tax'
|
|
1641
|
+
| 'utility';
|
|
1642
|
+
}
|
|
1643
|
+
}
|
|
1644
|
+
|
|
1645
|
+
interface Pix {
|
|
1646
|
+
/**
|
|
1647
|
+
* Additional fields for mandate creation.
|
|
1648
|
+
*/
|
|
1649
|
+
mandate_options?: Pix.MandateOptions;
|
|
1650
|
+
}
|
|
1651
|
+
|
|
1652
|
+
namespace Pix {
|
|
1653
|
+
interface MandateOptions {
|
|
1654
|
+
/**
|
|
1655
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
1656
|
+
*/
|
|
1657
|
+
amount?: number;
|
|
1658
|
+
|
|
1659
|
+
/**
|
|
1660
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
1661
|
+
*/
|
|
1662
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
1663
|
+
|
|
1664
|
+
/**
|
|
1665
|
+
* Type of amount. Defaults to `maximum`.
|
|
1666
|
+
*/
|
|
1667
|
+
amount_type?: MandateOptions.AmountType;
|
|
1668
|
+
|
|
1669
|
+
/**
|
|
1670
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
1671
|
+
*/
|
|
1672
|
+
currency?: string;
|
|
1673
|
+
|
|
1674
|
+
/**
|
|
1675
|
+
* 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.
|
|
1676
|
+
*/
|
|
1677
|
+
end_date?: string;
|
|
1678
|
+
|
|
1679
|
+
/**
|
|
1680
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
1681
|
+
*/
|
|
1682
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
1683
|
+
|
|
1684
|
+
/**
|
|
1685
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
1686
|
+
*/
|
|
1687
|
+
reference?: string;
|
|
1688
|
+
|
|
1689
|
+
/**
|
|
1690
|
+
* 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.
|
|
1691
|
+
*/
|
|
1692
|
+
start_date?: string;
|
|
1693
|
+
}
|
|
1694
|
+
|
|
1695
|
+
namespace MandateOptions {
|
|
1696
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
1697
|
+
|
|
1698
|
+
type AmountType = 'fixed' | 'maximum';
|
|
1699
|
+
|
|
1700
|
+
type PaymentSchedule =
|
|
1701
|
+
| 'halfyearly'
|
|
1702
|
+
| 'monthly'
|
|
1703
|
+
| 'quarterly'
|
|
1704
|
+
| 'weekly'
|
|
1705
|
+
| 'yearly';
|
|
1706
|
+
}
|
|
1415
1707
|
}
|
|
1416
1708
|
|
|
1417
1709
|
interface SepaDebit {
|
|
@@ -1459,6 +1751,11 @@ declare module 'stripe' {
|
|
|
1459
1751
|
*/
|
|
1460
1752
|
filters?: FinancialConnections.Filters;
|
|
1461
1753
|
|
|
1754
|
+
/**
|
|
1755
|
+
* Customize manual entry behavior
|
|
1756
|
+
*/
|
|
1757
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
1758
|
+
|
|
1462
1759
|
/**
|
|
1463
1760
|
* 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`.
|
|
1464
1761
|
*/
|
|
@@ -1481,19 +1778,39 @@ declare module 'stripe' {
|
|
|
1481
1778
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
1482
1779
|
*/
|
|
1483
1780
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
1781
|
+
|
|
1782
|
+
/**
|
|
1783
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
1784
|
+
*/
|
|
1785
|
+
institution?: string;
|
|
1484
1786
|
}
|
|
1485
1787
|
|
|
1486
1788
|
namespace Filters {
|
|
1487
1789
|
type AccountSubcategory = 'checking' | 'savings';
|
|
1488
1790
|
}
|
|
1489
1791
|
|
|
1792
|
+
interface ManualEntry {
|
|
1793
|
+
/**
|
|
1794
|
+
* Settings for configuring manual entry of account details.
|
|
1795
|
+
*/
|
|
1796
|
+
mode: ManualEntry.Mode;
|
|
1797
|
+
}
|
|
1798
|
+
|
|
1799
|
+
namespace ManualEntry {
|
|
1800
|
+
type Mode = 'automatic' | 'custom';
|
|
1801
|
+
}
|
|
1802
|
+
|
|
1490
1803
|
type Permission =
|
|
1491
1804
|
| 'balances'
|
|
1492
1805
|
| 'ownership'
|
|
1493
1806
|
| 'payment_method'
|
|
1494
1807
|
| 'transactions';
|
|
1495
1808
|
|
|
1496
|
-
type Prefetch =
|
|
1809
|
+
type Prefetch =
|
|
1810
|
+
| 'balances'
|
|
1811
|
+
| 'inferred_balances'
|
|
1812
|
+
| 'ownership'
|
|
1813
|
+
| 'transactions';
|
|
1497
1814
|
}
|
|
1498
1815
|
|
|
1499
1816
|
interface MandateOptions {
|
|
@@ -1518,6 +1835,31 @@ declare module 'stripe' {
|
|
|
1518
1835
|
}
|
|
1519
1836
|
}
|
|
1520
1837
|
|
|
1838
|
+
interface SetupDetails {
|
|
1839
|
+
/**
|
|
1840
|
+
* Benefit details for this SetupIntent
|
|
1841
|
+
*/
|
|
1842
|
+
benefit?: SetupDetails.Benefit;
|
|
1843
|
+
}
|
|
1844
|
+
|
|
1845
|
+
namespace SetupDetails {
|
|
1846
|
+
interface Benefit {
|
|
1847
|
+
/**
|
|
1848
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
1849
|
+
*/
|
|
1850
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
1851
|
+
}
|
|
1852
|
+
|
|
1853
|
+
namespace Benefit {
|
|
1854
|
+
interface FrMealVoucher {
|
|
1855
|
+
/**
|
|
1856
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
1857
|
+
*/
|
|
1858
|
+
siret: string;
|
|
1859
|
+
}
|
|
1860
|
+
}
|
|
1861
|
+
}
|
|
1862
|
+
|
|
1521
1863
|
interface SingleUse {
|
|
1522
1864
|
/**
|
|
1523
1865
|
* 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).
|
|
@@ -1560,6 +1902,13 @@ declare module 'stripe' {
|
|
|
1560
1902
|
*/
|
|
1561
1903
|
customer?: string;
|
|
1562
1904
|
|
|
1905
|
+
/**
|
|
1906
|
+
* ID of the Account this SetupIntent belongs to, if one exists.
|
|
1907
|
+
*
|
|
1908
|
+
* 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.
|
|
1909
|
+
*/
|
|
1910
|
+
customer_account?: string;
|
|
1911
|
+
|
|
1563
1912
|
/**
|
|
1564
1913
|
* An arbitrary string attached to the object. Often useful for displaying to users.
|
|
1565
1914
|
*/
|
|
@@ -1607,6 +1956,11 @@ declare module 'stripe' {
|
|
|
1607
1956
|
* 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).
|
|
1608
1957
|
*/
|
|
1609
1958
|
payment_method_types?: Array<string>;
|
|
1959
|
+
|
|
1960
|
+
/**
|
|
1961
|
+
* Provides industry-specific information about the SetupIntent.
|
|
1962
|
+
*/
|
|
1963
|
+
setup_details?: SetupIntentUpdateParams.SetupDetails;
|
|
1610
1964
|
}
|
|
1611
1965
|
|
|
1612
1966
|
namespace SetupIntentUpdateParams {
|
|
@@ -1713,11 +2067,21 @@ declare module 'stripe' {
|
|
|
1713
2067
|
*/
|
|
1714
2068
|
giropay?: PaymentMethodData.Giropay;
|
|
1715
2069
|
|
|
2070
|
+
/**
|
|
2071
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
2072
|
+
*/
|
|
2073
|
+
gopay?: PaymentMethodData.Gopay;
|
|
2074
|
+
|
|
1716
2075
|
/**
|
|
1717
2076
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
1718
2077
|
*/
|
|
1719
2078
|
grabpay?: PaymentMethodData.Grabpay;
|
|
1720
2079
|
|
|
2080
|
+
/**
|
|
2081
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
2082
|
+
*/
|
|
2083
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
2084
|
+
|
|
1721
2085
|
/**
|
|
1722
2086
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
1723
2087
|
*/
|
|
@@ -1813,6 +2177,16 @@ declare module 'stripe' {
|
|
|
1813
2177
|
*/
|
|
1814
2178
|
paypal?: PaymentMethodData.Paypal;
|
|
1815
2179
|
|
|
2180
|
+
/**
|
|
2181
|
+
* If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
|
|
2182
|
+
*/
|
|
2183
|
+
paypay?: PaymentMethodData.Paypay;
|
|
2184
|
+
|
|
2185
|
+
/**
|
|
2186
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
2187
|
+
*/
|
|
2188
|
+
payto?: PaymentMethodData.Payto;
|
|
2189
|
+
|
|
1816
2190
|
/**
|
|
1817
2191
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
1818
2192
|
*/
|
|
@@ -1823,11 +2197,21 @@ declare module 'stripe' {
|
|
|
1823
2197
|
*/
|
|
1824
2198
|
promptpay?: PaymentMethodData.Promptpay;
|
|
1825
2199
|
|
|
2200
|
+
/**
|
|
2201
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
2202
|
+
*/
|
|
2203
|
+
qris?: PaymentMethodData.Qris;
|
|
2204
|
+
|
|
1826
2205
|
/**
|
|
1827
2206
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
1828
2207
|
*/
|
|
1829
2208
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
1830
2209
|
|
|
2210
|
+
/**
|
|
2211
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
2212
|
+
*/
|
|
2213
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
2214
|
+
|
|
1831
2215
|
/**
|
|
1832
2216
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
1833
2217
|
*/
|
|
@@ -1848,11 +2232,21 @@ declare module 'stripe' {
|
|
|
1848
2232
|
*/
|
|
1849
2233
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
1850
2234
|
|
|
2235
|
+
/**
|
|
2236
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
2237
|
+
*/
|
|
2238
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
2239
|
+
|
|
1851
2240
|
/**
|
|
1852
2241
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
1853
2242
|
*/
|
|
1854
2243
|
sofort?: PaymentMethodData.Sofort;
|
|
1855
2244
|
|
|
2245
|
+
/**
|
|
2246
|
+
* This hash contains details about the Stripe balance payment method.
|
|
2247
|
+
*/
|
|
2248
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
2249
|
+
|
|
1856
2250
|
/**
|
|
1857
2251
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
1858
2252
|
*/
|
|
@@ -2065,8 +2459,21 @@ declare module 'stripe' {
|
|
|
2065
2459
|
|
|
2066
2460
|
interface Giropay {}
|
|
2067
2461
|
|
|
2462
|
+
interface Gopay {}
|
|
2463
|
+
|
|
2068
2464
|
interface Grabpay {}
|
|
2069
2465
|
|
|
2466
|
+
interface IdBankTransfer {
|
|
2467
|
+
/**
|
|
2468
|
+
* Bank where the account is held.
|
|
2469
|
+
*/
|
|
2470
|
+
bank?: IdBankTransfer.Bank;
|
|
2471
|
+
}
|
|
2472
|
+
|
|
2473
|
+
namespace IdBankTransfer {
|
|
2474
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
2475
|
+
}
|
|
2476
|
+
|
|
2070
2477
|
interface Ideal {
|
|
2071
2478
|
/**
|
|
2072
2479
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -2224,10 +2631,31 @@ declare module 'stripe' {
|
|
|
2224
2631
|
|
|
2225
2632
|
interface Paypal {}
|
|
2226
2633
|
|
|
2634
|
+
interface Paypay {}
|
|
2635
|
+
|
|
2636
|
+
interface Payto {
|
|
2637
|
+
/**
|
|
2638
|
+
* The account number for the bank account.
|
|
2639
|
+
*/
|
|
2640
|
+
account_number?: string;
|
|
2641
|
+
|
|
2642
|
+
/**
|
|
2643
|
+
* Bank-State-Branch number of the bank account.
|
|
2644
|
+
*/
|
|
2645
|
+
bsb_number?: string;
|
|
2646
|
+
|
|
2647
|
+
/**
|
|
2648
|
+
* The PayID alias for the bank account.
|
|
2649
|
+
*/
|
|
2650
|
+
pay_id?: string;
|
|
2651
|
+
}
|
|
2652
|
+
|
|
2227
2653
|
interface Pix {}
|
|
2228
2654
|
|
|
2229
2655
|
interface Promptpay {}
|
|
2230
2656
|
|
|
2657
|
+
interface Qris {}
|
|
2658
|
+
|
|
2231
2659
|
interface RadarOptions {
|
|
2232
2660
|
/**
|
|
2233
2661
|
* 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.
|
|
@@ -2235,7 +2663,33 @@ declare module 'stripe' {
|
|
|
2235
2663
|
session?: string;
|
|
2236
2664
|
}
|
|
2237
2665
|
|
|
2238
|
-
interface
|
|
2666
|
+
interface Rechnung {
|
|
2667
|
+
/**
|
|
2668
|
+
* Customer's date of birth
|
|
2669
|
+
*/
|
|
2670
|
+
dob: Rechnung.Dob;
|
|
2671
|
+
}
|
|
2672
|
+
|
|
2673
|
+
namespace Rechnung {
|
|
2674
|
+
interface Dob {
|
|
2675
|
+
/**
|
|
2676
|
+
* The day of birth, between 1 and 31.
|
|
2677
|
+
*/
|
|
2678
|
+
day: number;
|
|
2679
|
+
|
|
2680
|
+
/**
|
|
2681
|
+
* The month of birth, between 1 and 12.
|
|
2682
|
+
*/
|
|
2683
|
+
month: number;
|
|
2684
|
+
|
|
2685
|
+
/**
|
|
2686
|
+
* The four-digit year of birth.
|
|
2687
|
+
*/
|
|
2688
|
+
year: number;
|
|
2689
|
+
}
|
|
2690
|
+
}
|
|
2691
|
+
|
|
2692
|
+
interface RevolutPay {}
|
|
2239
2693
|
|
|
2240
2694
|
interface SamsungPay {}
|
|
2241
2695
|
|
|
@@ -2248,6 +2702,8 @@ declare module 'stripe' {
|
|
|
2248
2702
|
iban: string;
|
|
2249
2703
|
}
|
|
2250
2704
|
|
|
2705
|
+
interface Shopeepay {}
|
|
2706
|
+
|
|
2251
2707
|
interface Sofort {
|
|
2252
2708
|
/**
|
|
2253
2709
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -2259,6 +2715,22 @@ declare module 'stripe' {
|
|
|
2259
2715
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
2260
2716
|
}
|
|
2261
2717
|
|
|
2718
|
+
interface StripeBalance {
|
|
2719
|
+
/**
|
|
2720
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
2721
|
+
*/
|
|
2722
|
+
account?: string;
|
|
2723
|
+
|
|
2724
|
+
/**
|
|
2725
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
2726
|
+
*/
|
|
2727
|
+
source_type?: StripeBalance.SourceType;
|
|
2728
|
+
}
|
|
2729
|
+
|
|
2730
|
+
namespace StripeBalance {
|
|
2731
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
2732
|
+
}
|
|
2733
|
+
|
|
2262
2734
|
interface Swish {}
|
|
2263
2735
|
|
|
2264
2736
|
interface Twint {}
|
|
@@ -2282,7 +2754,9 @@ declare module 'stripe' {
|
|
|
2282
2754
|
| 'eps'
|
|
2283
2755
|
| 'fpx'
|
|
2284
2756
|
| 'giropay'
|
|
2757
|
+
| 'gopay'
|
|
2285
2758
|
| 'grabpay'
|
|
2759
|
+
| 'id_bank_transfer'
|
|
2286
2760
|
| 'ideal'
|
|
2287
2761
|
| 'kakao_pay'
|
|
2288
2762
|
| 'klarna'
|
|
@@ -2300,13 +2774,19 @@ declare module 'stripe' {
|
|
|
2300
2774
|
| 'payco'
|
|
2301
2775
|
| 'paynow'
|
|
2302
2776
|
| 'paypal'
|
|
2777
|
+
| 'paypay'
|
|
2778
|
+
| 'payto'
|
|
2303
2779
|
| 'pix'
|
|
2304
2780
|
| 'promptpay'
|
|
2781
|
+
| 'qris'
|
|
2782
|
+
| 'rechnung'
|
|
2305
2783
|
| 'revolut_pay'
|
|
2306
2784
|
| 'samsung_pay'
|
|
2307
2785
|
| 'satispay'
|
|
2308
2786
|
| 'sepa_debit'
|
|
2787
|
+
| 'shopeepay'
|
|
2309
2788
|
| 'sofort'
|
|
2789
|
+
| 'stripe_balance'
|
|
2310
2790
|
| 'swish'
|
|
2311
2791
|
| 'twint'
|
|
2312
2792
|
| 'us_bank_account'
|
|
@@ -2392,6 +2872,16 @@ declare module 'stripe' {
|
|
|
2392
2872
|
*/
|
|
2393
2873
|
paypal?: PaymentMethodOptions.Paypal;
|
|
2394
2874
|
|
|
2875
|
+
/**
|
|
2876
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
2877
|
+
*/
|
|
2878
|
+
payto?: PaymentMethodOptions.Payto;
|
|
2879
|
+
|
|
2880
|
+
/**
|
|
2881
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
2882
|
+
*/
|
|
2883
|
+
pix?: PaymentMethodOptions.Pix;
|
|
2884
|
+
|
|
2395
2885
|
/**
|
|
2396
2886
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
2397
2887
|
*/
|
|
@@ -2839,6 +3329,150 @@ declare module 'stripe' {
|
|
|
2839
3329
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
2840
3330
|
*/
|
|
2841
3331
|
billing_agreement_id?: string;
|
|
3332
|
+
|
|
3333
|
+
currency?: string;
|
|
3334
|
+
|
|
3335
|
+
/**
|
|
3336
|
+
* 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.
|
|
3337
|
+
*/
|
|
3338
|
+
subsellers?: Array<string>;
|
|
3339
|
+
}
|
|
3340
|
+
|
|
3341
|
+
interface Payto {
|
|
3342
|
+
/**
|
|
3343
|
+
* Additional fields for Mandate creation.
|
|
3344
|
+
*/
|
|
3345
|
+
mandate_options?: Payto.MandateOptions;
|
|
3346
|
+
}
|
|
3347
|
+
|
|
3348
|
+
namespace Payto {
|
|
3349
|
+
interface MandateOptions {
|
|
3350
|
+
/**
|
|
3351
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
3352
|
+
*/
|
|
3353
|
+
amount?: number;
|
|
3354
|
+
|
|
3355
|
+
/**
|
|
3356
|
+
* 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.
|
|
3357
|
+
*/
|
|
3358
|
+
amount_type?: MandateOptions.AmountType;
|
|
3359
|
+
|
|
3360
|
+
/**
|
|
3361
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
3362
|
+
*/
|
|
3363
|
+
end_date?: string;
|
|
3364
|
+
|
|
3365
|
+
/**
|
|
3366
|
+
* The periodicity at which payments will be collected.
|
|
3367
|
+
*/
|
|
3368
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
3369
|
+
|
|
3370
|
+
/**
|
|
3371
|
+
* 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.
|
|
3372
|
+
*/
|
|
3373
|
+
payments_per_period?: number;
|
|
3374
|
+
|
|
3375
|
+
/**
|
|
3376
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
3377
|
+
*/
|
|
3378
|
+
purpose?: MandateOptions.Purpose;
|
|
3379
|
+
|
|
3380
|
+
/**
|
|
3381
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
3382
|
+
*/
|
|
3383
|
+
start_date?: string;
|
|
3384
|
+
}
|
|
3385
|
+
|
|
3386
|
+
namespace MandateOptions {
|
|
3387
|
+
type AmountType = 'fixed' | 'maximum';
|
|
3388
|
+
|
|
3389
|
+
type PaymentSchedule =
|
|
3390
|
+
| 'adhoc'
|
|
3391
|
+
| 'annual'
|
|
3392
|
+
| 'daily'
|
|
3393
|
+
| 'fortnightly'
|
|
3394
|
+
| 'monthly'
|
|
3395
|
+
| 'quarterly'
|
|
3396
|
+
| 'semi_annual'
|
|
3397
|
+
| 'weekly';
|
|
3398
|
+
|
|
3399
|
+
type Purpose =
|
|
3400
|
+
| 'dependant_support'
|
|
3401
|
+
| 'government'
|
|
3402
|
+
| 'loan'
|
|
3403
|
+
| 'mortgage'
|
|
3404
|
+
| 'other'
|
|
3405
|
+
| 'pension'
|
|
3406
|
+
| 'personal'
|
|
3407
|
+
| 'retail'
|
|
3408
|
+
| 'salary'
|
|
3409
|
+
| 'tax'
|
|
3410
|
+
| 'utility';
|
|
3411
|
+
}
|
|
3412
|
+
}
|
|
3413
|
+
|
|
3414
|
+
interface Pix {
|
|
3415
|
+
/**
|
|
3416
|
+
* Additional fields for mandate creation.
|
|
3417
|
+
*/
|
|
3418
|
+
mandate_options?: Pix.MandateOptions;
|
|
3419
|
+
}
|
|
3420
|
+
|
|
3421
|
+
namespace Pix {
|
|
3422
|
+
interface MandateOptions {
|
|
3423
|
+
/**
|
|
3424
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
3425
|
+
*/
|
|
3426
|
+
amount?: number;
|
|
3427
|
+
|
|
3428
|
+
/**
|
|
3429
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
3430
|
+
*/
|
|
3431
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
3432
|
+
|
|
3433
|
+
/**
|
|
3434
|
+
* Type of amount. Defaults to `maximum`.
|
|
3435
|
+
*/
|
|
3436
|
+
amount_type?: MandateOptions.AmountType;
|
|
3437
|
+
|
|
3438
|
+
/**
|
|
3439
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
3440
|
+
*/
|
|
3441
|
+
currency?: string;
|
|
3442
|
+
|
|
3443
|
+
/**
|
|
3444
|
+
* 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.
|
|
3445
|
+
*/
|
|
3446
|
+
end_date?: string;
|
|
3447
|
+
|
|
3448
|
+
/**
|
|
3449
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
3450
|
+
*/
|
|
3451
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
3452
|
+
|
|
3453
|
+
/**
|
|
3454
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
3455
|
+
*/
|
|
3456
|
+
reference?: string;
|
|
3457
|
+
|
|
3458
|
+
/**
|
|
3459
|
+
* 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.
|
|
3460
|
+
*/
|
|
3461
|
+
start_date?: string;
|
|
3462
|
+
}
|
|
3463
|
+
|
|
3464
|
+
namespace MandateOptions {
|
|
3465
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
3466
|
+
|
|
3467
|
+
type AmountType = 'fixed' | 'maximum';
|
|
3468
|
+
|
|
3469
|
+
type PaymentSchedule =
|
|
3470
|
+
| 'halfyearly'
|
|
3471
|
+
| 'monthly'
|
|
3472
|
+
| 'quarterly'
|
|
3473
|
+
| 'weekly'
|
|
3474
|
+
| 'yearly';
|
|
3475
|
+
}
|
|
2842
3476
|
}
|
|
2843
3477
|
|
|
2844
3478
|
interface SepaDebit {
|
|
@@ -2886,6 +3520,11 @@ declare module 'stripe' {
|
|
|
2886
3520
|
*/
|
|
2887
3521
|
filters?: FinancialConnections.Filters;
|
|
2888
3522
|
|
|
3523
|
+
/**
|
|
3524
|
+
* Customize manual entry behavior
|
|
3525
|
+
*/
|
|
3526
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
3527
|
+
|
|
2889
3528
|
/**
|
|
2890
3529
|
* 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`.
|
|
2891
3530
|
*/
|
|
@@ -2908,19 +3547,39 @@ declare module 'stripe' {
|
|
|
2908
3547
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
2909
3548
|
*/
|
|
2910
3549
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
3550
|
+
|
|
3551
|
+
/**
|
|
3552
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
3553
|
+
*/
|
|
3554
|
+
institution?: string;
|
|
2911
3555
|
}
|
|
2912
3556
|
|
|
2913
3557
|
namespace Filters {
|
|
2914
3558
|
type AccountSubcategory = 'checking' | 'savings';
|
|
2915
3559
|
}
|
|
2916
3560
|
|
|
3561
|
+
interface ManualEntry {
|
|
3562
|
+
/**
|
|
3563
|
+
* Settings for configuring manual entry of account details.
|
|
3564
|
+
*/
|
|
3565
|
+
mode: ManualEntry.Mode;
|
|
3566
|
+
}
|
|
3567
|
+
|
|
3568
|
+
namespace ManualEntry {
|
|
3569
|
+
type Mode = 'automatic' | 'custom';
|
|
3570
|
+
}
|
|
3571
|
+
|
|
2917
3572
|
type Permission =
|
|
2918
3573
|
| 'balances'
|
|
2919
3574
|
| 'ownership'
|
|
2920
3575
|
| 'payment_method'
|
|
2921
3576
|
| 'transactions';
|
|
2922
3577
|
|
|
2923
|
-
type Prefetch =
|
|
3578
|
+
type Prefetch =
|
|
3579
|
+
| 'balances'
|
|
3580
|
+
| 'inferred_balances'
|
|
3581
|
+
| 'ownership'
|
|
3582
|
+
| 'transactions';
|
|
2924
3583
|
}
|
|
2925
3584
|
|
|
2926
3585
|
interface MandateOptions {
|
|
@@ -2944,6 +3603,31 @@ declare module 'stripe' {
|
|
|
2944
3603
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
2945
3604
|
}
|
|
2946
3605
|
}
|
|
3606
|
+
|
|
3607
|
+
interface SetupDetails {
|
|
3608
|
+
/**
|
|
3609
|
+
* Benefit details for this SetupIntent
|
|
3610
|
+
*/
|
|
3611
|
+
benefit?: SetupDetails.Benefit;
|
|
3612
|
+
}
|
|
3613
|
+
|
|
3614
|
+
namespace SetupDetails {
|
|
3615
|
+
interface Benefit {
|
|
3616
|
+
/**
|
|
3617
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
3618
|
+
*/
|
|
3619
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
3620
|
+
}
|
|
3621
|
+
|
|
3622
|
+
namespace Benefit {
|
|
3623
|
+
interface FrMealVoucher {
|
|
3624
|
+
/**
|
|
3625
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
3626
|
+
*/
|
|
3627
|
+
siret: string;
|
|
3628
|
+
}
|
|
3629
|
+
}
|
|
3630
|
+
}
|
|
2947
3631
|
}
|
|
2948
3632
|
|
|
2949
3633
|
interface SetupIntentListParams extends PaginationParams {
|
|
@@ -2964,6 +3648,11 @@ declare module 'stripe' {
|
|
|
2964
3648
|
*/
|
|
2965
3649
|
customer?: string;
|
|
2966
3650
|
|
|
3651
|
+
/**
|
|
3652
|
+
* Only return SetupIntents for the account specified by this customer ID.
|
|
3653
|
+
*/
|
|
3654
|
+
customer_account?: string;
|
|
3655
|
+
|
|
2967
3656
|
/**
|
|
2968
3657
|
* Specifies which fields in the response should be expanded.
|
|
2969
3658
|
*/
|
|
@@ -3032,6 +3721,11 @@ declare module 'stripe' {
|
|
|
3032
3721
|
*/
|
|
3033
3722
|
return_url?: string;
|
|
3034
3723
|
|
|
3724
|
+
/**
|
|
3725
|
+
* Provides industry-specific information about the SetupIntent.
|
|
3726
|
+
*/
|
|
3727
|
+
setup_details?: SetupIntentConfirmParams.SetupDetails;
|
|
3728
|
+
|
|
3035
3729
|
/**
|
|
3036
3730
|
* Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
|
|
3037
3731
|
*/
|
|
@@ -3189,11 +3883,21 @@ declare module 'stripe' {
|
|
|
3189
3883
|
*/
|
|
3190
3884
|
giropay?: PaymentMethodData.Giropay;
|
|
3191
3885
|
|
|
3886
|
+
/**
|
|
3887
|
+
* If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
|
|
3888
|
+
*/
|
|
3889
|
+
gopay?: PaymentMethodData.Gopay;
|
|
3890
|
+
|
|
3192
3891
|
/**
|
|
3193
3892
|
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
|
|
3194
3893
|
*/
|
|
3195
3894
|
grabpay?: PaymentMethodData.Grabpay;
|
|
3196
3895
|
|
|
3896
|
+
/**
|
|
3897
|
+
* If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
|
|
3898
|
+
*/
|
|
3899
|
+
id_bank_transfer?: PaymentMethodData.IdBankTransfer;
|
|
3900
|
+
|
|
3197
3901
|
/**
|
|
3198
3902
|
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
|
|
3199
3903
|
*/
|
|
@@ -3289,6 +3993,16 @@ declare module 'stripe' {
|
|
|
3289
3993
|
*/
|
|
3290
3994
|
paypal?: PaymentMethodData.Paypal;
|
|
3291
3995
|
|
|
3996
|
+
/**
|
|
3997
|
+
* If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
|
|
3998
|
+
*/
|
|
3999
|
+
paypay?: PaymentMethodData.Paypay;
|
|
4000
|
+
|
|
4001
|
+
/**
|
|
4002
|
+
* If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
|
|
4003
|
+
*/
|
|
4004
|
+
payto?: PaymentMethodData.Payto;
|
|
4005
|
+
|
|
3292
4006
|
/**
|
|
3293
4007
|
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
|
|
3294
4008
|
*/
|
|
@@ -3299,11 +4013,21 @@ declare module 'stripe' {
|
|
|
3299
4013
|
*/
|
|
3300
4014
|
promptpay?: PaymentMethodData.Promptpay;
|
|
3301
4015
|
|
|
4016
|
+
/**
|
|
4017
|
+
* If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
|
|
4018
|
+
*/
|
|
4019
|
+
qris?: PaymentMethodData.Qris;
|
|
4020
|
+
|
|
3302
4021
|
/**
|
|
3303
4022
|
* Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
|
|
3304
4023
|
*/
|
|
3305
4024
|
radar_options?: PaymentMethodData.RadarOptions;
|
|
3306
4025
|
|
|
4026
|
+
/**
|
|
4027
|
+
* If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
|
|
4028
|
+
*/
|
|
4029
|
+
rechnung?: PaymentMethodData.Rechnung;
|
|
4030
|
+
|
|
3307
4031
|
/**
|
|
3308
4032
|
* If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
|
|
3309
4033
|
*/
|
|
@@ -3324,11 +4048,21 @@ declare module 'stripe' {
|
|
|
3324
4048
|
*/
|
|
3325
4049
|
sepa_debit?: PaymentMethodData.SepaDebit;
|
|
3326
4050
|
|
|
4051
|
+
/**
|
|
4052
|
+
* If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
|
|
4053
|
+
*/
|
|
4054
|
+
shopeepay?: PaymentMethodData.Shopeepay;
|
|
4055
|
+
|
|
3327
4056
|
/**
|
|
3328
4057
|
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
|
|
3329
4058
|
*/
|
|
3330
4059
|
sofort?: PaymentMethodData.Sofort;
|
|
3331
4060
|
|
|
4061
|
+
/**
|
|
4062
|
+
* This hash contains details about the Stripe balance payment method.
|
|
4063
|
+
*/
|
|
4064
|
+
stripe_balance?: PaymentMethodData.StripeBalance;
|
|
4065
|
+
|
|
3332
4066
|
/**
|
|
3333
4067
|
* If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
|
|
3334
4068
|
*/
|
|
@@ -3541,8 +4275,21 @@ declare module 'stripe' {
|
|
|
3541
4275
|
|
|
3542
4276
|
interface Giropay {}
|
|
3543
4277
|
|
|
4278
|
+
interface Gopay {}
|
|
4279
|
+
|
|
3544
4280
|
interface Grabpay {}
|
|
3545
4281
|
|
|
4282
|
+
interface IdBankTransfer {
|
|
4283
|
+
/**
|
|
4284
|
+
* Bank where the account is held.
|
|
4285
|
+
*/
|
|
4286
|
+
bank?: IdBankTransfer.Bank;
|
|
4287
|
+
}
|
|
4288
|
+
|
|
4289
|
+
namespace IdBankTransfer {
|
|
4290
|
+
type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
|
|
4291
|
+
}
|
|
4292
|
+
|
|
3546
4293
|
interface Ideal {
|
|
3547
4294
|
/**
|
|
3548
4295
|
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
@@ -3700,10 +4447,31 @@ declare module 'stripe' {
|
|
|
3700
4447
|
|
|
3701
4448
|
interface Paypal {}
|
|
3702
4449
|
|
|
4450
|
+
interface Paypay {}
|
|
4451
|
+
|
|
4452
|
+
interface Payto {
|
|
4453
|
+
/**
|
|
4454
|
+
* The account number for the bank account.
|
|
4455
|
+
*/
|
|
4456
|
+
account_number?: string;
|
|
4457
|
+
|
|
4458
|
+
/**
|
|
4459
|
+
* Bank-State-Branch number of the bank account.
|
|
4460
|
+
*/
|
|
4461
|
+
bsb_number?: string;
|
|
4462
|
+
|
|
4463
|
+
/**
|
|
4464
|
+
* The PayID alias for the bank account.
|
|
4465
|
+
*/
|
|
4466
|
+
pay_id?: string;
|
|
4467
|
+
}
|
|
4468
|
+
|
|
3703
4469
|
interface Pix {}
|
|
3704
4470
|
|
|
3705
4471
|
interface Promptpay {}
|
|
3706
4472
|
|
|
4473
|
+
interface Qris {}
|
|
4474
|
+
|
|
3707
4475
|
interface RadarOptions {
|
|
3708
4476
|
/**
|
|
3709
4477
|
* 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.
|
|
@@ -3711,6 +4479,32 @@ declare module 'stripe' {
|
|
|
3711
4479
|
session?: string;
|
|
3712
4480
|
}
|
|
3713
4481
|
|
|
4482
|
+
interface Rechnung {
|
|
4483
|
+
/**
|
|
4484
|
+
* Customer's date of birth
|
|
4485
|
+
*/
|
|
4486
|
+
dob: Rechnung.Dob;
|
|
4487
|
+
}
|
|
4488
|
+
|
|
4489
|
+
namespace Rechnung {
|
|
4490
|
+
interface Dob {
|
|
4491
|
+
/**
|
|
4492
|
+
* The day of birth, between 1 and 31.
|
|
4493
|
+
*/
|
|
4494
|
+
day: number;
|
|
4495
|
+
|
|
4496
|
+
/**
|
|
4497
|
+
* The month of birth, between 1 and 12.
|
|
4498
|
+
*/
|
|
4499
|
+
month: number;
|
|
4500
|
+
|
|
4501
|
+
/**
|
|
4502
|
+
* The four-digit year of birth.
|
|
4503
|
+
*/
|
|
4504
|
+
year: number;
|
|
4505
|
+
}
|
|
4506
|
+
}
|
|
4507
|
+
|
|
3714
4508
|
interface RevolutPay {}
|
|
3715
4509
|
|
|
3716
4510
|
interface SamsungPay {}
|
|
@@ -3724,6 +4518,8 @@ declare module 'stripe' {
|
|
|
3724
4518
|
iban: string;
|
|
3725
4519
|
}
|
|
3726
4520
|
|
|
4521
|
+
interface Shopeepay {}
|
|
4522
|
+
|
|
3727
4523
|
interface Sofort {
|
|
3728
4524
|
/**
|
|
3729
4525
|
* Two-letter ISO code representing the country the bank account is located in.
|
|
@@ -3735,6 +4531,22 @@ declare module 'stripe' {
|
|
|
3735
4531
|
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
|
|
3736
4532
|
}
|
|
3737
4533
|
|
|
4534
|
+
interface StripeBalance {
|
|
4535
|
+
/**
|
|
4536
|
+
* The connected account ID whose Stripe balance to use as the source of payment
|
|
4537
|
+
*/
|
|
4538
|
+
account?: string;
|
|
4539
|
+
|
|
4540
|
+
/**
|
|
4541
|
+
* The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
|
|
4542
|
+
*/
|
|
4543
|
+
source_type?: StripeBalance.SourceType;
|
|
4544
|
+
}
|
|
4545
|
+
|
|
4546
|
+
namespace StripeBalance {
|
|
4547
|
+
type SourceType = 'bank_account' | 'card' | 'fpx';
|
|
4548
|
+
}
|
|
4549
|
+
|
|
3738
4550
|
interface Swish {}
|
|
3739
4551
|
|
|
3740
4552
|
interface Twint {}
|
|
@@ -3758,7 +4570,9 @@ declare module 'stripe' {
|
|
|
3758
4570
|
| 'eps'
|
|
3759
4571
|
| 'fpx'
|
|
3760
4572
|
| 'giropay'
|
|
4573
|
+
| 'gopay'
|
|
3761
4574
|
| 'grabpay'
|
|
4575
|
+
| 'id_bank_transfer'
|
|
3762
4576
|
| 'ideal'
|
|
3763
4577
|
| 'kakao_pay'
|
|
3764
4578
|
| 'klarna'
|
|
@@ -3776,13 +4590,19 @@ declare module 'stripe' {
|
|
|
3776
4590
|
| 'payco'
|
|
3777
4591
|
| 'paynow'
|
|
3778
4592
|
| 'paypal'
|
|
4593
|
+
| 'paypay'
|
|
4594
|
+
| 'payto'
|
|
3779
4595
|
| 'pix'
|
|
3780
4596
|
| 'promptpay'
|
|
4597
|
+
| 'qris'
|
|
4598
|
+
| 'rechnung'
|
|
3781
4599
|
| 'revolut_pay'
|
|
3782
4600
|
| 'samsung_pay'
|
|
3783
4601
|
| 'satispay'
|
|
3784
4602
|
| 'sepa_debit'
|
|
4603
|
+
| 'shopeepay'
|
|
3785
4604
|
| 'sofort'
|
|
4605
|
+
| 'stripe_balance'
|
|
3786
4606
|
| 'swish'
|
|
3787
4607
|
| 'twint'
|
|
3788
4608
|
| 'us_bank_account'
|
|
@@ -3868,6 +4688,16 @@ declare module 'stripe' {
|
|
|
3868
4688
|
*/
|
|
3869
4689
|
paypal?: PaymentMethodOptions.Paypal;
|
|
3870
4690
|
|
|
4691
|
+
/**
|
|
4692
|
+
* If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
|
|
4693
|
+
*/
|
|
4694
|
+
payto?: PaymentMethodOptions.Payto;
|
|
4695
|
+
|
|
4696
|
+
/**
|
|
4697
|
+
* If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
|
|
4698
|
+
*/
|
|
4699
|
+
pix?: PaymentMethodOptions.Pix;
|
|
4700
|
+
|
|
3871
4701
|
/**
|
|
3872
4702
|
* If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
|
|
3873
4703
|
*/
|
|
@@ -4315,6 +5145,150 @@ declare module 'stripe' {
|
|
|
4315
5145
|
* The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
|
|
4316
5146
|
*/
|
|
4317
5147
|
billing_agreement_id?: string;
|
|
5148
|
+
|
|
5149
|
+
currency?: string;
|
|
5150
|
+
|
|
5151
|
+
/**
|
|
5152
|
+
* 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.
|
|
5153
|
+
*/
|
|
5154
|
+
subsellers?: Array<string>;
|
|
5155
|
+
}
|
|
5156
|
+
|
|
5157
|
+
interface Payto {
|
|
5158
|
+
/**
|
|
5159
|
+
* Additional fields for Mandate creation.
|
|
5160
|
+
*/
|
|
5161
|
+
mandate_options?: Payto.MandateOptions;
|
|
5162
|
+
}
|
|
5163
|
+
|
|
5164
|
+
namespace Payto {
|
|
5165
|
+
interface MandateOptions {
|
|
5166
|
+
/**
|
|
5167
|
+
* Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
5168
|
+
*/
|
|
5169
|
+
amount?: number;
|
|
5170
|
+
|
|
5171
|
+
/**
|
|
5172
|
+
* 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.
|
|
5173
|
+
*/
|
|
5174
|
+
amount_type?: MandateOptions.AmountType;
|
|
5175
|
+
|
|
5176
|
+
/**
|
|
5177
|
+
* Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
5178
|
+
*/
|
|
5179
|
+
end_date?: string;
|
|
5180
|
+
|
|
5181
|
+
/**
|
|
5182
|
+
* The periodicity at which payments will be collected.
|
|
5183
|
+
*/
|
|
5184
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
5185
|
+
|
|
5186
|
+
/**
|
|
5187
|
+
* 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.
|
|
5188
|
+
*/
|
|
5189
|
+
payments_per_period?: number;
|
|
5190
|
+
|
|
5191
|
+
/**
|
|
5192
|
+
* The purpose for which payments are made. Defaults to retail.
|
|
5193
|
+
*/
|
|
5194
|
+
purpose?: MandateOptions.Purpose;
|
|
5195
|
+
|
|
5196
|
+
/**
|
|
5197
|
+
* Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
5198
|
+
*/
|
|
5199
|
+
start_date?: string;
|
|
5200
|
+
}
|
|
5201
|
+
|
|
5202
|
+
namespace MandateOptions {
|
|
5203
|
+
type AmountType = 'fixed' | 'maximum';
|
|
5204
|
+
|
|
5205
|
+
type PaymentSchedule =
|
|
5206
|
+
| 'adhoc'
|
|
5207
|
+
| 'annual'
|
|
5208
|
+
| 'daily'
|
|
5209
|
+
| 'fortnightly'
|
|
5210
|
+
| 'monthly'
|
|
5211
|
+
| 'quarterly'
|
|
5212
|
+
| 'semi_annual'
|
|
5213
|
+
| 'weekly';
|
|
5214
|
+
|
|
5215
|
+
type Purpose =
|
|
5216
|
+
| 'dependant_support'
|
|
5217
|
+
| 'government'
|
|
5218
|
+
| 'loan'
|
|
5219
|
+
| 'mortgage'
|
|
5220
|
+
| 'other'
|
|
5221
|
+
| 'pension'
|
|
5222
|
+
| 'personal'
|
|
5223
|
+
| 'retail'
|
|
5224
|
+
| 'salary'
|
|
5225
|
+
| 'tax'
|
|
5226
|
+
| 'utility';
|
|
5227
|
+
}
|
|
5228
|
+
}
|
|
5229
|
+
|
|
5230
|
+
interface Pix {
|
|
5231
|
+
/**
|
|
5232
|
+
* Additional fields for mandate creation.
|
|
5233
|
+
*/
|
|
5234
|
+
mandate_options?: Pix.MandateOptions;
|
|
5235
|
+
}
|
|
5236
|
+
|
|
5237
|
+
namespace Pix {
|
|
5238
|
+
interface MandateOptions {
|
|
5239
|
+
/**
|
|
5240
|
+
* Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
|
|
5241
|
+
*/
|
|
5242
|
+
amount?: number;
|
|
5243
|
+
|
|
5244
|
+
/**
|
|
5245
|
+
* Determines if the amount includes the IOF tax. Defaults to `never`.
|
|
5246
|
+
*/
|
|
5247
|
+
amount_includes_iof?: MandateOptions.AmountIncludesIof;
|
|
5248
|
+
|
|
5249
|
+
/**
|
|
5250
|
+
* Type of amount. Defaults to `maximum`.
|
|
5251
|
+
*/
|
|
5252
|
+
amount_type?: MandateOptions.AmountType;
|
|
5253
|
+
|
|
5254
|
+
/**
|
|
5255
|
+
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
|
|
5256
|
+
*/
|
|
5257
|
+
currency?: string;
|
|
5258
|
+
|
|
5259
|
+
/**
|
|
5260
|
+
* 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.
|
|
5261
|
+
*/
|
|
5262
|
+
end_date?: string;
|
|
5263
|
+
|
|
5264
|
+
/**
|
|
5265
|
+
* Schedule at which the future payments will be charged. Defaults to `weekly`.
|
|
5266
|
+
*/
|
|
5267
|
+
payment_schedule?: MandateOptions.PaymentSchedule;
|
|
5268
|
+
|
|
5269
|
+
/**
|
|
5270
|
+
* Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
|
|
5271
|
+
*/
|
|
5272
|
+
reference?: string;
|
|
5273
|
+
|
|
5274
|
+
/**
|
|
5275
|
+
* 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.
|
|
5276
|
+
*/
|
|
5277
|
+
start_date?: string;
|
|
5278
|
+
}
|
|
5279
|
+
|
|
5280
|
+
namespace MandateOptions {
|
|
5281
|
+
type AmountIncludesIof = 'always' | 'never';
|
|
5282
|
+
|
|
5283
|
+
type AmountType = 'fixed' | 'maximum';
|
|
5284
|
+
|
|
5285
|
+
type PaymentSchedule =
|
|
5286
|
+
| 'halfyearly'
|
|
5287
|
+
| 'monthly'
|
|
5288
|
+
| 'quarterly'
|
|
5289
|
+
| 'weekly'
|
|
5290
|
+
| 'yearly';
|
|
5291
|
+
}
|
|
4318
5292
|
}
|
|
4319
5293
|
|
|
4320
5294
|
interface SepaDebit {
|
|
@@ -4362,6 +5336,11 @@ declare module 'stripe' {
|
|
|
4362
5336
|
*/
|
|
4363
5337
|
filters?: FinancialConnections.Filters;
|
|
4364
5338
|
|
|
5339
|
+
/**
|
|
5340
|
+
* Customize manual entry behavior
|
|
5341
|
+
*/
|
|
5342
|
+
manual_entry?: FinancialConnections.ManualEntry;
|
|
5343
|
+
|
|
4365
5344
|
/**
|
|
4366
5345
|
* 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`.
|
|
4367
5346
|
*/
|
|
@@ -4384,19 +5363,39 @@ declare module 'stripe' {
|
|
|
4384
5363
|
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
|
4385
5364
|
*/
|
|
4386
5365
|
account_subcategories?: Array<Filters.AccountSubcategory>;
|
|
5366
|
+
|
|
5367
|
+
/**
|
|
5368
|
+
* ID of the institution to use to filter for selectable accounts.
|
|
5369
|
+
*/
|
|
5370
|
+
institution?: string;
|
|
4387
5371
|
}
|
|
4388
5372
|
|
|
4389
5373
|
namespace Filters {
|
|
4390
5374
|
type AccountSubcategory = 'checking' | 'savings';
|
|
4391
5375
|
}
|
|
4392
5376
|
|
|
5377
|
+
interface ManualEntry {
|
|
5378
|
+
/**
|
|
5379
|
+
* Settings for configuring manual entry of account details.
|
|
5380
|
+
*/
|
|
5381
|
+
mode: ManualEntry.Mode;
|
|
5382
|
+
}
|
|
5383
|
+
|
|
5384
|
+
namespace ManualEntry {
|
|
5385
|
+
type Mode = 'automatic' | 'custom';
|
|
5386
|
+
}
|
|
5387
|
+
|
|
4393
5388
|
type Permission =
|
|
4394
5389
|
| 'balances'
|
|
4395
5390
|
| 'ownership'
|
|
4396
5391
|
| 'payment_method'
|
|
4397
5392
|
| 'transactions';
|
|
4398
5393
|
|
|
4399
|
-
type Prefetch =
|
|
5394
|
+
type Prefetch =
|
|
5395
|
+
| 'balances'
|
|
5396
|
+
| 'inferred_balances'
|
|
5397
|
+
| 'ownership'
|
|
5398
|
+
| 'transactions';
|
|
4400
5399
|
}
|
|
4401
5400
|
|
|
4402
5401
|
interface MandateOptions {
|
|
@@ -4420,6 +5419,31 @@ declare module 'stripe' {
|
|
|
4420
5419
|
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
|
|
4421
5420
|
}
|
|
4422
5421
|
}
|
|
5422
|
+
|
|
5423
|
+
interface SetupDetails {
|
|
5424
|
+
/**
|
|
5425
|
+
* Benefit details for this SetupIntent
|
|
5426
|
+
*/
|
|
5427
|
+
benefit?: SetupDetails.Benefit;
|
|
5428
|
+
}
|
|
5429
|
+
|
|
5430
|
+
namespace SetupDetails {
|
|
5431
|
+
interface Benefit {
|
|
5432
|
+
/**
|
|
5433
|
+
* French meal voucher benefit details for this SetupIntent.
|
|
5434
|
+
*/
|
|
5435
|
+
fr_meal_voucher?: Benefit.FrMealVoucher;
|
|
5436
|
+
}
|
|
5437
|
+
|
|
5438
|
+
namespace Benefit {
|
|
5439
|
+
interface FrMealVoucher {
|
|
5440
|
+
/**
|
|
5441
|
+
* The 14-digit SIRET of the meal voucher acceptor.
|
|
5442
|
+
*/
|
|
5443
|
+
siret: string;
|
|
5444
|
+
}
|
|
5445
|
+
}
|
|
5446
|
+
}
|
|
4423
5447
|
}
|
|
4424
5448
|
|
|
4425
5449
|
interface SetupIntentVerifyMicrodepositsParams {
|