stripe 18.3.0-beta.2 → 18.3.0

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.
Files changed (296) hide show
  1. package/CHANGELOG.md +59 -1249
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -91
  6. package/cjs/RequestSender.js +1 -1
  7. package/cjs/apiVersion.js +3 -2
  8. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  9. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  10. package/cjs/resources/PaymentIntents.js +0 -13
  11. package/cjs/resources/Quotes.js +0 -32
  12. package/cjs/resources/SubscriptionSchedules.js +0 -4
  13. package/cjs/resources.js +10 -98
  14. package/cjs/stripe.core.js +1 -1
  15. package/esm/Error.js +0 -79
  16. package/esm/RequestSender.js +1 -1
  17. package/esm/apiVersion.js +2 -1
  18. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  19. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  20. package/esm/resources/PaymentIntents.js +0 -13
  21. package/esm/resources/Quotes.js +0 -32
  22. package/esm/resources/SubscriptionSchedules.js +0 -4
  23. package/esm/resources.js +1 -82
  24. package/esm/stripe.core.js +1 -1
  25. package/package.json +1 -1
  26. package/types/AccountLinksResource.d.ts +1 -5
  27. package/types/AccountSessions.d.ts +31 -76
  28. package/types/AccountSessionsResource.d.ts +48 -312
  29. package/types/Accounts.d.ts +30 -213
  30. package/types/AccountsResource.d.ts +85 -540
  31. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  32. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  33. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  34. package/types/Billing/CreditGrants.d.ts +0 -5
  35. package/types/Billing/CreditGrantsResource.d.ts +1 -11
  36. package/types/BillingPortal/Sessions.d.ts +1 -6
  37. package/types/BillingPortal/SessionsResource.d.ts +5 -13
  38. package/types/Cards.d.ts +0 -5
  39. package/types/CashBalances.d.ts +0 -5
  40. package/types/Charges.d.ts +52 -182
  41. package/types/ChargesResource.d.ts +0 -1406
  42. package/types/Checkout/Sessions.d.ts +1 -314
  43. package/types/Checkout/SessionsResource.d.ts +62 -340
  44. package/types/ConfirmationTokens.d.ts +22 -136
  45. package/types/Coupons.d.ts +0 -33
  46. package/types/CouponsResource.d.ts +0 -21
  47. package/types/CreditNoteLineItems.d.ts +0 -17
  48. package/types/CreditNotes.d.ts +0 -5
  49. package/types/CreditNotesResource.d.ts +9 -14
  50. package/types/CustomerBalanceTransactions.d.ts +0 -2
  51. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  52. package/types/CustomerSessions.d.ts +1 -6
  53. package/types/CustomerSessionsResource.d.ts +2 -7
  54. package/types/Customers.d.ts +0 -2
  55. package/types/CustomersResource.d.ts +1 -8
  56. package/types/Discounts.d.ts +0 -10
  57. package/types/Disputes.d.ts +6 -2
  58. package/types/Errors.d.ts +2 -69
  59. package/types/EventTypes.d.ts +0 -664
  60. package/types/Events.d.ts +1 -98
  61. package/types/FinancialConnections/Accounts.d.ts +1 -36
  62. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  63. package/types/FinancialConnections/Sessions.d.ts +1 -51
  64. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  65. package/types/Identity/VerificationSessions.d.ts +33 -4
  66. package/types/Identity/VerificationSessionsResource.d.ts +14 -4
  67. package/types/InvoiceItems.d.ts +1 -14
  68. package/types/InvoiceItemsResource.d.ts +6 -117
  69. package/types/InvoiceLineItems.d.ts +1 -45
  70. package/types/InvoicePayments.d.ts +0 -5
  71. package/types/InvoicePaymentsResource.d.ts +74 -0
  72. package/types/Invoices.d.ts +4 -133
  73. package/types/InvoicesResource.d.ts +37 -1446
  74. package/types/Issuing/CardholdersResource.d.ts +1 -2
  75. package/types/Issuing/Transactions.d.ts +0 -5
  76. package/types/Issuing/TransactionsResource.d.ts +0 -5
  77. package/types/LineItems.d.ts +0 -49
  78. package/types/Mandates.d.ts +4 -77
  79. package/types/PaymentIntents.d.ts +35 -770
  80. package/types/PaymentIntentsResource.d.ts +4268 -8619
  81. package/types/PaymentLinks.d.ts +0 -6
  82. package/types/PaymentLinksResource.d.ts +0 -12
  83. package/types/PaymentMethodConfigurations.d.ts +0 -180
  84. package/types/PaymentMethodConfigurationsResource.d.ts +0 -250
  85. package/types/PaymentMethods.d.ts +16 -134
  86. package/types/PaymentMethodsResource.d.ts +12 -167
  87. package/types/Payouts.d.ts +0 -5
  88. package/types/PayoutsResource.d.ts +0 -5
  89. package/types/Prices.d.ts +0 -22
  90. package/types/PricesResource.d.ts +0 -22
  91. package/types/PromotionCodes.d.ts +0 -5
  92. package/types/PromotionCodesResource.d.ts +0 -10
  93. package/types/Quotes.d.ts +8 -592
  94. package/types/QuotesResource.d.ts +278 -2617
  95. package/types/Refunds.d.ts +0 -14
  96. package/types/SetupAttempts.d.ts +4 -48
  97. package/types/SetupIntents.d.ts +17 -119
  98. package/types/SetupIntentsResource.d.ts +413 -660
  99. package/types/Sources.d.ts +0 -29
  100. package/types/SubscriptionItems.d.ts +0 -30
  101. package/types/SubscriptionItemsResource.d.ts +0 -109
  102. package/types/SubscriptionSchedules.d.ts +16 -207
  103. package/types/SubscriptionSchedulesResource.d.ts +14 -1236
  104. package/types/Subscriptions.d.ts +15 -108
  105. package/types/SubscriptionsResource.d.ts +30 -402
  106. package/types/Tax/Registrations.d.ts +9 -0
  107. package/types/Tax/RegistrationsResource.d.ts +12 -0
  108. package/types/TaxIds.d.ts +0 -10
  109. package/types/TaxIdsResource.d.ts +0 -10
  110. package/types/Terminal/Configurations.d.ts +1 -0
  111. package/types/Terminal/LocationsResource.d.ts +1 -1
  112. package/types/Terminal/Readers.d.ts +6 -26
  113. package/types/Terminal/ReadersResource.d.ts +4 -4
  114. package/types/TestHelpers/ConfirmationTokensResource.d.ts +15 -128
  115. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  116. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  117. package/types/TokensResource.d.ts +3 -0
  118. package/types/Transfers.d.ts +0 -5
  119. package/types/TransfersResource.d.ts +0 -5
  120. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  121. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  122. package/types/Treasury/FinancialAccountsResource.d.ts +9 -37
  123. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  124. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  125. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  126. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  127. package/types/V2/EventTypes.d.ts +4 -906
  128. package/types/WebhookEndpointsResource.d.ts +2 -79
  129. package/types/index.d.ts +6 -142
  130. package/types/lib.d.ts +11 -11
  131. package/types/test/typescriptTest.ts +3 -3
  132. package/cjs/resources/AccountNotices.js +0 -21
  133. package/cjs/resources/BalanceSettings.js +0 -10
  134. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  135. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  136. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  137. package/cjs/resources/ExternalAccounts.js +0 -23
  138. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  139. package/cjs/resources/FxQuotes.js +0 -15
  140. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  141. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  142. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  143. package/cjs/resources/Margins.js +0 -22
  144. package/cjs/resources/Orders.js +0 -24
  145. package/cjs/resources/PaymentRecords.js +0 -29
  146. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  147. package/cjs/resources/Tax/Associations.js +0 -9
  148. package/cjs/resources/Tax/Forms.js +0 -20
  149. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  150. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  151. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  152. package/cjs/resources/V2/Core/Accounts.js +0 -25
  153. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  154. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  155. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  156. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -17
  157. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  158. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  159. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  160. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  161. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  162. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  163. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  164. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  165. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  166. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  167. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  168. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  169. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -25
  170. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  171. package/esm/resources/AccountNotices.js +0 -18
  172. package/esm/resources/BalanceSettings.js +0 -7
  173. package/esm/resources/Capital/FinancingOffers.js +0 -18
  174. package/esm/resources/Capital/FinancingSummary.js +0 -9
  175. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  176. package/esm/resources/ExternalAccounts.js +0 -20
  177. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  178. package/esm/resources/FxQuotes.js +0 -12
  179. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  180. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  181. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  182. package/esm/resources/Margins.js +0 -19
  183. package/esm/resources/Orders.js +0 -21
  184. package/esm/resources/PaymentRecords.js +0 -26
  185. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  186. package/esm/resources/Tax/Associations.js +0 -6
  187. package/esm/resources/Tax/Forms.js +0 -17
  188. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  189. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  190. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  191. package/esm/resources/V2/Core/Accounts.js +0 -22
  192. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  193. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  194. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  195. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -14
  196. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  197. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  198. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  199. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  200. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  201. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  202. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  203. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  204. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  205. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  206. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  207. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  208. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -22
  209. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  210. package/types/AccountNotices.d.ts +0 -113
  211. package/types/AccountNoticesResource.d.ts +0 -98
  212. package/types/BalanceSettings.d.ts +0 -89
  213. package/types/BalanceSettingsResource.d.ts +0 -108
  214. package/types/Capital/FinancingOffers.d.ts +0 -188
  215. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  216. package/types/Capital/FinancingSummary.d.ts +0 -106
  217. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  218. package/types/Capital/FinancingTransactions.d.ts +0 -135
  219. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  220. package/types/ExternalAccountsResource.d.ts +0 -304
  221. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  222. package/types/FinancialConnections/Institutions.d.ts +0 -98
  223. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  224. package/types/FxQuotes.d.ts +0 -153
  225. package/types/FxQuotesResource.d.ts +0 -130
  226. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  227. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  228. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  229. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  230. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  231. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  232. package/types/Issuing/Settlements.d.ts +0 -113
  233. package/types/Margins.d.ts +0 -56
  234. package/types/MarginsResource.d.ts +0 -114
  235. package/types/Orders.d.ts +0 -1159
  236. package/types/OrdersResource.d.ts +0 -2967
  237. package/types/PaymentAttemptRecords.d.ts +0 -2132
  238. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  239. package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -116
  240. package/types/PaymentRecords.d.ts +0 -2125
  241. package/types/PaymentRecordsResource.d.ts +0 -455
  242. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  243. package/types/Privacy/RedactionJobs.d.ts +0 -111
  244. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  245. package/types/QuoteLines.d.ts +0 -634
  246. package/types/QuotePreviewInvoices.d.ts +0 -1695
  247. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -831
  248. package/types/Tax/Associations.d.ts +0 -82
  249. package/types/Tax/AssociationsResource.d.ts +0 -29
  250. package/types/Tax/Forms.d.ts +0 -220
  251. package/types/Tax/FormsResource.d.ts +0 -107
  252. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  253. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  254. package/types/V2/Core/AccountLinks.d.ts +0 -106
  255. package/types/V2/Core/AccountLinksResource.d.ts +0 -90
  256. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3770
  257. package/types/V2/Core/Accounts.d.ts +0 -8169
  258. package/types/V2/Core/AccountsResource.d.ts +0 -10203
  259. package/types/V2/Core/Persons.d.ts +0 -1867
  260. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  261. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  262. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  263. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  264. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  265. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  266. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  267. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  268. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -546
  269. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -52
  270. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
  271. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -288
  272. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  273. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  274. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
  275. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  276. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  277. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  278. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  279. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  280. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  281. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -207
  282. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -151
  283. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  284. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
  285. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  286. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -243
  287. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  288. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
  289. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  290. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -155
  291. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  292. package/types/V2/MoneyManagement/Transactions.d.ts +0 -170
  293. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  294. package/types/V2/Payments/OffSessionPayments.d.ts +0 -162
  295. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -159
  296. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -66
@@ -1,68 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Capital {
6
- interface FinancingTransactionRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- interface FinancingTransactionListParams extends PaginationParams {
14
- /**
15
- * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
16
- */
17
- charge?: string;
18
-
19
- /**
20
- * Specifies which fields in the response should be expanded.
21
- */
22
- expand?: Array<string>;
23
-
24
- /**
25
- * Returns transactions that were created that apply to this financing offer ID.
26
- */
27
- financing_offer?: string;
28
-
29
- /**
30
- * Only returns transactions that are responsible for reversing this financing transaction ID.
31
- */
32
- reversed_transaction?: string;
33
-
34
- /**
35
- * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
36
- */
37
- treasury_transaction?: string;
38
- }
39
-
40
- class FinancingTransactionsResource {
41
- /**
42
- * Retrieves a financing transaction for a financing offer.
43
- */
44
- retrieve(
45
- id: string,
46
- params?: FinancingTransactionRetrieveParams,
47
- options?: RequestOptions
48
- ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
49
- retrieve(
50
- id: string,
51
- options?: RequestOptions
52
- ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
53
-
54
- /**
55
- * Returns a list of financing transactions. The transactions are returned in sorted order,
56
- * with the most recent transactions appearing first.
57
- */
58
- list(
59
- params?: FinancingTransactionListParams,
60
- options?: RequestOptions
61
- ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
62
- list(
63
- options?: RequestOptions
64
- ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
65
- }
66
- }
67
- }
68
- }
@@ -1,304 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- interface ExternalAccountCreateParams {
6
- /**
7
- * Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's external account details (with the options shown below).
8
- */
9
- external_account:
10
- | string
11
- | ExternalAccountCreateParams.Card
12
- | ExternalAccountCreateParams.BankAccount
13
- | ExternalAccountCreateParams.CardToken;
14
-
15
- /**
16
- * When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
17
- */
18
- default_for_currency?: boolean;
19
-
20
- /**
21
- * Specifies which fields in the response should be expanded.
22
- */
23
- expand?: Array<string>;
24
-
25
- /**
26
- * 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`.
27
- */
28
- metadata?: Stripe.MetadataParam;
29
- }
30
-
31
- namespace ExternalAccountCreateParams {
32
- interface BankAccount {
33
- object: 'bank_account';
34
-
35
- /**
36
- * The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
37
- */
38
- account_holder_name?: string;
39
-
40
- /**
41
- * The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
42
- */
43
- account_holder_type?: BankAccount.AccountHolderType;
44
-
45
- /**
46
- * The account number for the bank account, in string form. Must be a checking account.
47
- */
48
- account_number: string;
49
-
50
- /**
51
- * The country in which the bank account is located.
52
- */
53
- country: string;
54
-
55
- /**
56
- * The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
57
- */
58
- currency?: string;
59
-
60
- /**
61
- * The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
62
- */
63
- routing_number?: string;
64
- }
65
-
66
- namespace BankAccount {
67
- type AccountHolderType = 'company' | 'individual';
68
- }
69
-
70
- interface Card {
71
- object: 'card';
72
-
73
- address_city?: string;
74
-
75
- address_country?: string;
76
-
77
- address_line1?: string;
78
-
79
- address_line2?: string;
80
-
81
- address_state?: string;
82
-
83
- address_zip?: string;
84
-
85
- currency?: string;
86
-
87
- cvc?: string;
88
-
89
- exp_month: number;
90
-
91
- exp_year: number;
92
-
93
- name?: string;
94
-
95
- number: string;
96
-
97
- /**
98
- * 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.
99
- */
100
- metadata?: Stripe.MetadataParam;
101
- }
102
-
103
- interface CardToken {
104
- object: 'card';
105
-
106
- currency?: string;
107
-
108
- token: string;
109
- }
110
- }
111
-
112
- interface ExternalAccountRetrieveParams {
113
- /**
114
- * Specifies which fields in the response should be expanded.
115
- */
116
- expand?: Array<string>;
117
- }
118
-
119
- interface ExternalAccountUpdateParams {
120
- /**
121
- * The name of the person or business that owns the bank account.
122
- */
123
- account_holder_name?: string;
124
-
125
- /**
126
- * The type of entity that holds the account. This can be either `individual` or `company`.
127
- */
128
- account_holder_type?: Stripe.Emptyable<
129
- ExternalAccountUpdateParams.AccountHolderType
130
- >;
131
-
132
- /**
133
- * The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
134
- */
135
- account_type?: ExternalAccountUpdateParams.AccountType;
136
-
137
- /**
138
- * City/District/Suburb/Town/Village.
139
- */
140
- address_city?: string;
141
-
142
- /**
143
- * Billing address country, if provided when creating card.
144
- */
145
- address_country?: string;
146
-
147
- /**
148
- * Address line 1 (Street address/PO Box/Company name).
149
- */
150
- address_line1?: string;
151
-
152
- /**
153
- * Address line 2 (Apartment/Suite/Unit/Building).
154
- */
155
- address_line2?: string;
156
-
157
- /**
158
- * State/County/Province/Region.
159
- */
160
- address_state?: string;
161
-
162
- /**
163
- * ZIP or postal code.
164
- */
165
- address_zip?: string;
166
-
167
- /**
168
- * When set to true, this becomes the default external account for its currency.
169
- */
170
- default_for_currency?: boolean;
171
-
172
- /**
173
- * Documents that may be submitted to satisfy various informational requests.
174
- */
175
- documents?: ExternalAccountUpdateParams.Documents;
176
-
177
- /**
178
- * Two digit number representing the card's expiration month.
179
- */
180
- exp_month?: string;
181
-
182
- /**
183
- * Four digit number representing the card's expiration year.
184
- */
185
- exp_year?: string;
186
-
187
- /**
188
- * Specifies which fields in the response should be expanded.
189
- */
190
- expand?: Array<string>;
191
-
192
- /**
193
- * 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`.
194
- */
195
- metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
196
-
197
- /**
198
- * Cardholder name.
199
- */
200
- name?: string;
201
- }
202
-
203
- namespace ExternalAccountUpdateParams {
204
- type AccountHolderType = 'company' | 'individual';
205
-
206
- type AccountType = 'checking' | 'futsu' | 'savings' | 'toza';
207
-
208
- interface Documents {
209
- /**
210
- * One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
211
- */
212
- bank_account_ownership_verification?: Documents.BankAccountOwnershipVerification;
213
- }
214
-
215
- namespace Documents {
216
- interface BankAccountOwnershipVerification {
217
- /**
218
- * One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
219
- */
220
- files?: Array<string>;
221
- }
222
- }
223
- }
224
-
225
- interface ExternalAccountListParams extends PaginationParams {
226
- /**
227
- * Specifies which fields in the response should be expanded.
228
- */
229
- expand?: Array<string>;
230
-
231
- /**
232
- * Filter external accounts according to a particular object type.
233
- */
234
- object?: ExternalAccountListParams.Object;
235
- }
236
-
237
- namespace ExternalAccountListParams {
238
- type Object = 'bank_account' | 'card';
239
- }
240
-
241
- interface ExternalAccountDeleteParams {}
242
-
243
- class ExternalAccountsResource {
244
- /**
245
- * Create an external account for a given connected account.
246
- */
247
- create(
248
- params: ExternalAccountCreateParams,
249
- options?: RequestOptions
250
- ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
251
-
252
- /**
253
- * Retrieve a specified external account for a given account.
254
- */
255
- retrieve(
256
- id: string,
257
- params?: ExternalAccountRetrieveParams,
258
- options?: RequestOptions
259
- ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
260
- retrieve(
261
- id: string,
262
- options?: RequestOptions
263
- ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
264
-
265
- /**
266
- * Updates the metadata, account holder name, account holder type of a bank account belonging to
267
- * a connected account and optionally sets it as the default for its currency. Other bank account
268
- * details are not editable by design.
269
- *
270
- * You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
271
- *
272
- * You can re-enable a disabled bank account by performing an update call without providing any
273
- * arguments or changes.
274
- */
275
- update(
276
- id: string,
277
- params?: ExternalAccountUpdateParams,
278
- options?: RequestOptions
279
- ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
280
-
281
- /**
282
- * List external accounts for an account.
283
- */
284
- list(
285
- params?: ExternalAccountListParams,
286
- options?: RequestOptions
287
- ): ApiListPromise<Stripe.ExternalAccount>;
288
- list(options?: RequestOptions): ApiListPromise<Stripe.ExternalAccount>;
289
-
290
- /**
291
- * Delete a specified external account for a given account.
292
- */
293
- del(
294
- id: string,
295
- params?: ExternalAccountDeleteParams,
296
- options?: RequestOptions
297
- ): Promise<Stripe.Response<Stripe.DeletedExternalAccount>>;
298
- del(
299
- id: string,
300
- options?: RequestOptions
301
- ): Promise<Stripe.Response<Stripe.DeletedExternalAccount>>;
302
- }
303
- }
304
- }
@@ -1,38 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace FinancialConnections {
6
- /**
7
- * A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
8
- */
9
- interface AccountInferredBalance {
10
- /**
11
- * Unique identifier for the object.
12
- */
13
- id: string;
14
-
15
- /**
16
- * String representing the object's type. Objects of the same type share the same value.
17
- */
18
- object: 'financial_connections.account_inferred_balance';
19
-
20
- /**
21
- * The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
22
- */
23
- as_of: number;
24
-
25
- /**
26
- * The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
27
- *
28
- * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
29
- *
30
- * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
31
- */
32
- current: {
33
- [key: string]: number;
34
- };
35
- }
36
- }
37
- }
38
- }
@@ -1,98 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace FinancialConnections {
6
- /**
7
- * An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
8
- */
9
- interface Institution {
10
- /**
11
- * Unique identifier for the object.
12
- */
13
- id: string;
14
-
15
- /**
16
- * String representing the object's type. Objects of the same type share the same value.
17
- */
18
- object: 'financial_connections.institution';
19
-
20
- /**
21
- * The list of countries supported by this institution, formatted as ISO country codes.
22
- */
23
- countries: Array<string>;
24
-
25
- features: Institution.Features;
26
-
27
- /**
28
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
29
- */
30
- livemode: boolean;
31
-
32
- /**
33
- * The name of this institution.
34
- */
35
- name: string;
36
-
37
- /**
38
- * A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
39
- */
40
- routing_numbers: Array<string>;
41
-
42
- /**
43
- * The status of this institution in the Financial Connections authentication flow.
44
- */
45
- status: Institution.Status;
46
-
47
- /**
48
- * A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
49
- */
50
- url: string | null;
51
- }
52
-
53
- namespace Institution {
54
- interface Features {
55
- balances: Features.Balances;
56
-
57
- ownership: Features.Ownership;
58
-
59
- payment_method: Features.PaymentMethod;
60
-
61
- transactions: Features.Transactions;
62
- }
63
-
64
- namespace Features {
65
- interface Balances {
66
- /**
67
- * Whether the given feature is supported by this institution.
68
- */
69
- supported: boolean;
70
- }
71
-
72
- interface Ownership {
73
- /**
74
- * Whether the given feature is supported by this institution.
75
- */
76
- supported: boolean;
77
- }
78
-
79
- interface PaymentMethod {
80
- /**
81
- * Whether the given feature is supported by this institution.
82
- */
83
- supported: boolean;
84
- }
85
-
86
- interface Transactions {
87
- /**
88
- * Whether the given feature is supported by this institution.
89
- */
90
- supported: boolean;
91
- }
92
- }
93
-
94
- type Status = 'active' | 'degraded' | 'inactive';
95
- }
96
- }
97
- }
98
- }
@@ -1,47 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace FinancialConnections {
6
- interface InstitutionRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- interface InstitutionListParams extends PaginationParams {
14
- /**
15
- * Specifies which fields in the response should be expanded.
16
- */
17
- expand?: Array<string>;
18
- }
19
-
20
- class InstitutionsResource {
21
- /**
22
- * Retrieves the details of a Financial Connections Institution.
23
- */
24
- retrieve(
25
- id: string,
26
- params?: InstitutionRetrieveParams,
27
- options?: RequestOptions
28
- ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
29
- retrieve(
30
- id: string,
31
- options?: RequestOptions
32
- ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
33
-
34
- /**
35
- * Returns a list of Financial Connections Institution objects.
36
- */
37
- list(
38
- params?: InstitutionListParams,
39
- options?: RequestOptions
40
- ): ApiListPromise<Stripe.FinancialConnections.Institution>;
41
- list(
42
- options?: RequestOptions
43
- ): ApiListPromise<Stripe.FinancialConnections.Institution>;
44
- }
45
- }
46
- }
47
- }