stripe 20.2.0-alpha.1 → 20.2.0-beta.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 (261) hide show
  1. package/CHANGELOG.md +45 -460
  2. package/OPENAPI_VERSION +1 -1
  3. package/VERSION +1 -1
  4. package/cjs/Error.js +1 -9
  5. package/cjs/StripeEventNotificationHandler.js +118 -0
  6. package/cjs/resources/PaymentMethods.js +0 -4
  7. package/cjs/resources/Reserve/Holds.js +14 -0
  8. package/cjs/resources/{ProductCatalog/TrialOffers.js → Reserve/Plans.js} +3 -6
  9. package/cjs/resources/{SharedPayment/GrantedTokens.js → Reserve/Releases.js} +8 -3
  10. package/cjs/resources.js +11 -77
  11. package/cjs/stripe.core.js +5 -1
  12. package/esm/Error.js +0 -7
  13. package/esm/StripeEventNotificationHandler.js +114 -0
  14. package/esm/resources/PaymentMethods.js +0 -4
  15. package/esm/resources/Reserve/Holds.js +11 -0
  16. package/esm/resources/Reserve/Plans.js +6 -0
  17. package/esm/resources/Reserve/Releases.js +14 -0
  18. package/esm/resources.js +7 -72
  19. package/esm/stripe.core.js +5 -1
  20. package/package.json +1 -1
  21. package/types/AccountSessions.d.ts +0 -18
  22. package/types/AccountSessionsResource.d.ts +0 -21
  23. package/types/AccountsResource.d.ts +12 -136
  24. package/types/ApplicationFees.d.ts +1 -6
  25. package/types/Balance.d.ts +0 -82
  26. package/types/BalanceTransactions.d.ts +1 -2
  27. package/types/Billing/AlertTriggereds.d.ts +0 -15
  28. package/types/Billing/Alerts.d.ts +1 -116
  29. package/types/Billing/AlertsResource.d.ts +2 -149
  30. package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -5
  31. package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -7
  32. package/types/Billing/CreditBalanceSummary.d.ts +2 -118
  33. package/types/Billing/CreditBalanceSummaryResource.d.ts +0 -12
  34. package/types/Billing/CreditBalanceTransactions.d.ts +2 -118
  35. package/types/Billing/CreditGrants.d.ts +1 -71
  36. package/types/Billing/CreditGrantsResource.d.ts +1 -32
  37. package/types/Billing/MeterEventSummaries.d.ts +0 -7
  38. package/types/Billing/Meters.d.ts +0 -5
  39. package/types/Billing/MetersResource.d.ts +0 -17
  40. package/types/Cards.d.ts +0 -14
  41. package/types/Charges.d.ts +0 -14
  42. package/types/Checkout/Sessions.d.ts +0 -58
  43. package/types/Checkout/SessionsResource.d.ts +0 -78
  44. package/types/ConfirmationTokens.d.ts +0 -14
  45. package/types/Discounts.d.ts +0 -10
  46. package/types/Errors.d.ts +0 -6
  47. package/types/Identity/VerificationReports.d.ts +0 -10
  48. package/types/Identity/VerificationReportsResource.d.ts +0 -5
  49. package/types/InvoiceItems.d.ts +3 -118
  50. package/types/InvoiceLineItems.d.ts +8 -127
  51. package/types/Invoices.d.ts +0 -13
  52. package/types/InvoicesResource.d.ts +0 -201
  53. package/types/Issuing/Cards.d.ts +0 -10
  54. package/types/Issuing/CardsResource.d.ts +0 -33
  55. package/types/PaymentIntents.d.ts +1 -45
  56. package/types/PaymentIntentsResource.d.ts +5 -126
  57. package/types/PaymentLinksResource.d.ts +0 -14
  58. package/types/PaymentMethods.d.ts +0 -14
  59. package/types/PaymentMethodsResource.d.ts +0 -20
  60. package/types/Persons.d.ts +0 -28
  61. package/types/ProductsResource.d.ts +0 -24
  62. package/types/QuoteLines.d.ts +0 -17
  63. package/types/QuotePreviewInvoices.d.ts +0 -13
  64. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -126
  65. package/types/Quotes.d.ts +0 -282
  66. package/types/QuotesResource.d.ts +44 -662
  67. package/types/Reserve/Holds.d.ts +104 -0
  68. package/types/Reserve/HoldsResource.d.ts +76 -0
  69. package/types/Reserve/Plans.d.ts +103 -0
  70. package/types/{SharedPayment/GrantedTokensResource.d.ts → Reserve/PlansResource.d.ts} +7 -7
  71. package/types/Reserve/Releases.d.ts +105 -0
  72. package/types/Reserve/ReleasesResource.d.ts +60 -0
  73. package/types/SetupIntents.d.ts +0 -21
  74. package/types/SetupIntentsResource.d.ts +0 -90
  75. package/types/SubscriptionItems.d.ts +0 -13
  76. package/types/SubscriptionItemsResource.d.ts +0 -34
  77. package/types/SubscriptionSchedules.d.ts +0 -124
  78. package/types/SubscriptionSchedulesResource.d.ts +0 -238
  79. package/types/Subscriptions.d.ts +0 -22
  80. package/types/SubscriptionsResource.d.ts +0 -34
  81. package/types/TokensResource.d.ts +0 -68
  82. package/types/Transfers.d.ts +0 -4
  83. package/types/TransfersResource.d.ts +0 -2
  84. package/types/V2/Billing/Cadences.d.ts +0 -45
  85. package/types/V2/Billing/CadencesResource.d.ts +3 -32
  86. package/types/V2/Core/AccountTokensResource.d.ts +0 -245
  87. package/types/V2/Core/Accounts.d.ts +1 -1473
  88. package/types/V2/Core/AccountsResource.d.ts +0 -1644
  89. package/types/V2/Core/EventTypes.d.ts +702 -4551
  90. package/types/V2/Core/Events.d.ts +0 -61
  91. package/types/V2/Core/EventsResource.d.ts +1 -11
  92. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -21
  93. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -21
  94. package/types/V2/EventMisc.d.ts +37 -0
  95. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +1 -31
  96. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -7
  97. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +1 -4
  98. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +1 -18
  99. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -8
  100. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -7
  101. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -12
  102. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -12
  103. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -34
  104. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -5
  105. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -5
  106. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -62
  107. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +1 -34
  108. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +1 -61
  109. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +1 -6
  110. package/types/WebhookEndpointsResource.d.ts +2 -1
  111. package/types/Webhooks.d.ts +0 -2
  112. package/types/index.d.ts +25 -122
  113. package/types/test/typescriptTest.ts +27 -0
  114. package/cjs/resources/BalanceTransfers.js +0 -9
  115. package/cjs/resources/DelegatedCheckout/RequestedSessions.js +0 -28
  116. package/cjs/resources/Identity/BlocklistEntries.js +0 -25
  117. package/cjs/resources/Issuing/Programs.js +0 -22
  118. package/cjs/resources/Radar/AccountEvaluations.js +0 -20
  119. package/cjs/resources/TestHelpers/Capital/FinancingOffers.js +0 -16
  120. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +0 -16
  121. package/cjs/resources/V2/Billing/CustomPricingUnits.js +0 -25
  122. package/cjs/resources/V2/Billing/Intents/Actions.js +0 -17
  123. package/cjs/resources/V2/Billing/Intents.js +0 -36
  124. package/cjs/resources/V2/Billing/LicenseFeeSubscriptions.js +0 -12
  125. package/cjs/resources/V2/Billing/LicenseFees/Versions.js +0 -17
  126. package/cjs/resources/V2/Billing/LicenseFees.js +0 -27
  127. package/cjs/resources/V2/Billing/LicensedItems.js +0 -25
  128. package/cjs/resources/V2/Billing/MeteredItems.js +0 -22
  129. package/cjs/resources/V2/Billing/PricingPlanSubscriptions/Components.js +0 -12
  130. package/cjs/resources/V2/Billing/PricingPlanSubscriptions.js +0 -26
  131. package/cjs/resources/V2/Billing/PricingPlans/Components.js +0 -29
  132. package/cjs/resources/V2/Billing/PricingPlans/Versions.js +0 -17
  133. package/cjs/resources/V2/Billing/PricingPlans.js +0 -29
  134. package/cjs/resources/V2/Billing/RateCardSubscriptions.js +0 -29
  135. package/cjs/resources/V2/Billing/RateCards/Rates.js +0 -25
  136. package/cjs/resources/V2/Billing/RateCards/Versions.js +0 -17
  137. package/cjs/resources/V2/Billing/RateCards.js +0 -29
  138. package/cjs/resources/V2/Billing/ServiceActions.js +0 -20
  139. package/cjs/resources/V2/Core/ClaimableSandboxes.js +0 -16
  140. package/cjs/resources/V2/Iam/ApiKeys.js +0 -24
  141. package/cjs/resources/V2/MoneyManagement/CurrencyConversions.js +0 -21
  142. package/cjs/resources/V2/MoneyManagement/RecipientVerifications.js +0 -20
  143. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -29
  144. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +0 -20
  145. package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +0 -33
  146. package/cjs/resources/V2/Reporting/ReportRuns.js +0 -13
  147. package/cjs/resources/V2/Reporting/Reports.js +0 -12
  148. package/cjs/resources/V2/Tax/ManualRules.js +0 -23
  149. package/cjs/resources/V2/TestHelpers/MoneyManagement.js +0 -12
  150. package/esm/resources/BalanceTransfers.js +0 -6
  151. package/esm/resources/DelegatedCheckout/RequestedSessions.js +0 -25
  152. package/esm/resources/Identity/BlocklistEntries.js +0 -22
  153. package/esm/resources/Issuing/Programs.js +0 -19
  154. package/esm/resources/ProductCatalog/TrialOffers.js +0 -9
  155. package/esm/resources/Radar/AccountEvaluations.js +0 -17
  156. package/esm/resources/SharedPayment/GrantedTokens.js +0 -9
  157. package/esm/resources/TestHelpers/Capital/FinancingOffers.js +0 -13
  158. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +0 -13
  159. package/esm/resources/V2/Billing/CustomPricingUnits.js +0 -22
  160. package/esm/resources/V2/Billing/Intents/Actions.js +0 -14
  161. package/esm/resources/V2/Billing/Intents.js +0 -33
  162. package/esm/resources/V2/Billing/LicenseFeeSubscriptions.js +0 -9
  163. package/esm/resources/V2/Billing/LicenseFees/Versions.js +0 -14
  164. package/esm/resources/V2/Billing/LicenseFees.js +0 -24
  165. package/esm/resources/V2/Billing/LicensedItems.js +0 -22
  166. package/esm/resources/V2/Billing/MeteredItems.js +0 -19
  167. package/esm/resources/V2/Billing/PricingPlanSubscriptions/Components.js +0 -9
  168. package/esm/resources/V2/Billing/PricingPlanSubscriptions.js +0 -23
  169. package/esm/resources/V2/Billing/PricingPlans/Components.js +0 -26
  170. package/esm/resources/V2/Billing/PricingPlans/Versions.js +0 -14
  171. package/esm/resources/V2/Billing/PricingPlans.js +0 -26
  172. package/esm/resources/V2/Billing/RateCardSubscriptions.js +0 -26
  173. package/esm/resources/V2/Billing/RateCards/Rates.js +0 -22
  174. package/esm/resources/V2/Billing/RateCards/Versions.js +0 -14
  175. package/esm/resources/V2/Billing/RateCards.js +0 -26
  176. package/esm/resources/V2/Billing/ServiceActions.js +0 -17
  177. package/esm/resources/V2/Core/ClaimableSandboxes.js +0 -13
  178. package/esm/resources/V2/Iam/ApiKeys.js +0 -21
  179. package/esm/resources/V2/MoneyManagement/CurrencyConversions.js +0 -18
  180. package/esm/resources/V2/MoneyManagement/RecipientVerifications.js +0 -17
  181. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -26
  182. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +0 -17
  183. package/esm/resources/V2/Payments/SettlementAllocationIntents.js +0 -30
  184. package/esm/resources/V2/Reporting/ReportRuns.js +0 -10
  185. package/esm/resources/V2/Reporting/Reports.js +0 -9
  186. package/esm/resources/V2/Tax/ManualRules.js +0 -20
  187. package/esm/resources/V2/TestHelpers/MoneyManagement.js +0 -9
  188. package/types/BalanceTransfers.d.ts +0 -122
  189. package/types/BalanceTransfersResource.d.ts +0 -87
  190. package/types/DelegatedCheckout/RequestedSessions.d.ts +0 -465
  191. package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +0 -701
  192. package/types/Identity/BlocklistEntries.d.ts +0 -78
  193. package/types/Identity/BlocklistEntriesResource.d.ts +0 -146
  194. package/types/Issuing/Programs.d.ts +0 -42
  195. package/types/Issuing/ProgramsResource.d.ts +0 -96
  196. package/types/PaymentMethodBalances.d.ts +0 -63
  197. package/types/ProductCatalog/TrialOffers.d.ts +0 -77
  198. package/types/ProductCatalog/TrialOffersResource.d.ts +0 -80
  199. package/types/Radar/AccountEvaluations.d.ts +0 -88
  200. package/types/Radar/AccountEvaluationsResource.d.ts +0 -148
  201. package/types/SharedPayment/GrantedTokens.d.ts +0 -102
  202. package/types/TestHelpers/Capital/FinancingOffersResource.d.ts +0 -130
  203. package/types/TestHelpers/SharedPayment/GrantedTokensResource.d.ts +0 -87
  204. package/types/TransitBalances.d.ts +0 -40
  205. package/types/V2/Billing/CustomPricingUnits.d.ts +0 -56
  206. package/types/V2/Billing/CustomPricingUnitsResource.d.ts +0 -122
  207. package/types/V2/Billing/IntentActions.d.ts +0 -564
  208. package/types/V2/Billing/Intents/ActionsResource.d.ts +0 -58
  209. package/types/V2/Billing/Intents.d.ts +0 -117
  210. package/types/V2/Billing/IntentsResource.d.ts +0 -674
  211. package/types/V2/Billing/LicenseFeeSubscriptions.d.ts +0 -64
  212. package/types/V2/Billing/LicenseFeeSubscriptionsResource.d.ts +0 -28
  213. package/types/V2/Billing/LicenseFeeVersions.d.ts +0 -106
  214. package/types/V2/Billing/LicenseFees/VersionsResource.d.ts +0 -58
  215. package/types/V2/Billing/LicenseFees.d.ts +0 -164
  216. package/types/V2/Billing/LicenseFeesResource.d.ts +0 -290
  217. package/types/V2/Billing/LicensedItems.d.ts +0 -73
  218. package/types/V2/Billing/LicensedItemsResource.d.ts +0 -157
  219. package/types/V2/Billing/MeteredItems.d.ts +0 -101
  220. package/types/V2/Billing/MeteredItemsResource.d.ts +0 -189
  221. package/types/V2/Billing/PricingPlanComponents.d.ts +0 -109
  222. package/types/V2/Billing/PricingPlanSubscriptionComponents.d.ts +0 -57
  223. package/types/V2/Billing/PricingPlanSubscriptions/ComponentsResource.d.ts +0 -40
  224. package/types/V2/Billing/PricingPlanSubscriptions.d.ts +0 -144
  225. package/types/V2/Billing/PricingPlanSubscriptionsResource.d.ts +0 -120
  226. package/types/V2/Billing/PricingPlanVersions.d.ts +0 -49
  227. package/types/V2/Billing/PricingPlans/ComponentsResource.d.ts +0 -197
  228. package/types/V2/Billing/PricingPlans/VersionsResource.d.ts +0 -58
  229. package/types/V2/Billing/PricingPlans.d.ts +0 -84
  230. package/types/V2/Billing/PricingPlansResource.d.ts +0 -151
  231. package/types/V2/Billing/RateCardRates.d.ts +0 -144
  232. package/types/V2/Billing/RateCardSubscriptions.d.ts +0 -144
  233. package/types/V2/Billing/RateCardSubscriptionsResource.d.ts +0 -157
  234. package/types/V2/Billing/RateCardVersions.d.ts +0 -39
  235. package/types/V2/Billing/RateCards/RatesResource.d.ts +0 -203
  236. package/types/V2/Billing/RateCards/VersionsResource.d.ts +0 -58
  237. package/types/V2/Billing/RateCards.d.ts +0 -98
  238. package/types/V2/Billing/RateCardsResource.d.ts +0 -162
  239. package/types/V2/Billing/ServiceActions.d.ts +0 -298
  240. package/types/V2/Billing/ServiceActionsResource.d.ts +0 -394
  241. package/types/V2/Core/ClaimableSandboxes.d.ts +0 -132
  242. package/types/V2/Core/ClaimableSandboxesResource.d.ts +0 -74
  243. package/types/V2/Iam/ApiKeys.d.ts +0 -154
  244. package/types/V2/Iam/ApiKeysResource.d.ts +0 -215
  245. package/types/V2/MoneyManagement/CurrencyConversions.d.ts +0 -98
  246. package/types/V2/MoneyManagement/CurrencyConversionsResource.d.ts +0 -141
  247. package/types/V2/MoneyManagement/RecipientVerifications.d.ts +0 -112
  248. package/types/V2/MoneyManagement/RecipientVerificationsResource.d.ts +0 -77
  249. package/types/V2/Payments/OffSessionPayments.d.ts +0 -249
  250. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -306
  251. package/types/V2/Payments/SettlementAllocationIntentSplits.d.ts +0 -111
  252. package/types/V2/Payments/SettlementAllocationIntents/SplitsResource.d.ts +0 -126
  253. package/types/V2/Payments/SettlementAllocationIntents.d.ts +0 -122
  254. package/types/V2/Payments/SettlementAllocationIntentsResource.d.ts +0 -168
  255. package/types/V2/Reporting/ReportRuns.d.ts +0 -154
  256. package/types/V2/Reporting/ReportRunsResource.d.ts +0 -75
  257. package/types/V2/Reporting/Reports.d.ts +0 -120
  258. package/types/V2/Reporting/ReportsResource.d.ts +0 -30
  259. package/types/V2/Tax/ManualRules.d.ts +0 -142
  260. package/types/V2/Tax/ManualRulesResource.d.ts +0 -292
  261. package/types/V2/TestHelpers/MoneyManagementResource.d.ts +0 -49
@@ -1,306 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Payments {
7
- interface OffSessionPaymentCreateParams {
8
- /**
9
- * The “presentment amount” to be collected from the customer.
10
- */
11
- amount: OffSessionPaymentCreateParams.Amount;
12
-
13
- /**
14
- * The frequency of the underlying payment.
15
- */
16
- cadence: OffSessionPaymentCreateParams.Cadence;
17
-
18
- /**
19
- * ID of the Customer to which this OffSessionPayment belongs.
20
- */
21
- customer: string;
22
-
23
- /**
24
- * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can
25
- * attach to an object. This can be useful for storing additional information about
26
- * the object in a structured format. Learn more about
27
- * [storing information in metadata](https://docs.stripe.com/payments/payment-intents#storing-information-in-metadata).
28
- */
29
- metadata: Stripe.MetadataParam;
30
-
31
- /**
32
- * ID of the payment method used in this OffSessionPayment.
33
- */
34
- payment_method: string;
35
-
36
- /**
37
- * Details about the capture configuration for the OffSessionPayment.
38
- */
39
- capture?: OffSessionPaymentCreateParams.Capture;
40
-
41
- /**
42
- * The account (if any) for which the funds of the OffSessionPayment are intended.
43
- */
44
- on_behalf_of?: string;
45
-
46
- /**
47
- * Payment method options for the off-session payment.
48
- */
49
- payment_method_options?: OffSessionPaymentCreateParams.PaymentMethodOptions;
50
-
51
- /**
52
- * Details about the payments orchestration configuration.
53
- */
54
- payments_orchestration?: OffSessionPaymentCreateParams.PaymentsOrchestration;
55
-
56
- /**
57
- * Details about the OffSessionPayment retries.
58
- */
59
- retry_details?: OffSessionPaymentCreateParams.RetryDetails;
60
-
61
- /**
62
- * Text that appears on the customer's statement as the statement descriptor for a
63
- * non-card charge. This value overrides the account's default statement descriptor.
64
- * For information about requirements, including the 22-character limit, see the
65
- * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
66
- */
67
- statement_descriptor?: string;
68
-
69
- /**
70
- * Provides information about a card charge. Concatenated to the account's
71
- * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
72
- * to form the complete statement descriptor that appears on the customer's statement.
73
- */
74
- statement_descriptor_suffix?: string;
75
-
76
- /**
77
- * Test clock that can be used to advance the retry attempts in a sandbox.
78
- */
79
- test_clock?: string;
80
-
81
- /**
82
- * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.stripe.com/payments/connected-accounts).
83
- */
84
- transfer_data?: OffSessionPaymentCreateParams.TransferData;
85
- }
86
-
87
- namespace OffSessionPaymentCreateParams {
88
- interface Amount {
89
- /**
90
- * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
91
- */
92
- value?: number;
93
-
94
- /**
95
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
96
- */
97
- currency?: string;
98
- }
99
-
100
- type Cadence = 'recurring' | 'unscheduled';
101
-
102
- interface Capture {
103
- /**
104
- * The method to use to capture the payment.
105
- */
106
- capture_method: Capture.CaptureMethod;
107
- }
108
-
109
- namespace Capture {
110
- type CaptureMethod = 'automatic' | 'manual';
111
- }
112
-
113
- interface PaymentMethodOptions {
114
- /**
115
- * Payment method options for the card payment type.
116
- */
117
- card?: PaymentMethodOptions.Card;
118
- }
119
-
120
- namespace PaymentMethodOptions {
121
- interface Card {
122
- /**
123
- * If you are making a Credential On File transaction with a previously saved card, you should pass the Network Transaction ID
124
- * from a prior initial authorization on Stripe (from a successful SetupIntent or a PaymentIntent with `setup_future_usage` set),
125
- * or one that you have obtained from another payment processor. This is a token from the network which uniquely identifies the transaction.
126
- * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.
127
- * Note that you should pass in a Network Transaction ID if you have one, regardless of whether this is a
128
- * Customer-Initiated Transaction (CIT) or a Merchant-Initiated Transaction (MIT).
129
- */
130
- network_transaction_id: string;
131
- }
132
- }
133
-
134
- interface PaymentsOrchestration {
135
- /**
136
- * True when you want to enable payments orchestration for this off-session payment. False otherwise.
137
- */
138
- enabled: boolean;
139
- }
140
-
141
- interface RetryDetails {
142
- /**
143
- * The pre-configured retry policy to use for the payment.
144
- */
145
- retry_policy?: string;
146
-
147
- /**
148
- * Indicates the strategy for how you want Stripe to retry the payment.
149
- */
150
- retry_strategy?: RetryDetails.RetryStrategy;
151
- }
152
-
153
- namespace RetryDetails {
154
- type RetryStrategy = 'best_available' | 'none';
155
- }
156
-
157
- interface TransferData {
158
- /**
159
- * The amount transferred to the destination account. This transfer will occur
160
- * automatically after the payment succeeds. If no amount is specified, by default
161
- * the entire payment amount is transferred to the destination account. The amount
162
- * must be less than or equal to the
163
- * [amount_requested](https://docs.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
164
- * and must be a positive integer representing how much to transfer in the smallest
165
- * currency unit (e.g., 100 cents to charge $1.00).
166
- */
167
- amount?: number;
168
-
169
- /**
170
- * The account (if any) that the payment is attributed to for tax reporting, and
171
- * where funds from the payment are transferred to after payment success.
172
- */
173
- destination: string;
174
- }
175
- }
176
- }
177
-
178
- namespace Payments {
179
- interface OffSessionPaymentRetrieveParams {}
180
- }
181
-
182
- namespace Payments {
183
- interface OffSessionPaymentListParams {
184
- /**
185
- * The page size limit. If not provided, the default is 20.
186
- */
187
- limit?: number;
188
- }
189
- }
190
-
191
- namespace Payments {
192
- interface OffSessionPaymentCancelParams {}
193
- }
194
-
195
- namespace Payments {
196
- interface OffSessionPaymentCaptureParams {
197
- /**
198
- * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can
199
- * attach to an object. This can be useful for storing additional information about
200
- * the object in a structured format. Learn more about
201
- * [storing information in metadata](https://docs.stripe.com/payments/payment-intents#storing-information-in-metadata).
202
- */
203
- metadata: Stripe.MetadataParam;
204
-
205
- /**
206
- * The amount to capture.
207
- */
208
- amount_to_capture?: number;
209
-
210
- /**
211
- * Text that appears on the customer's statement as the statement descriptor for a
212
- * non-card charge. This value overrides the account's default statement descriptor.
213
- * For information about requirements, including the 22-character limit, see the
214
- * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
215
- */
216
- statement_descriptor?: string;
217
-
218
- /**
219
- * Provides information about a card charge. Concatenated to the account's
220
- * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
221
- * to form the complete statement descriptor that appears on the customer's statement.
222
- */
223
- statement_descriptor_suffix?: string;
224
-
225
- /**
226
- * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.stripe.com/payments/connected-accounts).
227
- */
228
- transfer_data?: OffSessionPaymentCaptureParams.TransferData;
229
- }
230
-
231
- namespace OffSessionPaymentCaptureParams {
232
- interface TransferData {
233
- /**
234
- * The amount transferred to the destination account. This transfer will occur
235
- * automatically after the payment succeeds. If no amount is specified, by default
236
- * the entire payment amount is transferred to the destination account. The amount
237
- * must be less than or equal to the
238
- * [amount_requested](https://docs.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
239
- * and must be a positive integer representing how much to transfer in the smallest
240
- * currency unit (e.g., 100 cents to charge $1.00).
241
- */
242
- amount?: number;
243
- }
244
- }
245
- }
246
-
247
- namespace Payments {
248
- class OffSessionPaymentsResource {
249
- /**
250
- * Creates an OffSessionPayment object.
251
- */
252
- create(
253
- params: OffSessionPaymentCreateParams,
254
- options?: RequestOptions
255
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
256
-
257
- /**
258
- * Retrieves the details of an OffSessionPayment that has previously been created.
259
- */
260
- retrieve(
261
- id: string,
262
- params?: OffSessionPaymentRetrieveParams,
263
- options?: RequestOptions
264
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
265
- retrieve(
266
- id: string,
267
- options?: RequestOptions
268
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
269
-
270
- /**
271
- * Returns a list of OffSessionPayments matching a filter.
272
- */
273
- list(
274
- params?: OffSessionPaymentListParams,
275
- options?: RequestOptions
276
- ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
277
- list(
278
- options?: RequestOptions
279
- ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
280
-
281
- /**
282
- * Cancel an OffSessionPayment that has previously been created.
283
- */
284
- cancel(
285
- id: string,
286
- params?: OffSessionPaymentCancelParams,
287
- options?: RequestOptions
288
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
289
- cancel(
290
- id: string,
291
- options?: RequestOptions
292
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
293
-
294
- /**
295
- * Captures an OffSessionPayment that has previously been created.
296
- */
297
- capture(
298
- id: string,
299
- params: OffSessionPaymentCaptureParams,
300
- options?: RequestOptions
301
- ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
302
- }
303
- }
304
- }
305
- }
306
- }
@@ -1,111 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Payments {
7
- /**
8
- * SettlementAllocationIntentSplit resource.
9
- */
10
- interface SettlementAllocationIntentSplit {
11
- /**
12
- * Unique identifier for the SettlementAllocationIntentSplit.
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.payments.settlement_allocation_intent_split';
20
-
21
- /**
22
- * The account id against which the SettlementAllocationIntentSplit should be settled.
23
- */
24
- account: string;
25
-
26
- /**
27
- * The amount and currency of the SettlementAllocationIntentSplit.
28
- */
29
- amount: SettlementAllocationIntentSplit.Amount;
30
-
31
- /**
32
- * Timestamp at which SettlementAllocationIntentSplit was created.
33
- */
34
- created: string;
35
-
36
- /**
37
- * Details about the Flow object that settled the split.
38
- */
39
- flow: SettlementAllocationIntentSplit.Flow;
40
-
41
- /**
42
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
43
- */
44
- livemode: boolean;
45
-
46
- /**
47
- * The ID of the SettlementAllocationIntent that this split belongs too.
48
- */
49
- settlement_allocation_intent: string;
50
-
51
- /**
52
- * The status of the SettlementAllocationIntentSplit.
53
- */
54
- status: SettlementAllocationIntentSplit.Status;
55
-
56
- /**
57
- * The type of the SettlementAllocationIntentSplit.
58
- */
59
- type: SettlementAllocationIntentSplit.Type;
60
- }
61
-
62
- namespace SettlementAllocationIntentSplit {
63
- interface Amount {
64
- /**
65
- * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
66
- */
67
- value?: number;
68
-
69
- /**
70
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
71
- */
72
- currency?: string;
73
- }
74
-
75
- interface Flow {
76
- /**
77
- * Type of the flow linked to the transaction which settled the SettlementAllocationIntentSplit. The field matching this value will contain the ID of the flow.
78
- */
79
- type: Flow.Type;
80
-
81
- /**
82
- * If applicable, the ID of the OutboundPayment that created this transaction.
83
- */
84
- outbound_payment?: string;
85
-
86
- /**
87
- * If applicable, the ID of the OutboundTransfer that created this transaction.
88
- */
89
- outbound_transfer?: string;
90
-
91
- /**
92
- * If applicable, the ID of the ReceivedCredit that created this transaction.
93
- */
94
- received_credit?: string;
95
- }
96
-
97
- namespace Flow {
98
- type Type =
99
- | 'outbound_payment'
100
- | 'outbound_transfer'
101
- | 'received_credit';
102
- }
103
-
104
- type Status = 'canceled' | 'pending' | 'settled';
105
-
106
- type Type = 'credit' | 'debit';
107
- }
108
- }
109
- }
110
- }
111
- }
@@ -1,126 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Payments {
7
- namespace SettlementAllocationIntents {
8
- interface SplitCreateParams {
9
- /**
10
- * The target account for settling the SettlementAllocationIntentSplit.
11
- */
12
- account: string;
13
-
14
- /**
15
- * The amount and currency of the SettlementAllocationIntentSplit.
16
- */
17
- amount: SplitCreateParams.Amount;
18
-
19
- /**
20
- * The type of the fund transfer.
21
- */
22
- type: SplitCreateParams.Type;
23
-
24
- /**
25
- * Metadata associated with the SettlementAllocationIntentSplit.
26
- */
27
- metadata?: Stripe.MetadataParam;
28
- }
29
-
30
- namespace SplitCreateParams {
31
- interface Amount {
32
- /**
33
- * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
34
- */
35
- value?: number;
36
-
37
- /**
38
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
39
- */
40
- currency?: string;
41
- }
42
-
43
- type Type = 'credit' | 'debit';
44
- }
45
- }
46
- }
47
-
48
- namespace Payments {
49
- namespace SettlementAllocationIntents {
50
- interface SplitRetrieveParams {}
51
- }
52
- }
53
-
54
- namespace Payments {
55
- namespace SettlementAllocationIntents {
56
- interface SplitCancelParams {}
57
- }
58
- }
59
-
60
- namespace Payments {
61
- namespace SettlementAllocationIntents {
62
- class SplitsResource {
63
- /**
64
- * Create SettlementAllocationIntentSplit API.
65
- */
66
- create(
67
- id: string,
68
- params: SplitCreateParams,
69
- options?: RequestOptions
70
- ): Promise<
71
- Stripe.Response<
72
- Stripe.V2.Payments.SettlementAllocationIntentSplit
73
- >
74
- >;
75
-
76
- /**
77
- * Retrieve SettlementAllocationIntentSplit API.
78
- */
79
- retrieve(
80
- settlementAllocationIntentId: string,
81
- id: string,
82
- params?: SplitRetrieveParams,
83
- options?: RequestOptions
84
- ): Promise<
85
- Stripe.Response<
86
- Stripe.V2.Payments.SettlementAllocationIntentSplit
87
- >
88
- >;
89
- retrieve(
90
- settlementAllocationIntentId: string,
91
- id: string,
92
- options?: RequestOptions
93
- ): Promise<
94
- Stripe.Response<
95
- Stripe.V2.Payments.SettlementAllocationIntentSplit
96
- >
97
- >;
98
-
99
- /**
100
- * Cancel SettlementAllocationIntentSplit API.
101
- */
102
- cancel(
103
- settlementAllocationIntentId: string,
104
- id: string,
105
- params?: SplitCancelParams,
106
- options?: RequestOptions
107
- ): Promise<
108
- Stripe.Response<
109
- Stripe.V2.Payments.SettlementAllocationIntentSplit
110
- >
111
- >;
112
- cancel(
113
- settlementAllocationIntentId: string,
114
- id: string,
115
- options?: RequestOptions
116
- ): Promise<
117
- Stripe.Response<
118
- Stripe.V2.Payments.SettlementAllocationIntentSplit
119
- >
120
- >;
121
- }
122
- }
123
- }
124
- }
125
- }
126
- }
@@ -1,122 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace V2 {
6
- namespace Payments {
7
- /**
8
- * SettlementAllocationIntent resource.
9
- */
10
- interface SettlementAllocationIntent {
11
- /**
12
- * Unique identifier for the SettlementAllocationIntent.
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.payments.settlement_allocation_intent';
20
-
21
- /**
22
- * The amount and currency of the SettlementAllocationIntent.
23
- */
24
- amount: SettlementAllocationIntent.Amount;
25
-
26
- /**
27
- * Timestamp at which SettlementAllocationIntent was created .
28
- */
29
- created: string;
30
-
31
- /**
32
- * Date when we expect to receive the funds.
33
- */
34
- expected_settlement_date: string;
35
-
36
- /**
37
- * FinancialAccount ID where the funds are expected.
38
- */
39
- financial_account: string;
40
-
41
- /**
42
- * List of ReceivedCredits that matched with the SettlementAllocationIntent.
43
- */
44
- linked_credits: Array<string>;
45
-
46
- /**
47
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
48
- */
49
- livemode: boolean;
50
-
51
- /**
52
- * Metadata associated with the SettlementAllocationIntent.
53
- */
54
- metadata?: Stripe.Metadata;
55
-
56
- /**
57
- * Reference for the SettlementAllocationIntent. This is the transaction reference used by payments processor to send funds to Stripe .
58
- */
59
- reference: string;
60
-
61
- /**
62
- * SettlementAllocationIntent status.
63
- */
64
- status: SettlementAllocationIntent.Status;
65
-
66
- /**
67
- * Status details for a SettlementAllocationIntent in `errored` state.
68
- */
69
- status_details?: SettlementAllocationIntent.StatusDetails;
70
- }
71
-
72
- namespace SettlementAllocationIntent {
73
- interface Amount {
74
- /**
75
- * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
76
- */
77
- value?: number;
78
-
79
- /**
80
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
81
- */
82
- currency?: string;
83
- }
84
-
85
- type Status =
86
- | 'canceled'
87
- | 'errored'
88
- | 'matched'
89
- | 'pending'
90
- | 'settled'
91
- | 'submitted';
92
-
93
- interface StatusDetails {
94
- /**
95
- * Hash that provides additional information regarding the reason behind a `errored` SettlementAllocationIntent status. It is only present when the SettlementAllocationIntent status is `errored`.
96
- */
97
- errored?: StatusDetails.Errored;
98
- }
99
-
100
- namespace StatusDetails {
101
- interface Errored {
102
- /**
103
- * Stripe doc link to debug the issue.
104
- */
105
- doc_url?: string;
106
-
107
- /**
108
- * User Message detailing the reason code and possible resolution .
109
- */
110
- message: string;
111
-
112
- /**
113
- * Open Enum. The `errored` status reason.
114
- */
115
- reason_code: 'amount_mismatch';
116
- }
117
- }
118
- }
119
- }
120
- }
121
- }
122
- }