stripe 18.0.0 → 18.1.0-beta.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.
Files changed (303) hide show
  1. package/CHANGELOG.md +1187 -110
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +1 -3
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +91 -1
  6. package/cjs/apiVersion.js +1 -1
  7. package/cjs/resources/AccountNotices.js +21 -0
  8. package/cjs/resources/BalanceSettings.js +10 -0
  9. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  10. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  11. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  12. package/cjs/resources/ExternalAccounts.js +23 -0
  13. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  14. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  15. package/cjs/resources/GiftCards/Cards.js +23 -0
  16. package/cjs/resources/GiftCards/Transactions.js +33 -0
  17. package/cjs/resources/Invoices.js +17 -0
  18. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  19. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  20. package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
  21. package/cjs/resources/Margins.js +22 -0
  22. package/cjs/resources/Orders.js +24 -0
  23. package/cjs/resources/{InvoicePayments.js → PaymentAttemptRecords.js} +4 -4
  24. package/cjs/resources/PaymentIntents.js +8 -0
  25. package/cjs/resources/PaymentRecords.js +29 -0
  26. package/cjs/resources/Privacy/RedactionJobs.js +46 -0
  27. package/cjs/resources/Quotes.js +32 -0
  28. package/cjs/resources/SubscriptionSchedules.js +4 -0
  29. package/cjs/resources/Tax/Associations.js +9 -0
  30. package/cjs/resources/Tax/Forms.js +20 -0
  31. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  32. package/cjs/resources/Terminal/Readers.js +12 -0
  33. package/cjs/resources/TestHelpers/Terminal/Readers.js +8 -0
  34. package/cjs/resources/V2/Core/AccountLinks.js +9 -0
  35. package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
  36. package/cjs/resources/V2/Core/Accounts.js +25 -0
  37. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +28 -0
  38. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +24 -0
  39. package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
  40. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +17 -0
  41. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
  42. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
  43. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +12 -0
  44. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
  45. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
  46. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
  47. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
  48. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
  49. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
  50. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
  51. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
  52. package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
  53. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
  54. package/cjs/resources.js +106 -18
  55. package/cjs/stripe.core.js +1 -1
  56. package/esm/Error.js +79 -0
  57. package/esm/apiVersion.js +1 -1
  58. package/esm/resources/AccountNotices.js +18 -0
  59. package/esm/resources/BalanceSettings.js +7 -0
  60. package/esm/resources/Capital/FinancingOffers.js +18 -0
  61. package/esm/resources/Capital/FinancingSummary.js +9 -0
  62. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  63. package/esm/resources/ExternalAccounts.js +20 -0
  64. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  65. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  66. package/esm/resources/GiftCards/Cards.js +20 -0
  67. package/esm/resources/GiftCards/Transactions.js +30 -0
  68. package/esm/resources/Invoices.js +17 -0
  69. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  70. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  71. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  72. package/esm/resources/Margins.js +19 -0
  73. package/esm/resources/Orders.js +21 -0
  74. package/esm/resources/{InvoicePayments.js → PaymentAttemptRecords.js} +3 -3
  75. package/esm/resources/PaymentIntents.js +8 -0
  76. package/esm/resources/PaymentRecords.js +26 -0
  77. package/esm/resources/Privacy/RedactionJobs.js +43 -0
  78. package/esm/resources/Quotes.js +32 -0
  79. package/esm/resources/SubscriptionSchedules.js +4 -0
  80. package/esm/resources/Tax/Associations.js +6 -0
  81. package/esm/resources/Tax/Forms.js +17 -0
  82. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  83. package/esm/resources/Terminal/Readers.js +12 -0
  84. package/esm/resources/TestHelpers/Terminal/Readers.js +8 -0
  85. package/esm/resources/V2/Core/AccountLinks.js +6 -0
  86. package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
  87. package/esm/resources/V2/Core/Accounts.js +22 -0
  88. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +25 -0
  89. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +21 -0
  90. package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
  91. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +14 -0
  92. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
  93. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
  94. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +9 -0
  95. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
  96. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
  97. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
  98. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
  99. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
  100. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
  101. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
  102. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
  103. package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
  104. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
  105. package/esm/resources.js +83 -1
  106. package/esm/stripe.core.js +1 -1
  107. package/package.json +1 -1
  108. package/types/AccountLinksResource.d.ts +5 -1
  109. package/types/AccountNotices.d.ts +113 -0
  110. package/types/AccountNoticesResource.d.ts +98 -0
  111. package/types/AccountSessions.d.ts +45 -0
  112. package/types/AccountSessionsResource.d.ts +300 -0
  113. package/types/Accounts.d.ts +228 -1
  114. package/types/AccountsResource.d.ts +572 -0
  115. package/types/BalanceSettings.d.ts +85 -0
  116. package/types/BalanceSettingsResource.d.ts +108 -0
  117. package/types/BankAccounts.d.ts +2 -0
  118. package/types/Billing/CreditBalanceSummary.d.ts +5 -0
  119. package/types/Billing/CreditBalanceSummaryResource.d.ts +8 -3
  120. package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
  121. package/types/Billing/CreditGrants.d.ts +5 -0
  122. package/types/Billing/CreditGrantsResource.d.ts +11 -1
  123. package/types/Billing/MeterErrorReports.d.ts +106 -0
  124. package/types/BillingPortal/Sessions.d.ts +5 -0
  125. package/types/BillingPortal/SessionsResource.d.ts +12 -4
  126. package/types/Capabilities.d.ts +2 -0
  127. package/types/Capital/FinancingOffers.d.ts +188 -0
  128. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  129. package/types/Capital/FinancingSummary.d.ts +106 -0
  130. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  131. package/types/Capital/FinancingTransactions.d.ts +135 -0
  132. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  133. package/types/Cards.d.ts +5 -0
  134. package/types/CashBalances.d.ts +5 -0
  135. package/types/Charges.d.ts +166 -0
  136. package/types/ChargesResource.d.ts +1294 -0
  137. package/types/Checkout/Sessions.d.ts +335 -4
  138. package/types/Checkout/SessionsResource.d.ts +270 -2
  139. package/types/ConfirmationTokens.d.ts +151 -0
  140. package/types/Coupons.d.ts +1 -1
  141. package/types/CreditNoteLineItems.d.ts +17 -0
  142. package/types/CreditNotes.d.ts +9 -0
  143. package/types/CreditNotesResource.d.ts +5 -0
  144. package/types/CustomerBalanceTransactions.d.ts +2 -0
  145. package/types/CustomerCashBalanceTransactions.d.ts +2 -0
  146. package/types/CustomerSessions.d.ts +5 -0
  147. package/types/CustomerSessionsResource.d.ts +6 -1
  148. package/types/Customers.d.ts +2 -0
  149. package/types/CustomersResource.d.ts +8 -0
  150. package/types/Discounts.d.ts +10 -0
  151. package/types/Errors.d.ts +69 -2
  152. package/types/EventTypes.d.ts +681 -0
  153. package/types/Events.d.ts +101 -1
  154. package/types/ExternalAccountsResource.d.ts +304 -0
  155. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  156. package/types/FinancialConnections/Accounts.d.ts +31 -1
  157. package/types/FinancialConnections/AccountsResource.d.ts +40 -3
  158. package/types/FinancialConnections/Institutions.d.ts +93 -0
  159. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  160. package/types/FinancialConnections/Sessions.d.ts +51 -1
  161. package/types/FinancialConnections/SessionsResource.d.ts +43 -1
  162. package/types/GiftCards/Cards.d.ts +118 -0
  163. package/types/GiftCards/CardsResource.d.ts +159 -0
  164. package/types/GiftCards/Transactions.d.ts +129 -0
  165. package/types/GiftCards/TransactionsResource.d.ts +201 -0
  166. package/types/Identity/VerificationSessions.d.ts +5 -0
  167. package/types/Identity/VerificationSessionsResource.d.ts +7 -0
  168. package/types/InvoiceItems.d.ts +10 -0
  169. package/types/InvoiceItemsResource.d.ts +117 -6
  170. package/types/InvoiceLineItems.d.ts +45 -1
  171. package/types/InvoicePayments.d.ts +5 -0
  172. package/types/Invoices.d.ts +142 -3
  173. package/types/InvoicesResource.d.ts +1546 -4
  174. package/types/Issuing/CardholdersResource.d.ts +2 -1
  175. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  176. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  177. package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
  178. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  179. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  180. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  181. package/types/Issuing/Settlements.d.ts +113 -0
  182. package/types/Issuing/Transactions.d.ts +5 -0
  183. package/types/Issuing/TransactionsResource.d.ts +5 -0
  184. package/types/LineItems.d.ts +49 -0
  185. package/types/LoginLinks.d.ts +2 -1
  186. package/types/Mandates.d.ts +77 -0
  187. package/types/Margins.d.ts +56 -0
  188. package/types/MarginsResource.d.ts +114 -0
  189. package/types/Orders.d.ts +1189 -0
  190. package/types/OrdersResource.d.ts +2981 -0
  191. package/types/PaymentAttemptRecords.d.ts +2112 -0
  192. package/types/PaymentAttemptRecordsResource.d.ts +47 -0
  193. package/types/PaymentIntents.d.ts +680 -2
  194. package/types/PaymentIntentsResource.d.ts +8438 -3942
  195. package/types/PaymentLinks.d.ts +6 -0
  196. package/types/PaymentLinksResource.d.ts +12 -0
  197. package/types/PaymentMethodConfigurations.d.ts +180 -0
  198. package/types/PaymentMethodConfigurationsResource.d.ts +250 -0
  199. package/types/PaymentMethodDomains.d.ts +28 -0
  200. package/types/PaymentMethods.d.ts +120 -0
  201. package/types/PaymentMethodsResource.d.ts +170 -5
  202. package/types/PaymentRecords.d.ts +2105 -0
  203. package/types/PaymentRecordsResource.d.ts +455 -0
  204. package/types/Payouts.d.ts +5 -0
  205. package/types/PayoutsResource.d.ts +5 -0
  206. package/types/Persons.d.ts +2 -0
  207. package/types/Prices.d.ts +22 -0
  208. package/types/PricesResource.d.ts +22 -0
  209. package/types/Privacy/RedactionJobRootObjects.d.ts +35 -0
  210. package/types/Privacy/RedactionJobValidationErrors.d.ts +30 -0
  211. package/types/Privacy/RedactionJobs.d.ts +43 -0
  212. package/types/Privacy/RedactionJobsResource.d.ts +240 -0
  213. package/types/Products.d.ts +39 -0
  214. package/types/ProductsResource.d.ts +36 -0
  215. package/types/PromotionCodes.d.ts +5 -0
  216. package/types/PromotionCodesResource.d.ts +10 -0
  217. package/types/QuoteLines.d.ts +634 -0
  218. package/types/QuotePreviewInvoices.d.ts +1686 -0
  219. package/types/QuotePreviewSubscriptionSchedules.d.ts +778 -0
  220. package/types/Quotes.d.ts +601 -1
  221. package/types/QuotesResource.d.ts +2565 -218
  222. package/types/Refunds.d.ts +14 -0
  223. package/types/SetupAttempts.d.ts +51 -1
  224. package/types/SetupIntents.d.ts +122 -2
  225. package/types/SetupIntentsResource.d.ts +739 -12
  226. package/types/Sources.d.ts +29 -0
  227. package/types/SubscriptionItems.d.ts +23 -0
  228. package/types/SubscriptionItemsResource.d.ts +109 -0
  229. package/types/SubscriptionSchedules.d.ts +205 -0
  230. package/types/SubscriptionSchedulesResource.d.ts +1237 -9
  231. package/types/Subscriptions.d.ts +97 -1
  232. package/types/SubscriptionsResource.d.ts +390 -8
  233. package/types/Tax/Associations.d.ts +126 -0
  234. package/types/Tax/AssociationsResource.d.ts +29 -0
  235. package/types/Tax/CalculationLineItems.d.ts +1 -1
  236. package/types/Tax/Forms.d.ts +220 -0
  237. package/types/Tax/FormsResource.d.ts +107 -0
  238. package/types/Tax/Registrations.d.ts +9 -0
  239. package/types/Tax/RegistrationsResource.d.ts +12 -0
  240. package/types/TaxIds.d.ts +10 -0
  241. package/types/TaxIdsResource.d.ts +10 -0
  242. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  243. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  244. package/types/Terminal/Readers.d.ts +300 -0
  245. package/types/Terminal/ReadersResource.d.ts +220 -0
  246. package/types/TestHelpers/ConfirmationTokensResource.d.ts +174 -3
  247. package/types/TestHelpers/Terminal/ReadersResource.d.ts +53 -0
  248. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  249. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  250. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  251. package/types/Treasury/FinancialAccounts.d.ts +5 -0
  252. package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
  253. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  254. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  255. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  256. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  257. package/types/V2/Core/AccountLinks.d.ts +101 -0
  258. package/types/V2/Core/AccountLinksResource.d.ts +90 -0
  259. package/types/V2/Core/Accounts/PersonsResource.d.ts +3760 -0
  260. package/types/V2/Core/Accounts.d.ts +8057 -0
  261. package/types/V2/Core/AccountsResource.d.ts +10184 -0
  262. package/types/V2/Core/Persons.d.ts +1857 -0
  263. package/types/V2/Core/Vault/GbBankAccounts.d.ts +155 -0
  264. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +172 -0
  265. package/types/V2/Core/Vault/UsBankAccounts.d.ts +65 -0
  266. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +123 -0
  267. package/types/V2/EventTypes.d.ts +683 -1
  268. package/types/V2/FinancialAddressCreditSimulations.d.ts +22 -0
  269. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +27 -0
  270. package/types/V2/MoneyManagement/Adjustments.d.ts +105 -0
  271. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
  272. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +540 -0
  273. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +52 -0
  274. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +308 -0
  275. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +287 -0
  276. package/types/V2/MoneyManagement/InboundTransfers.d.ts +201 -0
  277. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
  278. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +141 -0
  279. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +93 -0
  280. package/types/V2/MoneyManagement/OutboundPayments.d.ts +273 -0
  281. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +242 -0
  282. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +92 -0
  283. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +296 -0
  284. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +246 -0
  285. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +207 -0
  286. package/types/V2/MoneyManagement/PayoutMethods.d.ts +146 -0
  287. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
  288. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +82 -0
  289. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
  290. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +280 -0
  291. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
  292. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +219 -0
  293. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
  294. package/types/V2/MoneyManagement/TransactionEntries.d.ts +151 -0
  295. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
  296. package/types/V2/MoneyManagement/Transactions.d.ts +166 -0
  297. package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
  298. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +66 -0
  299. package/types/WebhookEndpointsResource.d.ts +82 -2
  300. package/types/index.d.ts +142 -5
  301. package/types/lib.d.ts +11 -1
  302. package/types/test/typescriptTest.ts +3 -3
  303. package/types/InvoicePaymentsResource.d.ts +0 -74
@@ -66,6 +66,11 @@ declare module 'stripe' {
66
66
  */
67
67
  network: ReceivedCredit.Network;
68
68
 
69
+ /**
70
+ * Details specific to the money movement rails.
71
+ */
72
+ network_details?: ReceivedCredit.NetworkDetails | null;
73
+
69
74
  /**
70
75
  * Details describing when a ReceivedCredit may be reversed.
71
76
  */
@@ -251,6 +256,27 @@ declare module 'stripe' {
251
256
 
252
257
  type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
253
258
 
259
+ interface NetworkDetails {
260
+ /**
261
+ * Details about an ACH transaction.
262
+ */
263
+ ach?: NetworkDetails.Ach | null;
264
+
265
+ /**
266
+ * The type of flow that originated the ReceivedCredit.
267
+ */
268
+ type: 'ach';
269
+ }
270
+
271
+ namespace NetworkDetails {
272
+ interface Ach {
273
+ /**
274
+ * ACH Addenda record
275
+ */
276
+ addenda: string | null;
277
+ }
278
+ }
279
+
254
280
  interface ReversalDetails {
255
281
  /**
256
282
  * Time before which a ReceivedCredit can be reversed.
@@ -66,6 +66,11 @@ declare module 'stripe' {
66
66
  */
67
67
  network: ReceivedDebit.Network;
68
68
 
69
+ /**
70
+ * Details specific to the money movement rails.
71
+ */
72
+ network_details?: ReceivedDebit.NetworkDetails | null;
73
+
69
74
  /**
70
75
  * Details describing when a ReceivedDebit might be reversed.
71
76
  */
@@ -190,10 +195,36 @@ declare module 'stripe' {
190
195
  * Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
191
196
  */
192
197
  payout: string | null;
198
+
199
+ /**
200
+ * The ReceivedCredit that Capital withheld from
201
+ */
202
+ received_credit_capital_withholding?: string | null;
193
203
  }
194
204
 
195
205
  type Network = 'ach' | 'card' | 'stripe';
196
206
 
207
+ interface NetworkDetails {
208
+ /**
209
+ * Details about an ACH transaction.
210
+ */
211
+ ach?: NetworkDetails.Ach | null;
212
+
213
+ /**
214
+ * The type of flow that originated the ReceivedDebit.
215
+ */
216
+ type: 'ach';
217
+ }
218
+
219
+ namespace NetworkDetails {
220
+ interface Ach {
221
+ /**
222
+ * ACH Addenda record
223
+ */
224
+ addenda: string | null;
225
+ }
226
+ }
227
+
197
228
  interface ReversalDetails {
198
229
  /**
199
230
  * Time before which a ReceivedDebit can be reversed.
@@ -0,0 +1,101 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace V2 {
6
+ namespace Core {
7
+ /**
8
+ * AccountLinks are the means by which a Merchant grants an Account permission to access Stripe-hosted application, such as Recipient Onboarding.
9
+ */
10
+ interface AccountLink {
11
+ /**
12
+ * String representing the object's type. Objects of the same type share the same value of the object field.
13
+ */
14
+ object: 'v2.core.account_link';
15
+
16
+ /**
17
+ * The ID of the Account the link was created for.
18
+ */
19
+ account: string;
20
+
21
+ /**
22
+ * The timestamp at which this AccountLink was created.
23
+ */
24
+ created: string;
25
+
26
+ /**
27
+ * The timestamp at which this AccountLink will expire.
28
+ */
29
+ expires_at: string;
30
+
31
+ /**
32
+ * The URL for the AccountLink.
33
+ */
34
+ url: string;
35
+
36
+ /**
37
+ * The use case of AccountLink the user is requesting.
38
+ */
39
+ use_case: AccountLink.UseCase;
40
+ }
41
+
42
+ namespace AccountLink {
43
+ interface UseCase {
44
+ /**
45
+ * Open Enum. The type of AccountLink the user is requesting.
46
+ */
47
+ type: UseCase.Type;
48
+
49
+ /**
50
+ * Indicates that the AccountLink provided should onboard an account.
51
+ */
52
+ account_onboarding: UseCase.AccountOnboarding | null;
53
+
54
+ /**
55
+ * Indicates that the AccountLink provided should update a previously onboarded account.
56
+ */
57
+ account_update: UseCase.AccountUpdate | null;
58
+ }
59
+
60
+ namespace UseCase {
61
+ interface AccountOnboarding {
62
+ /**
63
+ * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
64
+ */
65
+ configurations: Array<'recipient'>;
66
+
67
+ /**
68
+ * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
69
+ */
70
+ refresh_url: string;
71
+
72
+ /**
73
+ * The URL that the user will be redirected to upon completing the linked flow.
74
+ */
75
+ return_url: string | null;
76
+ }
77
+
78
+ interface AccountUpdate {
79
+ /**
80
+ * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
81
+ */
82
+ configurations: Array<'recipient'>;
83
+
84
+ /**
85
+ * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
86
+ */
87
+ refresh_url: string;
88
+
89
+ /**
90
+ * The URL that the user will be redirected to upon completing the linked flow.
91
+ */
92
+ return_url: string | null;
93
+ }
94
+
95
+ type Type = 'account_onboarding' | 'account_update';
96
+ }
97
+ }
98
+ }
99
+ }
100
+ }
101
+ }
@@ -0,0 +1,90 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace V2 {
6
+ namespace Core {
7
+ interface AccountLinkCreateParams {
8
+ /**
9
+ * The ID of the Account to create link for.
10
+ */
11
+ account: string;
12
+
13
+ /**
14
+ * The use case of the AccountLink.
15
+ */
16
+ use_case: AccountLinkCreateParams.UseCase;
17
+ }
18
+
19
+ namespace AccountLinkCreateParams {
20
+ interface UseCase {
21
+ /**
22
+ * Open Enum. The type of AccountLink the user is requesting.
23
+ */
24
+ type: UseCase.Type;
25
+
26
+ /**
27
+ * Indicates that the AccountLink provided should onboard an account.
28
+ */
29
+ account_onboarding?: UseCase.AccountOnboarding;
30
+
31
+ /**
32
+ * Indicates that the AccountLink provided should update a previously onboarded account.
33
+ */
34
+ account_update?: UseCase.AccountUpdate;
35
+ }
36
+
37
+ namespace UseCase {
38
+ interface AccountOnboarding {
39
+ /**
40
+ * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
41
+ */
42
+ configurations: Array<'recipient'>;
43
+
44
+ /**
45
+ * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
46
+ */
47
+ refresh_url: string;
48
+
49
+ /**
50
+ * The URL that the user will be redirected to upon completing the linked flow.
51
+ */
52
+ return_url?: string;
53
+ }
54
+
55
+ interface AccountUpdate {
56
+ /**
57
+ * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
58
+ */
59
+ configurations: Array<'recipient'>;
60
+
61
+ /**
62
+ * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
63
+ */
64
+ refresh_url: string;
65
+
66
+ /**
67
+ * The URL that the user will be redirected to upon completing the linked flow.
68
+ */
69
+ return_url?: string;
70
+ }
71
+
72
+ type Type = 'account_onboarding' | 'account_update';
73
+ }
74
+ }
75
+ }
76
+
77
+ namespace Core {
78
+ class AccountLinksResource {
79
+ /**
80
+ * Creates an AccountLink object that includes a single-use Stripe URL that the merchant can redirect their user to in order to take them to a Stripe-hosted application such as Recipient Onboarding.
81
+ */
82
+ create(
83
+ params: AccountLinkCreateParams,
84
+ options?: RequestOptions
85
+ ): Promise<Stripe.Response<Stripe.V2.Core.AccountLink>>;
86
+ }
87
+ }
88
+ }
89
+ }
90
+ }