stripe 18.2.0-beta.1 → 18.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (333) hide show
  1. package/CHANGELOG.md +183 -1211
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +11 -12
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -91
  6. package/cjs/RequestSender.js +3 -3
  7. package/cjs/StripeResource.js +1 -1
  8. package/cjs/apiVersion.js +1 -1
  9. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  10. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  11. package/cjs/resources/PaymentIntents.js +0 -13
  12. package/cjs/resources/Quotes.js +0 -32
  13. package/cjs/resources/SubscriptionSchedules.js +0 -4
  14. package/cjs/resources/Terminal/Readers.js +0 -8
  15. package/cjs/resources.js +18 -108
  16. package/cjs/stripe.core.js +1 -1
  17. package/cjs/utils.js +5 -0
  18. package/esm/Error.js +0 -79
  19. package/esm/RequestSender.js +3 -3
  20. package/esm/StripeResource.js +1 -1
  21. package/esm/apiVersion.js +1 -1
  22. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  23. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  24. package/esm/resources/PaymentIntents.js +0 -13
  25. package/esm/resources/Quotes.js +0 -32
  26. package/esm/resources/SubscriptionSchedules.js +0 -4
  27. package/esm/resources/Terminal/Readers.js +0 -8
  28. package/esm/resources.js +1 -84
  29. package/esm/stripe.core.js +1 -1
  30. package/esm/utils.js +5 -0
  31. package/package.json +1 -1
  32. package/types/AccountLinksResource.d.ts +1 -5
  33. package/types/AccountSessions.d.ts +52 -32
  34. package/types/AccountSessionsResource.d.ts +23 -246
  35. package/types/Accounts.d.ts +19 -223
  36. package/types/AccountsResource.d.ts +61 -581
  37. package/types/Balance.d.ts +83 -1
  38. package/types/BalanceResource.d.ts +1 -1
  39. package/types/BalanceTransactions.d.ts +10 -0
  40. package/types/BankAccounts.d.ts +3 -3
  41. package/types/Billing/Alerts.d.ts +1 -1
  42. package/types/Billing/AlertsResource.d.ts +2 -2
  43. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  44. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  45. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  46. package/types/Billing/CreditGrants.d.ts +0 -5
  47. package/types/Billing/CreditGrantsResource.d.ts +1 -11
  48. package/types/BillingPortal/Sessions.d.ts +1 -6
  49. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  50. package/types/Capabilities.d.ts +1 -1
  51. package/types/Cards.d.ts +2 -7
  52. package/types/CashBalances.d.ts +0 -5
  53. package/types/Charges.d.ts +20 -166
  54. package/types/ChargesResource.d.ts +4 -1318
  55. package/types/Checkout/Sessions.d.ts +120 -418
  56. package/types/Checkout/SessionsResource.d.ts +118 -448
  57. package/types/ConfirmationTokens.d.ts +4 -129
  58. package/types/CountrySpecs.d.ts +1 -1
  59. package/types/Coupons.d.ts +0 -33
  60. package/types/CouponsResource.d.ts +0 -21
  61. package/types/CreditNoteLineItems.d.ts +0 -17
  62. package/types/CreditNotes.d.ts +11 -10
  63. package/types/CreditNotesResource.d.ts +7 -13
  64. package/types/CustomerBalanceTransactions.d.ts +0 -2
  65. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  66. package/types/CustomerSessions.d.ts +3 -8
  67. package/types/CustomerSessionsResource.d.ts +1 -6
  68. package/types/Customers.d.ts +0 -2
  69. package/types/CustomersResource.d.ts +7 -15
  70. package/types/Discounts.d.ts +0 -10
  71. package/types/Disputes.d.ts +1 -1
  72. package/types/DisputesResource.d.ts +1 -1
  73. package/types/Errors.d.ts +2 -69
  74. package/types/EventTypes.d.ts +17 -698
  75. package/types/Events.d.ts +4 -99
  76. package/types/Files.d.ts +1 -1
  77. package/types/FilesResource.d.ts +1 -1
  78. package/types/FinancialConnections/Accounts.d.ts +1 -31
  79. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  80. package/types/FinancialConnections/Sessions.d.ts +1 -51
  81. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  82. package/types/Identity/VerificationReports.d.ts +17 -0
  83. package/types/Identity/VerificationSessions.d.ts +19 -7
  84. package/types/Identity/VerificationSessionsResource.d.ts +5 -12
  85. package/types/InvoiceItems.d.ts +1 -11
  86. package/types/InvoiceItemsResource.d.ts +6 -117
  87. package/types/InvoiceLineItems.d.ts +2 -46
  88. package/types/InvoicePayments.d.ts +9 -7
  89. package/types/InvoicePaymentsResource.d.ts +74 -0
  90. package/types/Invoices.d.ts +10 -142
  91. package/types/InvoicesResource.d.ts +66 -1469
  92. package/types/Issuing/AuthorizationsResource.d.ts +4 -4
  93. package/types/Issuing/CardholdersResource.d.ts +1 -2
  94. package/types/Issuing/CardsResource.d.ts +3 -0
  95. package/types/Issuing/DisputesResource.d.ts +2 -2
  96. package/types/Issuing/Transactions.d.ts +0 -5
  97. package/types/Issuing/TransactionsResource.d.ts +0 -5
  98. package/types/LineItems.d.ts +2 -51
  99. package/types/Mandates.d.ts +0 -77
  100. package/types/PaymentIntents.d.ts +145 -856
  101. package/types/PaymentIntentsResource.d.ts +4307 -8780
  102. package/types/PaymentLinks.d.ts +0 -6
  103. package/types/PaymentLinksResource.d.ts +0 -12
  104. package/types/PaymentMethodConfigurations.d.ts +70 -70
  105. package/types/PaymentMethodConfigurationsResource.d.ts +164 -164
  106. package/types/PaymentMethodDomainsResource.d.ts +1 -1
  107. package/types/PaymentMethods.d.ts +4 -129
  108. package/types/PaymentMethodsResource.d.ts +10 -175
  109. package/types/Payouts.d.ts +2 -7
  110. package/types/PayoutsResource.d.ts +2 -7
  111. package/types/Persons.d.ts +10 -10
  112. package/types/PlansResource.d.ts +1 -1
  113. package/types/Prices.d.ts +0 -22
  114. package/types/PricesResource.d.ts +2 -24
  115. package/types/Products.d.ts +0 -39
  116. package/types/ProductsResource.d.ts +1 -37
  117. package/types/PromotionCodes.d.ts +0 -5
  118. package/types/PromotionCodesResource.d.ts +1 -11
  119. package/types/Quotes.d.ts +7 -609
  120. package/types/QuotesResource.d.ts +224 -2578
  121. package/types/Radar/EarlyFraudWarningsResource.d.ts +1 -1
  122. package/types/Refunds.d.ts +6 -15
  123. package/types/Reviews.d.ts +1 -1
  124. package/types/SetupAttempts.d.ts +2 -50
  125. package/types/SetupIntents.d.ts +4 -122
  126. package/types/SetupIntentsResource.d.ts +6 -733
  127. package/types/Sources.d.ts +0 -29
  128. package/types/SourcesResource.d.ts +1 -1
  129. package/types/SubscriptionItems.d.ts +8 -17
  130. package/types/SubscriptionItemsResource.d.ts +28 -109
  131. package/types/SubscriptionSchedules.d.ts +47 -213
  132. package/types/SubscriptionSchedulesResource.d.ts +104 -1243
  133. package/types/Subscriptions.d.ts +16 -102
  134. package/types/SubscriptionsResource.d.ts +80 -407
  135. package/types/Tax/CalculationLineItems.d.ts +5 -0
  136. package/types/Tax/CalculationsResource.d.ts +5 -0
  137. package/types/Tax/RegistrationsResource.d.ts +1 -1
  138. package/types/TaxIds.d.ts +0 -10
  139. package/types/TaxIdsResource.d.ts +0 -10
  140. package/types/TaxRates.d.ts +2 -2
  141. package/types/Terminal/LocationsResource.d.ts +1 -1
  142. package/types/Terminal/Readers.d.ts +7 -89
  143. package/types/Terminal/ReadersResource.d.ts +6 -82
  144. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
  145. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  146. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  147. package/types/Tokens.d.ts +3 -3
  148. package/types/TokensResource.d.ts +8 -8
  149. package/types/TransferReversals.d.ts +1 -1
  150. package/types/Transfers.d.ts +0 -5
  151. package/types/TransfersResource.d.ts +2 -7
  152. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  153. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  154. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  155. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  156. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  157. package/types/Treasury/ReceivedCredits.d.ts +2 -28
  158. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  159. package/types/V2/EventTypes.d.ts +1 -812
  160. package/types/WebhookEndpointsResource.d.ts +4 -83
  161. package/types/index.d.ts +5 -145
  162. package/types/lib.d.ts +1 -11
  163. package/types/test/typescriptTest.ts +3 -3
  164. package/cjs/resources/AccountNotices.js +0 -21
  165. package/cjs/resources/BalanceSettings.js +0 -10
  166. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  167. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  168. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  169. package/cjs/resources/ExternalAccounts.js +0 -23
  170. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  171. package/cjs/resources/FxQuotes.js +0 -15
  172. package/cjs/resources/GiftCards/Cards.js +0 -23
  173. package/cjs/resources/GiftCards/Transactions.js +0 -33
  174. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  175. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  176. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  177. package/cjs/resources/Margins.js +0 -22
  178. package/cjs/resources/Orders.js +0 -24
  179. package/cjs/resources/PaymentRecords.js +0 -29
  180. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  181. package/cjs/resources/Tax/Associations.js +0 -9
  182. package/cjs/resources/Tax/Forms.js +0 -20
  183. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  184. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  185. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  186. package/cjs/resources/V2/Core/Accounts.js +0 -25
  187. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  188. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  189. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  190. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -17
  191. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  192. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  193. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  194. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  195. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  196. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  197. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  198. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  199. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  200. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  201. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  202. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  203. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  204. package/esm/resources/AccountNotices.js +0 -18
  205. package/esm/resources/BalanceSettings.js +0 -7
  206. package/esm/resources/Capital/FinancingOffers.js +0 -18
  207. package/esm/resources/Capital/FinancingSummary.js +0 -9
  208. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  209. package/esm/resources/ExternalAccounts.js +0 -20
  210. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  211. package/esm/resources/FxQuotes.js +0 -12
  212. package/esm/resources/GiftCards/Cards.js +0 -20
  213. package/esm/resources/GiftCards/Transactions.js +0 -30
  214. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  215. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  216. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  217. package/esm/resources/Margins.js +0 -19
  218. package/esm/resources/Orders.js +0 -21
  219. package/esm/resources/PaymentRecords.js +0 -26
  220. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  221. package/esm/resources/Tax/Associations.js +0 -6
  222. package/esm/resources/Tax/Forms.js +0 -17
  223. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  224. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  225. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  226. package/esm/resources/V2/Core/Accounts.js +0 -22
  227. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  228. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  229. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  230. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -14
  231. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  232. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  233. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  234. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  235. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  236. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  237. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  238. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  239. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  240. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  241. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  242. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  243. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  244. package/types/AccountNotices.d.ts +0 -113
  245. package/types/AccountNoticesResource.d.ts +0 -98
  246. package/types/BalanceSettings.d.ts +0 -89
  247. package/types/BalanceSettingsResource.d.ts +0 -108
  248. package/types/Billing/MeterErrorReports.d.ts +0 -106
  249. package/types/Capital/FinancingOffers.d.ts +0 -188
  250. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  251. package/types/Capital/FinancingSummary.d.ts +0 -106
  252. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  253. package/types/Capital/FinancingTransactions.d.ts +0 -135
  254. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  255. package/types/ExternalAccountsResource.d.ts +0 -304
  256. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  257. package/types/FinancialConnections/Institutions.d.ts +0 -93
  258. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  259. package/types/FxQuotes.d.ts +0 -153
  260. package/types/FxQuotesResource.d.ts +0 -130
  261. package/types/GiftCards/Cards.d.ts +0 -118
  262. package/types/GiftCards/CardsResource.d.ts +0 -159
  263. package/types/GiftCards/Transactions.d.ts +0 -129
  264. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  265. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  266. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  267. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  268. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  269. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  270. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  271. package/types/Issuing/Settlements.d.ts +0 -113
  272. package/types/Margins.d.ts +0 -56
  273. package/types/MarginsResource.d.ts +0 -114
  274. package/types/Orders.d.ts +0 -1199
  275. package/types/OrdersResource.d.ts +0 -3001
  276. package/types/PaymentAttemptRecords.d.ts +0 -2112
  277. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  278. package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -110
  279. package/types/PaymentRecords.d.ts +0 -2105
  280. package/types/PaymentRecordsResource.d.ts +0 -455
  281. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -30
  282. package/types/Privacy/RedactionJobs.d.ts +0 -65
  283. package/types/Privacy/RedactionJobsResource.d.ts +0 -218
  284. package/types/QuoteLines.d.ts +0 -634
  285. package/types/QuotePreviewInvoices.d.ts +0 -1697
  286. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -785
  287. package/types/Tax/Associations.d.ts +0 -126
  288. package/types/Tax/AssociationsResource.d.ts +0 -29
  289. package/types/Tax/Forms.d.ts +0 -220
  290. package/types/Tax/FormsResource.d.ts +0 -107
  291. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  292. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  293. package/types/V2/Core/AccountLinks.d.ts +0 -106
  294. package/types/V2/Core/AccountLinksResource.d.ts +0 -90
  295. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3770
  296. package/types/V2/Core/Accounts.d.ts +0 -8169
  297. package/types/V2/Core/AccountsResource.d.ts +0 -10203
  298. package/types/V2/Core/Persons.d.ts +0 -1867
  299. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  300. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  301. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  302. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  303. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  304. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  305. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  306. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  307. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -546
  308. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -52
  309. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
  310. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -288
  311. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  312. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  313. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
  314. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  315. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  316. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  317. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  318. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  319. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  320. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -207
  321. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -151
  322. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  323. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
  324. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  325. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -285
  326. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  327. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -224
  328. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  329. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -155
  330. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  331. package/types/V2/MoneyManagement/Transactions.d.ts +0 -170
  332. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  333. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -66
@@ -1,314 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace MoneyManagement {
7
- /**
8
- * A FinancialAddress contains information needed to transfer money to a Financial Account. A Financial Account can have more than one Financial Address.
9
- */
10
- interface FinancialAddress {
11
- /**
12
- * The ID of a FinancialAddress.
13
- */
14
- id: string;
15
-
16
- /**
17
- * String representing the object's type. Objects of the same type share the same value of the object field.
18
- */
19
- object: 'v2.money_management.financial_address';
20
-
21
- /**
22
- * The creation timestamp of the FinancialAddress.
23
- */
24
- created: string;
25
-
26
- /**
27
- * Object indicates the type of credentials that have been allocated and attached to the FinancialAddress.
28
- * It contains all necessary banking details with which to perform money movements with the FinancialAddress.
29
- * This field is only available for FinancialAddresses with an active status.
30
- */
31
- credentials: FinancialAddress.Credentials | null;
32
-
33
- /**
34
- * Open Enum. The currency the FinancialAddress supports.
35
- */
36
- currency: FinancialAddress.Currency;
37
-
38
- /**
39
- * A ID of the FinancialAccount this FinancialAddress corresponds to.
40
- */
41
- financial_account: string;
42
-
43
- /**
44
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
45
- */
46
- livemode: boolean;
47
-
48
- /**
49
- * Closed Enum. An enum representing the status of the FinancialAddress. This indicates whether or not the FinancialAddress can be used for any money movement flows.
50
- */
51
- status: FinancialAddress.Status;
52
- }
53
-
54
- namespace FinancialAddress {
55
- interface Credentials {
56
- /**
57
- * Open Enum. The type of Credentials that are provisioned for the FinancialAddress.
58
- */
59
- type: Credentials.Type;
60
-
61
- /**
62
- * The credentials of the UK Bank Account for the FinancialAddress. This contains unique banking details such as the sort code, account number, etc. of a UK bank account.
63
- */
64
- gb_bank_account: Credentials.GbBankAccount | null;
65
-
66
- /**
67
- * The credentials of the US Bank Account for the FinancialAddress. This contains unique banking details such as the routing number, account number, etc. of a US bank account.
68
- */
69
- us_bank_account: Credentials.UsBankAccount | null;
70
- }
71
-
72
- namespace Credentials {
73
- interface GbBankAccount {
74
- /**
75
- * The account holder name to be used during bank transference.
76
- */
77
- account_holder_name: string;
78
-
79
- /**
80
- * The account number of the UK Bank Account.
81
- */
82
- account_number: string | null;
83
-
84
- /**
85
- * The last four digits of the UK Bank Account number. This will always be returned.
86
- * To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
87
- */
88
- last4: string;
89
-
90
- /**
91
- * The sort code of the UK Bank Account.
92
- */
93
- sort_code: string;
94
- }
95
-
96
- type Type = 'gb_bank_account' | 'us_bank_account';
97
-
98
- interface UsBankAccount {
99
- /**
100
- * The account number of the US Bank Account.
101
- */
102
- account_number: string | null;
103
-
104
- /**
105
- * The name of the Bank.
106
- */
107
- bank_name: string | null;
108
-
109
- /**
110
- * The last four digits of the US Bank Account number. This will always be returned.
111
- * To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
112
- */
113
- last4: string;
114
-
115
- /**
116
- * The routing number of the US Bank Account.
117
- */
118
- routing_number: string;
119
-
120
- /**
121
- * The swift code of the bank or financial institution.
122
- */
123
- swift_code: string | null;
124
- }
125
- }
126
-
127
- type Currency =
128
- | 'aed'
129
- | 'afn'
130
- | 'all'
131
- | 'amd'
132
- | 'ang'
133
- | 'aoa'
134
- | 'ars'
135
- | 'aud'
136
- | 'awg'
137
- | 'azn'
138
- | 'bam'
139
- | 'bbd'
140
- | 'bdt'
141
- | 'bgn'
142
- | 'bhd'
143
- | 'bif'
144
- | 'bmd'
145
- | 'bnd'
146
- | 'bob'
147
- | 'bov'
148
- | 'brl'
149
- | 'bsd'
150
- | 'btn'
151
- | 'bwp'
152
- | 'byn'
153
- | 'byr'
154
- | 'bzd'
155
- | 'cad'
156
- | 'cdf'
157
- | 'che'
158
- | 'chf'
159
- | 'chw'
160
- | 'clf'
161
- | 'clp'
162
- | 'cny'
163
- | 'cop'
164
- | 'cou'
165
- | 'crc'
166
- | 'cuc'
167
- | 'cup'
168
- | 'cve'
169
- | 'czk'
170
- | 'djf'
171
- | 'dkk'
172
- | 'dop'
173
- | 'dzd'
174
- | 'eek'
175
- | 'egp'
176
- | 'ern'
177
- | 'etb'
178
- | 'eur'
179
- | 'fjd'
180
- | 'fkp'
181
- | 'gbp'
182
- | 'gel'
183
- | 'ghc'
184
- | 'ghs'
185
- | 'gip'
186
- | 'gmd'
187
- | 'gnf'
188
- | 'gtq'
189
- | 'gyd'
190
- | 'hkd'
191
- | 'hnl'
192
- | 'hrk'
193
- | 'htg'
194
- | 'huf'
195
- | 'idr'
196
- | 'ils'
197
- | 'inr'
198
- | 'iqd'
199
- | 'irr'
200
- | 'isk'
201
- | 'jmd'
202
- | 'jod'
203
- | 'jpy'
204
- | 'kes'
205
- | 'kgs'
206
- | 'khr'
207
- | 'kmf'
208
- | 'kpw'
209
- | 'krw'
210
- | 'kwd'
211
- | 'kyd'
212
- | 'kzt'
213
- | 'lak'
214
- | 'lbp'
215
- | 'lkr'
216
- | 'lrd'
217
- | 'lsl'
218
- | 'ltl'
219
- | 'lvl'
220
- | 'lyd'
221
- | 'mad'
222
- | 'mdl'
223
- | 'mga'
224
- | 'mkd'
225
- | 'mmk'
226
- | 'mnt'
227
- | 'mop'
228
- | 'mro'
229
- | 'mru'
230
- | 'mur'
231
- | 'mvr'
232
- | 'mwk'
233
- | 'mxn'
234
- | 'mxv'
235
- | 'myr'
236
- | 'mzn'
237
- | 'nad'
238
- | 'ngn'
239
- | 'nio'
240
- | 'nok'
241
- | 'npr'
242
- | 'nzd'
243
- | 'omr'
244
- | 'pab'
245
- | 'pen'
246
- | 'pgk'
247
- | 'php'
248
- | 'pkr'
249
- | 'pln'
250
- | 'pyg'
251
- | 'qar'
252
- | 'ron'
253
- | 'rsd'
254
- | 'rub'
255
- | 'rwf'
256
- | 'sar'
257
- | 'sbd'
258
- | 'scr'
259
- | 'sdg'
260
- | 'sek'
261
- | 'sgd'
262
- | 'shp'
263
- | 'sle'
264
- | 'sll'
265
- | 'sos'
266
- | 'srd'
267
- | 'ssp'
268
- | 'std'
269
- | 'stn'
270
- | 'svc'
271
- | 'syp'
272
- | 'szl'
273
- | 'thb'
274
- | 'tjs'
275
- | 'tmt'
276
- | 'tnd'
277
- | 'top'
278
- | 'try'
279
- | 'ttd'
280
- | 'twd'
281
- | 'tzs'
282
- | 'uah'
283
- | 'ugx'
284
- | 'usd'
285
- | 'usdb'
286
- | 'usdc'
287
- | 'usn'
288
- | 'uyi'
289
- | 'uyu'
290
- | 'uzs'
291
- | 'vef'
292
- | 'ves'
293
- | 'vnd'
294
- | 'vuv'
295
- | 'wst'
296
- | 'xaf'
297
- | 'xcd'
298
- | 'xcg'
299
- | 'xof'
300
- | 'xpf'
301
- | 'yer'
302
- | 'zar'
303
- | 'zmk'
304
- | 'zmw'
305
- | 'zwd'
306
- | 'zwg'
307
- | 'zwl';
308
-
309
- type Status = 'active' | 'archived' | 'failed' | 'pending';
310
- }
311
- }
312
- }
313
- }
314
- }
@@ -1,288 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace MoneyManagement {
7
- interface FinancialAddressCreateParams {
8
- /**
9
- * Open Enum. The currency the FinancialAddress should support. Currently, only the `usd` and `gbp` values are supported.
10
- */
11
- currency: FinancialAddressCreateParams.Currency;
12
-
13
- /**
14
- * The ID of the FinancialAccount the new FinancialAddress should be associated with.
15
- */
16
- financial_account: string;
17
- }
18
-
19
- namespace FinancialAddressCreateParams {
20
- type Currency =
21
- | 'aed'
22
- | 'afn'
23
- | 'all'
24
- | 'amd'
25
- | 'ang'
26
- | 'aoa'
27
- | 'ars'
28
- | 'aud'
29
- | 'awg'
30
- | 'azn'
31
- | 'bam'
32
- | 'bbd'
33
- | 'bdt'
34
- | 'bgn'
35
- | 'bhd'
36
- | 'bif'
37
- | 'bmd'
38
- | 'bnd'
39
- | 'bob'
40
- | 'bov'
41
- | 'brl'
42
- | 'bsd'
43
- | 'btn'
44
- | 'bwp'
45
- | 'byn'
46
- | 'byr'
47
- | 'bzd'
48
- | 'cad'
49
- | 'cdf'
50
- | 'che'
51
- | 'chf'
52
- | 'chw'
53
- | 'clf'
54
- | 'clp'
55
- | 'cny'
56
- | 'cop'
57
- | 'cou'
58
- | 'crc'
59
- | 'cuc'
60
- | 'cup'
61
- | 'cve'
62
- | 'czk'
63
- | 'djf'
64
- | 'dkk'
65
- | 'dop'
66
- | 'dzd'
67
- | 'eek'
68
- | 'egp'
69
- | 'ern'
70
- | 'etb'
71
- | 'eur'
72
- | 'fjd'
73
- | 'fkp'
74
- | 'gbp'
75
- | 'gel'
76
- | 'ghc'
77
- | 'ghs'
78
- | 'gip'
79
- | 'gmd'
80
- | 'gnf'
81
- | 'gtq'
82
- | 'gyd'
83
- | 'hkd'
84
- | 'hnl'
85
- | 'hrk'
86
- | 'htg'
87
- | 'huf'
88
- | 'idr'
89
- | 'ils'
90
- | 'inr'
91
- | 'iqd'
92
- | 'irr'
93
- | 'isk'
94
- | 'jmd'
95
- | 'jod'
96
- | 'jpy'
97
- | 'kes'
98
- | 'kgs'
99
- | 'khr'
100
- | 'kmf'
101
- | 'kpw'
102
- | 'krw'
103
- | 'kwd'
104
- | 'kyd'
105
- | 'kzt'
106
- | 'lak'
107
- | 'lbp'
108
- | 'lkr'
109
- | 'lrd'
110
- | 'lsl'
111
- | 'ltl'
112
- | 'lvl'
113
- | 'lyd'
114
- | 'mad'
115
- | 'mdl'
116
- | 'mga'
117
- | 'mkd'
118
- | 'mmk'
119
- | 'mnt'
120
- | 'mop'
121
- | 'mro'
122
- | 'mru'
123
- | 'mur'
124
- | 'mvr'
125
- | 'mwk'
126
- | 'mxn'
127
- | 'mxv'
128
- | 'myr'
129
- | 'mzn'
130
- | 'nad'
131
- | 'ngn'
132
- | 'nio'
133
- | 'nok'
134
- | 'npr'
135
- | 'nzd'
136
- | 'omr'
137
- | 'pab'
138
- | 'pen'
139
- | 'pgk'
140
- | 'php'
141
- | 'pkr'
142
- | 'pln'
143
- | 'pyg'
144
- | 'qar'
145
- | 'ron'
146
- | 'rsd'
147
- | 'rub'
148
- | 'rwf'
149
- | 'sar'
150
- | 'sbd'
151
- | 'scr'
152
- | 'sdg'
153
- | 'sek'
154
- | 'sgd'
155
- | 'shp'
156
- | 'sle'
157
- | 'sll'
158
- | 'sos'
159
- | 'srd'
160
- | 'ssp'
161
- | 'std'
162
- | 'stn'
163
- | 'svc'
164
- | 'syp'
165
- | 'szl'
166
- | 'thb'
167
- | 'tjs'
168
- | 'tmt'
169
- | 'tnd'
170
- | 'top'
171
- | 'try'
172
- | 'ttd'
173
- | 'twd'
174
- | 'tzs'
175
- | 'uah'
176
- | 'ugx'
177
- | 'usd'
178
- | 'usdb'
179
- | 'usdc'
180
- | 'usn'
181
- | 'uyi'
182
- | 'uyu'
183
- | 'uzs'
184
- | 'vef'
185
- | 'ves'
186
- | 'vnd'
187
- | 'vuv'
188
- | 'wst'
189
- | 'xaf'
190
- | 'xcd'
191
- | 'xcg'
192
- | 'xof'
193
- | 'xpf'
194
- | 'yer'
195
- | 'zar'
196
- | 'zmk'
197
- | 'zmw'
198
- | 'zwd'
199
- | 'zwg'
200
- | 'zwl';
201
- }
202
- }
203
-
204
- namespace MoneyManagement {
205
- interface FinancialAddressRetrieveParams {
206
- /**
207
- * Open Enum. A list of fields to reveal in the FinancialAddresses returned.
208
- */
209
- include?: Array<FinancialAddressRetrieveParams.Include>;
210
- }
211
-
212
- namespace FinancialAddressRetrieveParams {
213
- type Include =
214
- | 'credentials.gb_bank_account.account_number'
215
- | 'credentials.us_bank_account.account_number';
216
- }
217
- }
218
-
219
- namespace MoneyManagement {
220
- interface FinancialAddressListParams {
221
- /**
222
- * The ID of the FinancialAccount for which FinancialAddresses are to be returned.
223
- */
224
- financial_account?: string;
225
-
226
- /**
227
- * Open Enum. A list of fields to reveal in the FinancialAddresses returned.
228
- */
229
- include?: Array<FinancialAddressListParams.Include>;
230
-
231
- /**
232
- * The page limit.
233
- */
234
- limit?: number;
235
- }
236
-
237
- namespace FinancialAddressListParams {
238
- type Include =
239
- | 'credentials.gb_bank_account.account_number'
240
- | 'credentials.us_bank_account.account_number';
241
- }
242
- }
243
-
244
- namespace MoneyManagement {
245
- class FinancialAddressesResource {
246
- /**
247
- * Create a new FinancialAddress for a FinancialAccount.
248
- * @throws Stripe.FinancialAccountNotOpenError
249
- */
250
- create(
251
- params: FinancialAddressCreateParams,
252
- options?: RequestOptions
253
- ): Promise<
254
- Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
255
- >;
256
-
257
- /**
258
- * Retrieve a FinancialAddress. By default, the FinancialAddress will be returned in it's unexpanded state, revealing only the last 4 digits of the account number.
259
- */
260
- retrieve(
261
- id: string,
262
- params?: FinancialAddressRetrieveParams,
263
- options?: RequestOptions
264
- ): Promise<
265
- Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
266
- >;
267
- retrieve(
268
- id: string,
269
- options?: RequestOptions
270
- ): Promise<
271
- Stripe.Response<Stripe.V2.MoneyManagement.FinancialAddress>
272
- >;
273
-
274
- /**
275
- * List all FinancialAddresses for a FinancialAccount.
276
- */
277
- list(
278
- params?: FinancialAddressListParams,
279
- options?: RequestOptions
280
- ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAddress>;
281
- list(
282
- options?: RequestOptions
283
- ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAddress>;
284
- }
285
- }
286
- }
287
- }
288
- }