stripe 19.2.0-beta.1 → 19.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. package/CHANGELOG.md +64 -1433
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -115
  6. package/cjs/apiVersion.js +3 -2
  7. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  8. package/cjs/resources/Mandates.js +0 -5
  9. package/cjs/resources/PaymentIntents.js +0 -8
  10. package/cjs/resources/PaymentRecords.js +4 -0
  11. package/cjs/resources/Quotes.js +0 -32
  12. package/cjs/resources/SubscriptionSchedules.js +0 -4
  13. package/cjs/resources/Subscriptions.js +0 -4
  14. package/cjs/resources.js +8 -106
  15. package/cjs/stripe.core.js +1 -1
  16. package/esm/Error.js +0 -100
  17. package/esm/apiVersion.js +2 -1
  18. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  19. package/esm/resources/Mandates.js +0 -5
  20. package/esm/resources/PaymentIntents.js +0 -8
  21. package/esm/resources/PaymentRecords.js +4 -0
  22. package/esm/resources/Quotes.js +0 -32
  23. package/esm/resources/SubscriptionSchedules.js +0 -4
  24. package/esm/resources/Subscriptions.js +0 -4
  25. package/esm/resources.js +0 -93
  26. package/esm/stripe.core.js +1 -1
  27. package/package.json +1 -1
  28. package/types/AccountLinksResource.d.ts +1 -5
  29. package/types/AccountSessions.d.ts +0 -45
  30. package/types/AccountSessionsResource.d.ts +0 -264
  31. package/types/Accounts.d.ts +23 -212
  32. package/types/AccountsResource.d.ts +44 -544
  33. package/types/Billing/AlertTriggereds.d.ts +1 -1
  34. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  35. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  36. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  37. package/types/Billing/CreditGrants.d.ts +0 -5
  38. package/types/Billing/CreditGrantsResource.d.ts +3 -13
  39. package/types/BillingPortal/Configurations.d.ts +1 -1
  40. package/types/BillingPortal/ConfigurationsResource.d.ts +10 -0
  41. package/types/BillingPortal/Sessions.d.ts +0 -5
  42. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  43. package/types/Cards.d.ts +0 -5
  44. package/types/CashBalances.d.ts +0 -5
  45. package/types/Charges.d.ts +1 -172
  46. package/types/ChargesResource.d.ts +0 -1406
  47. package/types/Checkout/Sessions.d.ts +17 -369
  48. package/types/Checkout/SessionsResource.d.ts +23 -635
  49. package/types/ConfirmationTokens.d.ts +1 -125
  50. package/types/Coupons.d.ts +0 -33
  51. package/types/CouponsResource.d.ts +0 -21
  52. package/types/CreditNoteLineItems.d.ts +0 -17
  53. package/types/CreditNotes.d.ts +26 -5
  54. package/types/CreditNotesResource.d.ts +78 -5
  55. package/types/CustomerBalanceTransactions.d.ts +0 -2
  56. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  57. package/types/CustomerSessions.d.ts +120 -5
  58. package/types/CustomerSessionsResource.d.ts +121 -6
  59. package/types/Customers.d.ts +7 -2
  60. package/types/CustomersResource.d.ts +1 -8
  61. package/types/Discounts.d.ts +0 -10
  62. package/types/Disputes.d.ts +0 -40
  63. package/types/DisputesResource.d.ts +0 -11
  64. package/types/Errors.d.ts +0 -85
  65. package/types/EventTypes.d.ts +0 -630
  66. package/types/Events.d.ts +0 -95
  67. package/types/Files.d.ts +1 -0
  68. package/types/FilesResource.d.ts +2 -0
  69. package/types/FinancialConnections/Accounts.d.ts +1 -36
  70. package/types/FinancialConnections/AccountsResource.d.ts +4 -41
  71. package/types/FinancialConnections/Sessions.d.ts +1 -51
  72. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  73. package/types/Identity/VerificationSessions.d.ts +0 -5
  74. package/types/Identity/VerificationSessionsResource.d.ts +0 -7
  75. package/types/InvoiceItems.d.ts +0 -10
  76. package/types/InvoiceItemsResource.d.ts +6 -117
  77. package/types/InvoiceLineItems.d.ts +1 -45
  78. package/types/Invoices.d.ts +5 -203
  79. package/types/InvoicesResource.d.ts +4 -1622
  80. package/types/Issuing/CardholdersResource.d.ts +1 -2
  81. package/types/Issuing/Transactions.d.ts +0 -5
  82. package/types/Issuing/TransactionsResource.d.ts +0 -5
  83. package/types/LineItems.d.ts +0 -49
  84. package/types/Mandates.d.ts +1 -135
  85. package/types/MandatesResource.d.ts +0 -31
  86. package/types/PaymentAttemptRecords.d.ts +1 -137
  87. package/types/PaymentAttemptRecordsResource.d.ts +5 -0
  88. package/types/PaymentIntentAmountDetailsLineItems.d.ts +17 -7
  89. package/types/PaymentIntents.d.ts +23 -782
  90. package/types/PaymentIntentsResource.d.ts +4783 -9501
  91. package/types/PaymentLinks.d.ts +34 -6
  92. package/types/PaymentLinksResource.d.ts +88 -12
  93. package/types/PaymentMethodConfigurations.d.ts +46 -190
  94. package/types/PaymentMethodConfigurationsResource.d.ts +100 -300
  95. package/types/PaymentMethods.d.ts +34 -130
  96. package/types/PaymentMethodsResource.d.ts +17 -168
  97. package/types/PaymentRecords.d.ts +1 -137
  98. package/types/PaymentRecordsResource.d.ts +89 -0
  99. package/types/PayoutsResource.d.ts +1 -1
  100. package/types/Prices.d.ts +0 -22
  101. package/types/PricesResource.d.ts +0 -22
  102. package/types/PromotionCodes.d.ts +0 -5
  103. package/types/PromotionCodesResource.d.ts +0 -10
  104. package/types/Quotes.d.ts +1 -594
  105. package/types/QuotesResource.d.ts +290 -2635
  106. package/types/Refunds.d.ts +9 -14
  107. package/types/SetupAttempts.d.ts +2 -51
  108. package/types/SetupIntents.d.ts +59 -209
  109. package/types/SetupIntentsResource.d.ts +132 -952
  110. package/types/Sources.d.ts +0 -29
  111. package/types/SubscriptionItems.d.ts +0 -26
  112. package/types/SubscriptionItemsResource.d.ts +0 -109
  113. package/types/SubscriptionSchedules.d.ts +0 -205
  114. package/types/SubscriptionSchedulesResource.d.ts +4 -1232
  115. package/types/Subscriptions.d.ts +1 -262
  116. package/types/SubscriptionsResource.d.ts +8 -745
  117. package/types/Tax/Registrations.d.ts +9 -0
  118. package/types/Tax/RegistrationsResource.d.ts +12 -0
  119. package/types/TaxIds.d.ts +0 -10
  120. package/types/TaxIdsResource.d.ts +0 -10
  121. package/types/Terminal/Configurations.d.ts +19 -9
  122. package/types/Terminal/ConfigurationsResource.d.ts +44 -28
  123. package/types/Terminal/Readers.d.ts +14 -29
  124. package/types/Terminal/ReadersResource.d.ts +30 -30
  125. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
  126. package/types/TestHelpers/Terminal/ReadersResource.d.ts +1 -1
  127. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  128. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  129. package/types/TokensResource.d.ts +22 -0
  130. package/types/Transfers.d.ts +0 -5
  131. package/types/TransfersResource.d.ts +0 -5
  132. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  133. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  134. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  135. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  136. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  137. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  138. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  139. package/types/V2/Core/EventTypes.d.ts +10 -1647
  140. package/types/V2/Core/EventsResource.d.ts +29 -3
  141. package/types/WebhookEndpointsResource.d.ts +2 -75
  142. package/types/apiVersion.d.ts +2 -1
  143. package/types/crypto/crypto.d.ts +1 -1
  144. package/types/index.d.ts +0 -153
  145. package/types/lib.d.ts +0 -10
  146. package/cjs/resources/AccountNotices.js +0 -21
  147. package/cjs/resources/Billing/Analytics/MeterUsage.js +0 -12
  148. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  149. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  150. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  151. package/cjs/resources/ExternalAccounts.js +0 -23
  152. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  153. package/cjs/resources/FxQuotes.js +0 -15
  154. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  155. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  156. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  157. package/cjs/resources/Margins.js +0 -22
  158. package/cjs/resources/Orders.js +0 -24
  159. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  160. package/cjs/resources/Tax/Associations.js +0 -9
  161. package/cjs/resources/Tax/Forms.js +0 -20
  162. package/cjs/resources/Terminal/OnboardingLinks.js +0 -12
  163. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  164. package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -17
  165. package/cjs/resources/V2/Billing/BillSettings.js +0 -27
  166. package/cjs/resources/V2/Billing/Cadences.js +0 -23
  167. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -17
  168. package/cjs/resources/V2/Billing/CollectionSettings.js +0 -30
  169. package/cjs/resources/V2/Billing/Profiles.js +0 -19
  170. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  171. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  172. package/cjs/resources/V2/Core/Accounts.js +0 -25
  173. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  174. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  175. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  176. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -25
  177. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  178. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  179. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  180. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  181. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  182. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  183. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  184. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  185. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  186. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  187. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  188. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  189. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -29
  190. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  191. package/esm/resources/AccountNotices.js +0 -18
  192. package/esm/resources/Billing/Analytics/MeterUsage.js +0 -9
  193. package/esm/resources/Capital/FinancingOffers.js +0 -18
  194. package/esm/resources/Capital/FinancingSummary.js +0 -9
  195. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  196. package/esm/resources/ExternalAccounts.js +0 -20
  197. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  198. package/esm/resources/FxQuotes.js +0 -12
  199. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  200. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  201. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  202. package/esm/resources/Margins.js +0 -19
  203. package/esm/resources/Orders.js +0 -21
  204. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  205. package/esm/resources/Tax/Associations.js +0 -6
  206. package/esm/resources/Tax/Forms.js +0 -17
  207. package/esm/resources/Terminal/OnboardingLinks.js +0 -9
  208. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  209. package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -14
  210. package/esm/resources/V2/Billing/BillSettings.js +0 -24
  211. package/esm/resources/V2/Billing/Cadences.js +0 -20
  212. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -14
  213. package/esm/resources/V2/Billing/CollectionSettings.js +0 -27
  214. package/esm/resources/V2/Billing/Profiles.js +0 -16
  215. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  216. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  217. package/esm/resources/V2/Core/Accounts.js +0 -22
  218. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  219. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  220. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  221. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -22
  222. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  223. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  224. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  225. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  226. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  227. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  228. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  229. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  230. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  231. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  232. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  233. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  234. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -26
  235. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  236. package/types/AccountNotices.d.ts +0 -113
  237. package/types/AccountNoticesResource.d.ts +0 -98
  238. package/types/Billing/Analytics/MeterUsage.d.ts +0 -31
  239. package/types/Billing/Analytics/MeterUsageResource.d.ts +0 -689
  240. package/types/Billing/Analytics/MeterUsageRows.d.ts +0 -51
  241. package/types/Capital/FinancingOffers.d.ts +0 -188
  242. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  243. package/types/Capital/FinancingSummary.d.ts +0 -106
  244. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  245. package/types/Capital/FinancingTransactions.d.ts +0 -135
  246. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  247. package/types/ExternalAccountsResource.d.ts +0 -304
  248. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  249. package/types/FinancialConnections/Institutions.d.ts +0 -98
  250. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  251. package/types/FxQuotes.d.ts +0 -155
  252. package/types/FxQuotesResource.d.ts +0 -130
  253. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  254. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  255. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  256. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  257. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  258. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  259. package/types/Issuing/Settlements.d.ts +0 -113
  260. package/types/Margins.d.ts +0 -56
  261. package/types/MarginsResource.d.ts +0 -114
  262. package/types/Orders.d.ts +0 -1163
  263. package/types/OrdersResource.d.ts +0 -3139
  264. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  265. package/types/Privacy/RedactionJobs.d.ts +0 -111
  266. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  267. package/types/QuoteLines.d.ts +0 -634
  268. package/types/QuotePreviewInvoices.d.ts +0 -1770
  269. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -908
  270. package/types/Tax/Associations.d.ts +0 -82
  271. package/types/Tax/AssociationsResource.d.ts +0 -29
  272. package/types/Tax/Forms.d.ts +0 -220
  273. package/types/Tax/FormsResource.d.ts +0 -107
  274. package/types/Terminal/OnboardingLinks.d.ts +0 -57
  275. package/types/Terminal/OnboardingLinksResource.d.ts +0 -62
  276. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  277. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  278. package/types/V2/Billing/BillSettingVersions.d.ts +0 -97
  279. package/types/V2/Billing/BillSettings/VersionsResource.d.ts +0 -58
  280. package/types/V2/Billing/BillSettings.d.ts +0 -120
  281. package/types/V2/Billing/BillSettingsResource.d.ts +0 -241
  282. package/types/V2/Billing/Cadences.d.ts +0 -686
  283. package/types/V2/Billing/CadencesResource.d.ts +0 -487
  284. package/types/V2/Billing/CollectionSettingVersions.d.ts +0 -314
  285. package/types/V2/Billing/CollectionSettings/VersionsResource.d.ts +0 -62
  286. package/types/V2/Billing/CollectionSettings.d.ts +0 -337
  287. package/types/V2/Billing/CollectionSettingsResource.d.ts +0 -675
  288. package/types/V2/Billing/Profiles.d.ts +0 -70
  289. package/types/V2/Billing/ProfilesResource.d.ts +0 -150
  290. package/types/V2/Core/AccountLinks.d.ts +0 -168
  291. package/types/V2/Core/AccountLinksResource.d.ts +0 -152
  292. package/types/V2/Core/AccountPersons.d.ts +0 -615
  293. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -1153
  294. package/types/V2/Core/Accounts.d.ts +0 -5919
  295. package/types/V2/Core/AccountsResource.d.ts +0 -4999
  296. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  297. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  298. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  299. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  300. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  301. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  302. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  303. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  304. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -148
  305. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -147
  306. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -178
  307. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -112
  308. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  309. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  310. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -170
  311. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  312. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  313. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  314. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  315. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  316. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  317. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
  318. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
  319. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -93
  320. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  321. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  322. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -302
  323. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  324. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
  325. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  326. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -162
  327. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  328. package/types/V2/MoneyManagement/Transactions.d.ts +0 -177
  329. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  330. package/types/V2/Payments/OffSessionPayments.d.ts +0 -326
  331. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -401
  332. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
@@ -5,134 +5,12 @@ declare module 'stripe' {
5
5
  export type Event =
6
6
  | Stripe.Events.V1BillingMeterErrorReportTriggeredEvent
7
7
  | Stripe.Events.V1BillingMeterNoMeterFoundEvent
8
- | Stripe.Events.V2BillingBillSettingUpdatedEvent
9
- | Stripe.Events.V2CoreAccountClosedEvent
10
- | Stripe.Events.V2CoreAccountCreatedEvent
11
- | Stripe.Events.V2CoreAccountUpdatedEvent
12
- | Stripe.Events.V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
13
- | Stripe.Events.V2CoreAccountIncludingConfigurationCustomerUpdatedEvent
14
- | Stripe.Events.V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
15
- | Stripe.Events.V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
16
- | Stripe.Events.V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
17
- | Stripe.Events.V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
18
- | Stripe.Events.V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
19
- | Stripe.Events.V2CoreAccountIncludingConfigurationStorerUpdatedEvent
20
- | Stripe.Events.V2CoreAccountIncludingDefaultsUpdatedEvent
21
- | Stripe.Events.V2CoreAccountIncludingIdentityUpdatedEvent
22
- | Stripe.Events.V2CoreAccountIncludingRequirementsUpdatedEvent
23
- | Stripe.Events.V2CoreAccountLinkReturnedEvent
24
- | Stripe.Events.V2CoreAccountPersonCreatedEvent
25
- | Stripe.Events.V2CoreAccountPersonDeletedEvent
26
- | Stripe.Events.V2CoreAccountPersonUpdatedEvent
27
- | Stripe.Events.V2CoreEventDestinationPingEvent
28
- | Stripe.Events.V2MoneyManagementAdjustmentCreatedEvent
29
- | Stripe.Events.V2MoneyManagementFinancialAccountCreatedEvent
30
- | Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEvent
31
- | Stripe.Events.V2MoneyManagementFinancialAddressActivatedEvent
32
- | Stripe.Events.V2MoneyManagementFinancialAddressFailedEvent
33
- | Stripe.Events.V2MoneyManagementInboundTransferAvailableEvent
34
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitFailedEvent
35
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitProcessingEvent
36
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitQueuedEvent
37
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitReturnedEvent
38
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitSucceededEvent
39
- | Stripe.Events.V2MoneyManagementOutboundPaymentCanceledEvent
40
- | Stripe.Events.V2MoneyManagementOutboundPaymentCreatedEvent
41
- | Stripe.Events.V2MoneyManagementOutboundPaymentFailedEvent
42
- | Stripe.Events.V2MoneyManagementOutboundPaymentPostedEvent
43
- | Stripe.Events.V2MoneyManagementOutboundPaymentReturnedEvent
44
- | Stripe.Events.V2MoneyManagementOutboundPaymentUpdatedEvent
45
- | Stripe.Events.V2MoneyManagementOutboundTransferCanceledEvent
46
- | Stripe.Events.V2MoneyManagementOutboundTransferCreatedEvent
47
- | Stripe.Events.V2MoneyManagementOutboundTransferFailedEvent
48
- | Stripe.Events.V2MoneyManagementOutboundTransferPostedEvent
49
- | Stripe.Events.V2MoneyManagementOutboundTransferReturnedEvent
50
- | Stripe.Events.V2MoneyManagementOutboundTransferUpdatedEvent
51
- | Stripe.Events.V2MoneyManagementPayoutMethodUpdatedEvent
52
- | Stripe.Events.V2MoneyManagementReceivedCreditAvailableEvent
53
- | Stripe.Events.V2MoneyManagementReceivedCreditFailedEvent
54
- | Stripe.Events.V2MoneyManagementReceivedCreditReturnedEvent
55
- | Stripe.Events.V2MoneyManagementReceivedCreditSucceededEvent
56
- | Stripe.Events.V2MoneyManagementReceivedDebitCanceledEvent
57
- | Stripe.Events.V2MoneyManagementReceivedDebitFailedEvent
58
- | Stripe.Events.V2MoneyManagementReceivedDebitPendingEvent
59
- | Stripe.Events.V2MoneyManagementReceivedDebitSucceededEvent
60
- | Stripe.Events.V2MoneyManagementReceivedDebitUpdatedEvent
61
- | Stripe.Events.V2MoneyManagementTransactionCreatedEvent
62
- | Stripe.Events.V2MoneyManagementTransactionUpdatedEvent
63
- | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
64
- | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
65
- | Stripe.Events.V2PaymentsOffSessionPaymentCanceledEvent
66
- | Stripe.Events.V2PaymentsOffSessionPaymentCreatedEvent
67
- | Stripe.Events.V2PaymentsOffSessionPaymentFailedEvent
68
- | Stripe.Events.V2PaymentsOffSessionPaymentRequiresCaptureEvent
69
- | Stripe.Events.V2PaymentsOffSessionPaymentSucceededEvent;
8
+ | Stripe.Events.V2CoreEventDestinationPingEvent;
70
9
 
71
10
  export type EventNotification =
72
11
  | Stripe.Events.V1BillingMeterErrorReportTriggeredEventNotification
73
12
  | Stripe.Events.V1BillingMeterNoMeterFoundEventNotification
74
- | Stripe.Events.V2BillingBillSettingUpdatedEventNotification
75
- | Stripe.Events.V2CoreAccountClosedEventNotification
76
- | Stripe.Events.V2CoreAccountCreatedEventNotification
77
- | Stripe.Events.V2CoreAccountUpdatedEventNotification
78
- | Stripe.Events.V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEventNotification
79
- | Stripe.Events.V2CoreAccountIncludingConfigurationCustomerUpdatedEventNotification
80
- | Stripe.Events.V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEventNotification
81
- | Stripe.Events.V2CoreAccountIncludingConfigurationMerchantUpdatedEventNotification
82
- | Stripe.Events.V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEventNotification
83
- | Stripe.Events.V2CoreAccountIncludingConfigurationRecipientUpdatedEventNotification
84
- | Stripe.Events.V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEventNotification
85
- | Stripe.Events.V2CoreAccountIncludingConfigurationStorerUpdatedEventNotification
86
- | Stripe.Events.V2CoreAccountIncludingDefaultsUpdatedEventNotification
87
- | Stripe.Events.V2CoreAccountIncludingIdentityUpdatedEventNotification
88
- | Stripe.Events.V2CoreAccountIncludingRequirementsUpdatedEventNotification
89
- | Stripe.Events.V2CoreAccountLinkReturnedEventNotification
90
- | Stripe.Events.V2CoreAccountPersonCreatedEventNotification
91
- | Stripe.Events.V2CoreAccountPersonDeletedEventNotification
92
- | Stripe.Events.V2CoreAccountPersonUpdatedEventNotification
93
- | Stripe.Events.V2CoreEventDestinationPingEventNotification
94
- | Stripe.Events.V2MoneyManagementAdjustmentCreatedEventNotification
95
- | Stripe.Events.V2MoneyManagementFinancialAccountCreatedEventNotification
96
- | Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEventNotification
97
- | Stripe.Events.V2MoneyManagementFinancialAddressActivatedEventNotification
98
- | Stripe.Events.V2MoneyManagementFinancialAddressFailedEventNotification
99
- | Stripe.Events.V2MoneyManagementInboundTransferAvailableEventNotification
100
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitFailedEventNotification
101
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitProcessingEventNotification
102
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitQueuedEventNotification
103
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitReturnedEventNotification
104
- | Stripe.Events.V2MoneyManagementInboundTransferBankDebitSucceededEventNotification
105
- | Stripe.Events.V2MoneyManagementOutboundPaymentCanceledEventNotification
106
- | Stripe.Events.V2MoneyManagementOutboundPaymentCreatedEventNotification
107
- | Stripe.Events.V2MoneyManagementOutboundPaymentFailedEventNotification
108
- | Stripe.Events.V2MoneyManagementOutboundPaymentPostedEventNotification
109
- | Stripe.Events.V2MoneyManagementOutboundPaymentReturnedEventNotification
110
- | Stripe.Events.V2MoneyManagementOutboundPaymentUpdatedEventNotification
111
- | Stripe.Events.V2MoneyManagementOutboundTransferCanceledEventNotification
112
- | Stripe.Events.V2MoneyManagementOutboundTransferCreatedEventNotification
113
- | Stripe.Events.V2MoneyManagementOutboundTransferFailedEventNotification
114
- | Stripe.Events.V2MoneyManagementOutboundTransferPostedEventNotification
115
- | Stripe.Events.V2MoneyManagementOutboundTransferReturnedEventNotification
116
- | Stripe.Events.V2MoneyManagementOutboundTransferUpdatedEventNotification
117
- | Stripe.Events.V2MoneyManagementPayoutMethodUpdatedEventNotification
118
- | Stripe.Events.V2MoneyManagementReceivedCreditAvailableEventNotification
119
- | Stripe.Events.V2MoneyManagementReceivedCreditFailedEventNotification
120
- | Stripe.Events.V2MoneyManagementReceivedCreditReturnedEventNotification
121
- | Stripe.Events.V2MoneyManagementReceivedCreditSucceededEventNotification
122
- | Stripe.Events.V2MoneyManagementReceivedDebitCanceledEventNotification
123
- | Stripe.Events.V2MoneyManagementReceivedDebitFailedEventNotification
124
- | Stripe.Events.V2MoneyManagementReceivedDebitPendingEventNotification
125
- | Stripe.Events.V2MoneyManagementReceivedDebitSucceededEventNotification
126
- | Stripe.Events.V2MoneyManagementReceivedDebitUpdatedEventNotification
127
- | Stripe.Events.V2MoneyManagementTransactionCreatedEventNotification
128
- | Stripe.Events.V2MoneyManagementTransactionUpdatedEventNotification
129
- | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEventNotification
130
- | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEventNotification
131
- | Stripe.Events.V2PaymentsOffSessionPaymentCanceledEventNotification
132
- | Stripe.Events.V2PaymentsOffSessionPaymentCreatedEventNotification
133
- | Stripe.Events.V2PaymentsOffSessionPaymentFailedEventNotification
134
- | Stripe.Events.V2PaymentsOffSessionPaymentRequiresCaptureEventNotification
135
- | Stripe.Events.V2PaymentsOffSessionPaymentSucceededEventNotification;
13
+ | Stripe.Events.V2CoreEventDestinationPingEventNotification;
136
14
  }
137
15
 
138
16
  namespace Stripe.Events {
@@ -356,1538 +234,23 @@ declare module 'stripe' {
356
234
  }
357
235
 
358
236
  /**
359
- * This event occurs when a bill setting is updated.
360
- */
361
- export interface V2BillingBillSettingUpdatedEvent
362
- extends V2.Core.EventBase {
363
- type: 'v2.billing.bill_setting.updated';
364
- // Retrieves data specific to this event.
365
- data: V2BillingBillSettingUpdatedEvent.Data;
366
- // Object containing the reference to API resource relevant to the event.
367
- related_object: V2.Core.Events.RelatedObject;
368
- // Retrieves the object associated with the event.
369
- fetchRelatedObject(): Promise<V2.Billing.BillSetting>;
370
- }
371
- export interface V2BillingBillSettingUpdatedEventNotification
372
- extends V2.Core.EventNotificationBase {
373
- type: 'v2.billing.bill_setting.updated';
374
- // Object containing the reference to API resource relevant to the event.
375
- related_object: V2.Core.Events.RelatedObject;
376
- // Retrieves the object associated with the event.
377
- fetchRelatedObject(): Promise<V2.Billing.BillSetting>;
378
- fetchEvent(): Promise<V2BillingBillSettingUpdatedEvent>;
379
- }
380
-
381
- namespace V2BillingBillSettingUpdatedEvent {
382
- export interface Data {
383
- /**
384
- * Timestamp of when the object was updated.
385
- */
386
- updated: string;
387
- }
388
- }
389
-
390
- /**
391
- * This event occurs when an account is closed.
392
- */
393
- export interface V2CoreAccountClosedEvent extends V2.Core.EventBase {
394
- type: 'v2.core.account.closed';
395
- // Object containing the reference to API resource relevant to the event.
396
- related_object: V2.Core.Events.RelatedObject;
397
- // Retrieves the object associated with the event.
398
- fetchRelatedObject(): Promise<V2.Core.Account>;
399
- }
400
- export interface V2CoreAccountClosedEventNotification
401
- extends V2.Core.EventNotificationBase {
402
- type: 'v2.core.account.closed';
403
- // Object containing the reference to API resource relevant to the event.
404
- related_object: V2.Core.Events.RelatedObject;
405
- // Retrieves the object associated with the event.
406
- fetchRelatedObject(): Promise<V2.Core.Account>;
407
- fetchEvent(): Promise<V2CoreAccountClosedEvent>;
408
- }
409
-
410
- /**
411
- * Occurs when an Account is created.
412
- */
413
- export interface V2CoreAccountCreatedEvent extends V2.Core.EventBase {
414
- type: 'v2.core.account.created';
415
- // Object containing the reference to API resource relevant to the event.
416
- related_object: V2.Core.Events.RelatedObject;
417
- // Retrieves the object associated with the event.
418
- fetchRelatedObject(): Promise<V2.Core.Account>;
419
- }
420
- export interface V2CoreAccountCreatedEventNotification
421
- extends V2.Core.EventNotificationBase {
422
- type: 'v2.core.account.created';
423
- // Object containing the reference to API resource relevant to the event.
424
- related_object: V2.Core.Events.RelatedObject;
425
- // Retrieves the object associated with the event.
426
- fetchRelatedObject(): Promise<V2.Core.Account>;
427
- fetchEvent(): Promise<V2CoreAccountCreatedEvent>;
428
- }
429
-
430
- /**
431
- * Occurs when an Account is updated.
432
- */
433
- export interface V2CoreAccountUpdatedEvent extends V2.Core.EventBase {
434
- type: 'v2.core.account.updated';
435
- // Object containing the reference to API resource relevant to the event.
436
- related_object: V2.Core.Events.RelatedObject;
437
- // Retrieves the object associated with the event.
438
- fetchRelatedObject(): Promise<V2.Core.Account>;
439
- }
440
- export interface V2CoreAccountUpdatedEventNotification
441
- extends V2.Core.EventNotificationBase {
442
- type: 'v2.core.account.updated';
443
- // Object containing the reference to API resource relevant to the event.
444
- related_object: V2.Core.Events.RelatedObject;
445
- // Retrieves the object associated with the event.
446
- fetchRelatedObject(): Promise<V2.Core.Account>;
447
- fetchEvent(): Promise<V2CoreAccountUpdatedEvent>;
448
- }
449
-
450
- /**
451
- * Occurs when the status of an Account's customer configuration capability is updated.
452
- */
453
- export interface V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
454
- extends V2.Core.EventBase {
455
- type: 'v2.core.account[configuration.customer].capability_status_updated';
456
- // Retrieves data specific to this event.
457
- data: V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent.Data;
458
- // Object containing the reference to API resource relevant to the event.
459
- related_object: V2.Core.Events.RelatedObject;
460
- // Retrieves the object associated with the event.
461
- fetchRelatedObject(): Promise<V2.Core.Account>;
462
- }
463
- export interface V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEventNotification
464
- extends V2.Core.EventNotificationBase {
465
- type: 'v2.core.account[configuration.customer].capability_status_updated';
466
- // Object containing the reference to API resource relevant to the event.
467
- related_object: V2.Core.Events.RelatedObject;
468
- // Retrieves the object associated with the event.
469
- fetchRelatedObject(): Promise<V2.Core.Account>;
470
- fetchEvent(): Promise<
471
- V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent
472
- >;
473
- }
474
-
475
- namespace V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent {
476
- export interface Data {
477
- /**
478
- * Open Enum. The capability which had its status updated.
479
- */
480
- updated_capability: 'automatic_indirect_tax';
481
- }
482
- }
483
-
484
- /**
485
- * Occurs when an Account's customer configuration is updated.
486
- */
487
- export interface V2CoreAccountIncludingConfigurationCustomerUpdatedEvent
488
- extends V2.Core.EventBase {
489
- type: 'v2.core.account[configuration.customer].updated';
490
- // Object containing the reference to API resource relevant to the event.
491
- related_object: V2.Core.Events.RelatedObject;
492
- // Retrieves the object associated with the event.
493
- fetchRelatedObject(): Promise<V2.Core.Account>;
494
- }
495
- export interface V2CoreAccountIncludingConfigurationCustomerUpdatedEventNotification
496
- extends V2.Core.EventNotificationBase {
497
- type: 'v2.core.account[configuration.customer].updated';
498
- // Object containing the reference to API resource relevant to the event.
499
- related_object: V2.Core.Events.RelatedObject;
500
- // Retrieves the object associated with the event.
501
- fetchRelatedObject(): Promise<V2.Core.Account>;
502
- fetchEvent(): Promise<
503
- V2CoreAccountIncludingConfigurationCustomerUpdatedEvent
504
- >;
505
- }
506
-
507
- /**
508
- * Occurs when the status of an Account's merchant configuration capability is updated.
509
- */
510
- export interface V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
511
- extends V2.Core.EventBase {
512
- type: 'v2.core.account[configuration.merchant].capability_status_updated';
513
- // Retrieves data specific to this event.
514
- data: V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent.Data;
515
- // Object containing the reference to API resource relevant to the event.
516
- related_object: V2.Core.Events.RelatedObject;
517
- // Retrieves the object associated with the event.
518
- fetchRelatedObject(): Promise<V2.Core.Account>;
519
- }
520
- export interface V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEventNotification
521
- extends V2.Core.EventNotificationBase {
522
- type: 'v2.core.account[configuration.merchant].capability_status_updated';
523
- // Object containing the reference to API resource relevant to the event.
524
- related_object: V2.Core.Events.RelatedObject;
525
- // Retrieves the object associated with the event.
526
- fetchRelatedObject(): Promise<V2.Core.Account>;
527
- fetchEvent(): Promise<
528
- V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent
529
- >;
530
- }
531
-
532
- namespace V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent {
533
- export interface Data {
534
- /**
535
- * Open Enum. The capability which had its status updated.
536
- */
537
- updated_capability: Data.UpdatedCapability;
538
- }
539
-
540
- namespace Data {
541
- export type UpdatedCapability =
542
- | 'ach_debit_payments'
543
- | 'acss_debit_payments'
544
- | 'affirm_payments'
545
- | 'afterpay_clearpay_payments'
546
- | 'alma_payments'
547
- | 'amazon_pay_payments'
548
- | 'au_becs_debit_payments'
549
- | 'bacs_debit_payments'
550
- | 'bancontact_payments'
551
- | 'blik_payments'
552
- | 'boleto_payments'
553
- | 'card_payments'
554
- | 'cartes_bancaires_payments'
555
- | 'cashapp_payments'
556
- | 'eps_payments'
557
- | 'fpx_payments'
558
- | 'gb_bank_transfer_payments'
559
- | 'grabpay_payments'
560
- | 'ideal_payments'
561
- | 'jcb_payments'
562
- | 'jp_bank_transfer_payments'
563
- | 'kakao_pay_payments'
564
- | 'klarna_payments'
565
- | 'konbini_payments'
566
- | 'kr_card_payments'
567
- | 'link_payments'
568
- | 'mobilepay_payments'
569
- | 'multibanco_payments'
570
- | 'mx_bank_transfer_payments'
571
- | 'naver_pay_payments'
572
- | 'oxxo_payments'
573
- | 'p24_payments'
574
- | 'payco_payments'
575
- | 'paynow_payments'
576
- | 'stripe_balance.payouts'
577
- | 'pay_by_bank_payments'
578
- | 'promptpay_payments'
579
- | 'revolut_pay_payments'
580
- | 'samsung_pay_payments'
581
- | 'sepa_bank_transfer_payments'
582
- | 'sepa_debit_payments'
583
- | 'swish_payments'
584
- | 'twint_payments'
585
- | 'us_bank_transfer_payments'
586
- | 'zip_payments';
587
- }
588
- }
589
-
590
- /**
591
- * Occurs when an Account's merchant configuration is updated.
592
- */
593
- export interface V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
594
- extends V2.Core.EventBase {
595
- type: 'v2.core.account[configuration.merchant].updated';
596
- // Object containing the reference to API resource relevant to the event.
597
- related_object: V2.Core.Events.RelatedObject;
598
- // Retrieves the object associated with the event.
599
- fetchRelatedObject(): Promise<V2.Core.Account>;
600
- }
601
- export interface V2CoreAccountIncludingConfigurationMerchantUpdatedEventNotification
602
- extends V2.Core.EventNotificationBase {
603
- type: 'v2.core.account[configuration.merchant].updated';
604
- // Object containing the reference to API resource relevant to the event.
605
- related_object: V2.Core.Events.RelatedObject;
606
- // Retrieves the object associated with the event.
607
- fetchRelatedObject(): Promise<V2.Core.Account>;
608
- fetchEvent(): Promise<
609
- V2CoreAccountIncludingConfigurationMerchantUpdatedEvent
610
- >;
611
- }
612
-
613
- /**
614
- * Occurs when the status of an Account's recipient configuration capability is updated.
615
- */
616
- export interface V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
617
- extends V2.Core.EventBase {
618
- type: 'v2.core.account[configuration.recipient].capability_status_updated';
619
- // Retrieves data specific to this event.
620
- data: V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent.Data;
621
- // Object containing the reference to API resource relevant to the event.
622
- related_object: V2.Core.Events.RelatedObject;
623
- // Retrieves the object associated with the event.
624
- fetchRelatedObject(): Promise<V2.Core.Account>;
625
- }
626
- export interface V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEventNotification
627
- extends V2.Core.EventNotificationBase {
628
- type: 'v2.core.account[configuration.recipient].capability_status_updated';
629
- // Object containing the reference to API resource relevant to the event.
630
- related_object: V2.Core.Events.RelatedObject;
631
- // Retrieves the object associated with the event.
632
- fetchRelatedObject(): Promise<V2.Core.Account>;
633
- fetchEvent(): Promise<
634
- V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent
635
- >;
636
- }
637
-
638
- namespace V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent {
639
- export interface Data {
640
- /**
641
- * Open Enum. The capability which had its status updated.
642
- */
643
- updated_capability: Data.UpdatedCapability;
644
- }
645
-
646
- namespace Data {
647
- export type UpdatedCapability =
648
- | 'bank_accounts.local'
649
- | 'bank_accounts.wire'
650
- | 'cards'
651
- | 'stripe_balance.payouts'
652
- | 'stripe_balance.stripe_transfers'
653
- | 'stripe.transfers';
654
- }
655
- }
656
-
657
- /**
658
- * Occurs when a Recipient's configuration is updated.
659
- */
660
- export interface V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
661
- extends V2.Core.EventBase {
662
- type: 'v2.core.account[configuration.recipient].updated';
663
- // Object containing the reference to API resource relevant to the event.
664
- related_object: V2.Core.Events.RelatedObject;
665
- // Retrieves the object associated with the event.
666
- fetchRelatedObject(): Promise<V2.Core.Account>;
667
- }
668
- export interface V2CoreAccountIncludingConfigurationRecipientUpdatedEventNotification
669
- extends V2.Core.EventNotificationBase {
670
- type: 'v2.core.account[configuration.recipient].updated';
671
- // Object containing the reference to API resource relevant to the event.
672
- related_object: V2.Core.Events.RelatedObject;
673
- // Retrieves the object associated with the event.
674
- fetchRelatedObject(): Promise<V2.Core.Account>;
675
- fetchEvent(): Promise<
676
- V2CoreAccountIncludingConfigurationRecipientUpdatedEvent
677
- >;
678
- }
679
-
680
- /**
681
- * Occurs when the status of an Account's storer configuration capability is updated.
682
- */
683
- export interface V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
684
- extends V2.Core.EventBase {
685
- type: 'v2.core.account[configuration.storer].capability_status_updated';
686
- // Retrieves data specific to this event.
687
- data: V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent.Data;
688
- // Object containing the reference to API resource relevant to the event.
689
- related_object: V2.Core.Events.RelatedObject;
690
- // Retrieves the object associated with the event.
691
- fetchRelatedObject(): Promise<V2.Core.Account>;
692
- }
693
- export interface V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEventNotification
694
- extends V2.Core.EventNotificationBase {
695
- type: 'v2.core.account[configuration.storer].capability_status_updated';
696
- // Object containing the reference to API resource relevant to the event.
697
- related_object: V2.Core.Events.RelatedObject;
698
- // Retrieves the object associated with the event.
699
- fetchRelatedObject(): Promise<V2.Core.Account>;
700
- fetchEvent(): Promise<
701
- V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
702
- >;
703
- }
704
-
705
- namespace V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent {
706
- export interface Data {
707
- /**
708
- * Open Enum. The capability which had its status updated.
709
- */
710
- updated_capability: Data.UpdatedCapability;
711
- }
712
-
713
- namespace Data {
714
- export type UpdatedCapability =
715
- | 'financial_addressses.bank_accounts'
716
- | 'financial_addressses.crypto_wallets'
717
- | 'holds_currencies.eur'
718
- | 'holds_currencies.gbp'
719
- | 'holds_currencies.usd'
720
- | 'holds_currencies.usdc'
721
- | 'inbound_transfers.bank_accounts'
722
- | 'outbound_payments.bank_accounts'
723
- | 'outbound_payments.cards'
724
- | 'outbound_payments.crypto_wallets'
725
- | 'outbound_payments.financial_accounts'
726
- | 'outbound_transfers.bank_accounts'
727
- | 'outbound_transfers.crypto_wallets'
728
- | 'outbound_transfers.financial_accounts';
729
- }
730
- }
731
-
732
- /**
733
- * Occurs when a Storer's configuration is updated.
734
- */
735
- export interface V2CoreAccountIncludingConfigurationStorerUpdatedEvent
736
- extends V2.Core.EventBase {
737
- type: 'v2.core.account[configuration.storer].updated';
738
- // Object containing the reference to API resource relevant to the event.
739
- related_object: V2.Core.Events.RelatedObject;
740
- // Retrieves the object associated with the event.
741
- fetchRelatedObject(): Promise<V2.Core.Account>;
742
- }
743
- export interface V2CoreAccountIncludingConfigurationStorerUpdatedEventNotification
744
- extends V2.Core.EventNotificationBase {
745
- type: 'v2.core.account[configuration.storer].updated';
746
- // Object containing the reference to API resource relevant to the event.
747
- related_object: V2.Core.Events.RelatedObject;
748
- // Retrieves the object associated with the event.
749
- fetchRelatedObject(): Promise<V2.Core.Account>;
750
- fetchEvent(): Promise<
751
- V2CoreAccountIncludingConfigurationStorerUpdatedEvent
752
- >;
753
- }
754
-
755
- /**
756
- * This event occurs when account defaults are created or updated.
757
- */
758
- export interface V2CoreAccountIncludingDefaultsUpdatedEvent
759
- extends V2.Core.EventBase {
760
- type: 'v2.core.account[defaults].updated';
761
- // Object containing the reference to API resource relevant to the event.
762
- related_object: V2.Core.Events.RelatedObject;
763
- // Retrieves the object associated with the event.
764
- fetchRelatedObject(): Promise<V2.Core.Account>;
765
- }
766
- export interface V2CoreAccountIncludingDefaultsUpdatedEventNotification
767
- extends V2.Core.EventNotificationBase {
768
- type: 'v2.core.account[defaults].updated';
769
- // Object containing the reference to API resource relevant to the event.
770
- related_object: V2.Core.Events.RelatedObject;
771
- // Retrieves the object associated with the event.
772
- fetchRelatedObject(): Promise<V2.Core.Account>;
773
- fetchEvent(): Promise<V2CoreAccountIncludingDefaultsUpdatedEvent>;
774
- }
775
-
776
- /**
777
- * Occurs when an Identity is updated.
778
- */
779
- export interface V2CoreAccountIncludingIdentityUpdatedEvent
780
- extends V2.Core.EventBase {
781
- type: 'v2.core.account[identity].updated';
782
- // Object containing the reference to API resource relevant to the event.
783
- related_object: V2.Core.Events.RelatedObject;
784
- // Retrieves the object associated with the event.
785
- fetchRelatedObject(): Promise<V2.Core.Account>;
786
- }
787
- export interface V2CoreAccountIncludingIdentityUpdatedEventNotification
788
- extends V2.Core.EventNotificationBase {
789
- type: 'v2.core.account[identity].updated';
790
- // Object containing the reference to API resource relevant to the event.
791
- related_object: V2.Core.Events.RelatedObject;
792
- // Retrieves the object associated with the event.
793
- fetchRelatedObject(): Promise<V2.Core.Account>;
794
- fetchEvent(): Promise<V2CoreAccountIncludingIdentityUpdatedEvent>;
795
- }
796
-
797
- /**
798
- * Occurs when an Account's requirements are updated.
799
- */
800
- export interface V2CoreAccountIncludingRequirementsUpdatedEvent
801
- extends V2.Core.EventBase {
802
- type: 'v2.core.account[requirements].updated';
803
- // Object containing the reference to API resource relevant to the event.
804
- related_object: V2.Core.Events.RelatedObject;
805
- // Retrieves the object associated with the event.
806
- fetchRelatedObject(): Promise<V2.Core.Account>;
807
- }
808
- export interface V2CoreAccountIncludingRequirementsUpdatedEventNotification
809
- extends V2.Core.EventNotificationBase {
810
- type: 'v2.core.account[requirements].updated';
811
- // Object containing the reference to API resource relevant to the event.
812
- related_object: V2.Core.Events.RelatedObject;
813
- // Retrieves the object associated with the event.
814
- fetchRelatedObject(): Promise<V2.Core.Account>;
815
- fetchEvent(): Promise<V2CoreAccountIncludingRequirementsUpdatedEvent>;
816
- }
817
-
818
- /**
819
- * Occurs when the generated AccountLink is completed.
820
- */
821
- export interface V2CoreAccountLinkReturnedEvent extends V2.Core.EventBase {
822
- type: 'v2.core.account_link.returned';
823
- // Retrieves data specific to this event.
824
- data: V2CoreAccountLinkReturnedEvent.Data;
825
- }
826
- export interface V2CoreAccountLinkReturnedEventNotification
827
- extends V2.Core.EventNotificationBase {
828
- type: 'v2.core.account_link.returned';
829
- fetchEvent(): Promise<V2CoreAccountLinkReturnedEvent>;
830
- }
831
-
832
- namespace V2CoreAccountLinkReturnedEvent {
833
- export interface Data {
834
- /**
835
- * The ID of the v2 account.
836
- */
837
- account_id: string;
838
-
839
- /**
840
- * Configurations on the Account that was onboarded via the account link.
841
- */
842
- configurations: Array<Data.Configuration>;
843
-
844
- /**
845
- * Open Enum. The use case type of the account link that has been completed.
846
- */
847
- use_case: Data.UseCase;
848
- }
849
-
850
- namespace Data {
851
- export type Configuration =
852
- | 'customer'
853
- | 'merchant'
854
- | 'recipient'
855
- | 'storer';
856
-
857
- export type UseCase = 'account_onboarding' | 'account_update';
858
- }
859
- }
860
-
861
- /**
862
- * Occurs when a Person is created.
863
- */
864
- export interface V2CoreAccountPersonCreatedEvent extends V2.Core.EventBase {
865
- type: 'v2.core.account_person.created';
866
- // Retrieves data specific to this event.
867
- data: V2CoreAccountPersonCreatedEvent.Data;
868
- // Object containing the reference to API resource relevant to the event.
869
- related_object: V2.Core.Events.RelatedObject;
870
- // Retrieves the object associated with the event.
871
- fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
872
- }
873
- export interface V2CoreAccountPersonCreatedEventNotification
874
- extends V2.Core.EventNotificationBase {
875
- type: 'v2.core.account_person.created';
876
- // Object containing the reference to API resource relevant to the event.
877
- related_object: V2.Core.Events.RelatedObject;
878
- // Retrieves the object associated with the event.
879
- fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
880
- fetchEvent(): Promise<V2CoreAccountPersonCreatedEvent>;
881
- }
882
-
883
- namespace V2CoreAccountPersonCreatedEvent {
884
- export interface Data {
885
- /**
886
- * The ID of the v2 account.
887
- */
888
- account_id: string;
889
- }
890
- }
891
-
892
- /**
893
- * Occurs when a Person is deleted.
894
- */
895
- export interface V2CoreAccountPersonDeletedEvent extends V2.Core.EventBase {
896
- type: 'v2.core.account_person.deleted';
897
- // Retrieves data specific to this event.
898
- data: V2CoreAccountPersonDeletedEvent.Data;
899
- // Object containing the reference to API resource relevant to the event.
900
- related_object: V2.Core.Events.RelatedObject;
901
- // Retrieves the object associated with the event.
902
- fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
903
- }
904
- export interface V2CoreAccountPersonDeletedEventNotification
905
- extends V2.Core.EventNotificationBase {
906
- type: 'v2.core.account_person.deleted';
907
- // Object containing the reference to API resource relevant to the event.
908
- related_object: V2.Core.Events.RelatedObject;
909
- // Retrieves the object associated with the event.
910
- fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
911
- fetchEvent(): Promise<V2CoreAccountPersonDeletedEvent>;
912
- }
913
-
914
- namespace V2CoreAccountPersonDeletedEvent {
915
- export interface Data {
916
- /**
917
- * The ID of the v2 account.
918
- */
919
- account_id: string;
920
- }
921
- }
922
-
923
- /**
924
- * Occurs when a Person is updated.
925
- */
926
- export interface V2CoreAccountPersonUpdatedEvent extends V2.Core.EventBase {
927
- type: 'v2.core.account_person.updated';
928
- // Retrieves data specific to this event.
929
- data: V2CoreAccountPersonUpdatedEvent.Data;
930
- // Object containing the reference to API resource relevant to the event.
931
- related_object: V2.Core.Events.RelatedObject;
932
- // Retrieves the object associated with the event.
933
- fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
934
- }
935
- export interface V2CoreAccountPersonUpdatedEventNotification
936
- extends V2.Core.EventNotificationBase {
937
- type: 'v2.core.account_person.updated';
938
- // Object containing the reference to API resource relevant to the event.
939
- related_object: V2.Core.Events.RelatedObject;
940
- // Retrieves the object associated with the event.
941
- fetchRelatedObject(): Promise<V2.Core.AccountPerson>;
942
- fetchEvent(): Promise<V2CoreAccountPersonUpdatedEvent>;
943
- }
944
-
945
- namespace V2CoreAccountPersonUpdatedEvent {
946
- export interface Data {
947
- /**
948
- * The ID of the v2 account.
949
- */
950
- account_id: string;
951
- }
952
- }
953
-
954
- /**
955
- * A ping event used to test the connection to an EventDestination.
956
- */
957
- export interface V2CoreEventDestinationPingEvent extends V2.Core.EventBase {
958
- type: 'v2.core.event_destination.ping';
959
- // Object containing the reference to API resource relevant to the event.
960
- related_object: V2.Core.Events.RelatedObject;
961
- // Retrieves the object associated with the event.
962
- fetchRelatedObject(): Promise<V2.Core.EventDestination>;
963
- }
964
- export interface V2CoreEventDestinationPingEventNotification
965
- extends V2.Core.EventNotificationBase {
966
- type: 'v2.core.event_destination.ping';
967
- // Object containing the reference to API resource relevant to the event.
968
- related_object: V2.Core.Events.RelatedObject;
969
- // Retrieves the object associated with the event.
970
- fetchRelatedObject(): Promise<V2.Core.EventDestination>;
971
- fetchEvent(): Promise<V2CoreEventDestinationPingEvent>;
972
- }
973
-
974
- /**
975
- * Occurs when an Adjustment is created.
976
- */
977
- export interface V2MoneyManagementAdjustmentCreatedEvent
978
- extends V2.Core.EventBase {
979
- type: 'v2.money_management.adjustment.created';
980
- // Object containing the reference to API resource relevant to the event.
981
- related_object: V2.Core.Events.RelatedObject;
982
- // Retrieves the object associated with the event.
983
- fetchRelatedObject(): Promise<V2.MoneyManagement.Adjustment>;
984
- }
985
- export interface V2MoneyManagementAdjustmentCreatedEventNotification
986
- extends V2.Core.EventNotificationBase {
987
- type: 'v2.money_management.adjustment.created';
988
- // Object containing the reference to API resource relevant to the event.
989
- related_object: V2.Core.Events.RelatedObject;
990
- // Retrieves the object associated with the event.
991
- fetchRelatedObject(): Promise<V2.MoneyManagement.Adjustment>;
992
- fetchEvent(): Promise<V2MoneyManagementAdjustmentCreatedEvent>;
993
- }
994
-
995
- /**
996
- * Occurs when a FinancialAccount is created.
997
- */
998
- export interface V2MoneyManagementFinancialAccountCreatedEvent
999
- extends V2.Core.EventBase {
1000
- type: 'v2.money_management.financial_account.created';
1001
- // Object containing the reference to API resource relevant to the event.
1002
- related_object: V2.Core.Events.RelatedObject;
1003
- // Retrieves the object associated with the event.
1004
- fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
1005
- }
1006
- export interface V2MoneyManagementFinancialAccountCreatedEventNotification
1007
- extends V2.Core.EventNotificationBase {
1008
- type: 'v2.money_management.financial_account.created';
1009
- // Object containing the reference to API resource relevant to the event.
1010
- related_object: V2.Core.Events.RelatedObject;
1011
- // Retrieves the object associated with the event.
1012
- fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
1013
- fetchEvent(): Promise<V2MoneyManagementFinancialAccountCreatedEvent>;
1014
- }
1015
-
1016
- /**
1017
- * Occurs when a FinancialAccount is updated.
1018
- */
1019
- export interface V2MoneyManagementFinancialAccountUpdatedEvent
1020
- extends V2.Core.EventBase {
1021
- type: 'v2.money_management.financial_account.updated';
1022
- // Object containing the reference to API resource relevant to the event.
1023
- related_object: V2.Core.Events.RelatedObject;
1024
- // Retrieves the object associated with the event.
1025
- fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
1026
- }
1027
- export interface V2MoneyManagementFinancialAccountUpdatedEventNotification
1028
- extends V2.Core.EventNotificationBase {
1029
- type: 'v2.money_management.financial_account.updated';
1030
- // Object containing the reference to API resource relevant to the event.
1031
- related_object: V2.Core.Events.RelatedObject;
1032
- // Retrieves the object associated with the event.
1033
- fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAccount>;
1034
- fetchEvent(): Promise<V2MoneyManagementFinancialAccountUpdatedEvent>;
1035
- }
1036
-
1037
- /**
1038
- * Occurs when a FinancialAddress is activated and is ready to receive funds.
1039
- */
1040
- export interface V2MoneyManagementFinancialAddressActivatedEvent
1041
- extends V2.Core.EventBase {
1042
- type: 'v2.money_management.financial_address.activated';
1043
- // Object containing the reference to API resource relevant to the event.
1044
- related_object: V2.Core.Events.RelatedObject;
1045
- // Retrieves the object associated with the event.
1046
- fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
1047
- }
1048
- export interface V2MoneyManagementFinancialAddressActivatedEventNotification
1049
- extends V2.Core.EventNotificationBase {
1050
- type: 'v2.money_management.financial_address.activated';
1051
- // Object containing the reference to API resource relevant to the event.
1052
- related_object: V2.Core.Events.RelatedObject;
1053
- // Retrieves the object associated with the event.
1054
- fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
1055
- fetchEvent(): Promise<V2MoneyManagementFinancialAddressActivatedEvent>;
1056
- }
1057
-
1058
- /**
1059
- * Occurs when a FinancialAddress fails to activate and can not receive funds.
1060
- */
1061
- export interface V2MoneyManagementFinancialAddressFailedEvent
1062
- extends V2.Core.EventBase {
1063
- type: 'v2.money_management.financial_address.failed';
1064
- // Object containing the reference to API resource relevant to the event.
1065
- related_object: V2.Core.Events.RelatedObject;
1066
- // Retrieves the object associated with the event.
1067
- fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
1068
- }
1069
- export interface V2MoneyManagementFinancialAddressFailedEventNotification
1070
- extends V2.Core.EventNotificationBase {
1071
- type: 'v2.money_management.financial_address.failed';
1072
- // Object containing the reference to API resource relevant to the event.
1073
- related_object: V2.Core.Events.RelatedObject;
1074
- // Retrieves the object associated with the event.
1075
- fetchRelatedObject(): Promise<V2.MoneyManagement.FinancialAddress>;
1076
- fetchEvent(): Promise<V2MoneyManagementFinancialAddressFailedEvent>;
1077
- }
1078
-
1079
- /**
1080
- * Occurs when an InboundTransfer's funds are made available.
1081
- */
1082
- export interface V2MoneyManagementInboundTransferAvailableEvent
1083
- extends V2.Core.EventBase {
1084
- type: 'v2.money_management.inbound_transfer.available';
1085
- // Retrieves data specific to this event.
1086
- data: V2MoneyManagementInboundTransferAvailableEvent.Data;
1087
- // Object containing the reference to API resource relevant to the event.
1088
- related_object: V2.Core.Events.RelatedObject;
1089
- // Retrieves the object associated with the event.
1090
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1091
- }
1092
- export interface V2MoneyManagementInboundTransferAvailableEventNotification
1093
- extends V2.Core.EventNotificationBase {
1094
- type: 'v2.money_management.inbound_transfer.available';
1095
- // Object containing the reference to API resource relevant to the event.
1096
- related_object: V2.Core.Events.RelatedObject;
1097
- // Retrieves the object associated with the event.
1098
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1099
- fetchEvent(): Promise<V2MoneyManagementInboundTransferAvailableEvent>;
1100
- }
1101
-
1102
- namespace V2MoneyManagementInboundTransferAvailableEvent {
1103
- export interface Data {
1104
- /**
1105
- * The transaction ID of the received credit.
1106
- */
1107
- transaction_id: string;
1108
- }
1109
- }
1110
-
1111
- /**
1112
- * Occurs when an InboundTransfer fails.
1113
- */
1114
- export interface V2MoneyManagementInboundTransferBankDebitFailedEvent
1115
- extends V2.Core.EventBase {
1116
- type: 'v2.money_management.inbound_transfer.bank_debit_failed';
1117
- // Object containing the reference to API resource relevant to the event.
1118
- related_object: V2.Core.Events.RelatedObject;
1119
- // Retrieves the object associated with the event.
1120
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1121
- }
1122
- export interface V2MoneyManagementInboundTransferBankDebitFailedEventNotification
1123
- extends V2.Core.EventNotificationBase {
1124
- type: 'v2.money_management.inbound_transfer.bank_debit_failed';
1125
- // Object containing the reference to API resource relevant to the event.
1126
- related_object: V2.Core.Events.RelatedObject;
1127
- // Retrieves the object associated with the event.
1128
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1129
- fetchEvent(): Promise<
1130
- V2MoneyManagementInboundTransferBankDebitFailedEvent
1131
- >;
1132
- }
1133
-
1134
- /**
1135
- * Occurs when an InboundTransfer starts processing.
1136
- */
1137
- export interface V2MoneyManagementInboundTransferBankDebitProcessingEvent
1138
- extends V2.Core.EventBase {
1139
- type: 'v2.money_management.inbound_transfer.bank_debit_processing';
1140
- // Object containing the reference to API resource relevant to the event.
1141
- related_object: V2.Core.Events.RelatedObject;
1142
- // Retrieves the object associated with the event.
1143
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1144
- }
1145
- export interface V2MoneyManagementInboundTransferBankDebitProcessingEventNotification
1146
- extends V2.Core.EventNotificationBase {
1147
- type: 'v2.money_management.inbound_transfer.bank_debit_processing';
1148
- // Object containing the reference to API resource relevant to the event.
1149
- related_object: V2.Core.Events.RelatedObject;
1150
- // Retrieves the object associated with the event.
1151
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1152
- fetchEvent(): Promise<
1153
- V2MoneyManagementInboundTransferBankDebitProcessingEvent
1154
- >;
1155
- }
1156
-
1157
- /**
1158
- * Occurs when an InboundTransfer is queued.
1159
- */
1160
- export interface V2MoneyManagementInboundTransferBankDebitQueuedEvent
1161
- extends V2.Core.EventBase {
1162
- type: 'v2.money_management.inbound_transfer.bank_debit_queued';
1163
- // Object containing the reference to API resource relevant to the event.
1164
- related_object: V2.Core.Events.RelatedObject;
1165
- // Retrieves the object associated with the event.
1166
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1167
- }
1168
- export interface V2MoneyManagementInboundTransferBankDebitQueuedEventNotification
1169
- extends V2.Core.EventNotificationBase {
1170
- type: 'v2.money_management.inbound_transfer.bank_debit_queued';
1171
- // Object containing the reference to API resource relevant to the event.
1172
- related_object: V2.Core.Events.RelatedObject;
1173
- // Retrieves the object associated with the event.
1174
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1175
- fetchEvent(): Promise<
1176
- V2MoneyManagementInboundTransferBankDebitQueuedEvent
1177
- >;
1178
- }
1179
-
1180
- /**
1181
- * Occurs when an InboundTransfer is returned.
1182
- */
1183
- export interface V2MoneyManagementInboundTransferBankDebitReturnedEvent
1184
- extends V2.Core.EventBase {
1185
- type: 'v2.money_management.inbound_transfer.bank_debit_returned';
1186
- // Object containing the reference to API resource relevant to the event.
1187
- related_object: V2.Core.Events.RelatedObject;
1188
- // Retrieves the object associated with the event.
1189
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1190
- }
1191
- export interface V2MoneyManagementInboundTransferBankDebitReturnedEventNotification
1192
- extends V2.Core.EventNotificationBase {
1193
- type: 'v2.money_management.inbound_transfer.bank_debit_returned';
1194
- // Object containing the reference to API resource relevant to the event.
1195
- related_object: V2.Core.Events.RelatedObject;
1196
- // Retrieves the object associated with the event.
1197
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1198
- fetchEvent(): Promise<
1199
- V2MoneyManagementInboundTransferBankDebitReturnedEvent
1200
- >;
1201
- }
1202
-
1203
- /**
1204
- * Occurs when an InboundTransfer succeeds.
1205
- */
1206
- export interface V2MoneyManagementInboundTransferBankDebitSucceededEvent
1207
- extends V2.Core.EventBase {
1208
- type: 'v2.money_management.inbound_transfer.bank_debit_succeeded';
1209
- // Object containing the reference to API resource relevant to the event.
1210
- related_object: V2.Core.Events.RelatedObject;
1211
- // Retrieves the object associated with the event.
1212
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1213
- }
1214
- export interface V2MoneyManagementInboundTransferBankDebitSucceededEventNotification
1215
- extends V2.Core.EventNotificationBase {
1216
- type: 'v2.money_management.inbound_transfer.bank_debit_succeeded';
1217
- // Object containing the reference to API resource relevant to the event.
1218
- related_object: V2.Core.Events.RelatedObject;
1219
- // Retrieves the object associated with the event.
1220
- fetchRelatedObject(): Promise<V2.MoneyManagement.InboundTransfer>;
1221
- fetchEvent(): Promise<
1222
- V2MoneyManagementInboundTransferBankDebitSucceededEvent
1223
- >;
1224
- }
1225
-
1226
- /**
1227
- * Occurs when an OutboundPayment transitions into the canceled state.
1228
- */
1229
- export interface V2MoneyManagementOutboundPaymentCanceledEvent
1230
- extends V2.Core.EventBase {
1231
- type: 'v2.money_management.outbound_payment.canceled';
1232
- // Object containing the reference to API resource relevant to the event.
1233
- related_object: V2.Core.Events.RelatedObject;
1234
- // Retrieves the object associated with the event.
1235
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1236
- }
1237
- export interface V2MoneyManagementOutboundPaymentCanceledEventNotification
1238
- extends V2.Core.EventNotificationBase {
1239
- type: 'v2.money_management.outbound_payment.canceled';
1240
- // Object containing the reference to API resource relevant to the event.
1241
- related_object: V2.Core.Events.RelatedObject;
1242
- // Retrieves the object associated with the event.
1243
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1244
- fetchEvent(): Promise<V2MoneyManagementOutboundPaymentCanceledEvent>;
1245
- }
1246
-
1247
- /**
1248
- * Occurs when an OutboundPayment is created.
1249
- */
1250
- export interface V2MoneyManagementOutboundPaymentCreatedEvent
1251
- extends V2.Core.EventBase {
1252
- type: 'v2.money_management.outbound_payment.created';
1253
- // Object containing the reference to API resource relevant to the event.
1254
- related_object: V2.Core.Events.RelatedObject;
1255
- // Retrieves the object associated with the event.
1256
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1257
- }
1258
- export interface V2MoneyManagementOutboundPaymentCreatedEventNotification
1259
- extends V2.Core.EventNotificationBase {
1260
- type: 'v2.money_management.outbound_payment.created';
1261
- // Object containing the reference to API resource relevant to the event.
1262
- related_object: V2.Core.Events.RelatedObject;
1263
- // Retrieves the object associated with the event.
1264
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1265
- fetchEvent(): Promise<V2MoneyManagementOutboundPaymentCreatedEvent>;
1266
- }
1267
-
1268
- /**
1269
- * Occurs when an OutboundPayment transitions into the failed state.
1270
- */
1271
- export interface V2MoneyManagementOutboundPaymentFailedEvent
1272
- extends V2.Core.EventBase {
1273
- type: 'v2.money_management.outbound_payment.failed';
1274
- // Object containing the reference to API resource relevant to the event.
1275
- related_object: V2.Core.Events.RelatedObject;
1276
- // Retrieves the object associated with the event.
1277
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1278
- }
1279
- export interface V2MoneyManagementOutboundPaymentFailedEventNotification
1280
- extends V2.Core.EventNotificationBase {
1281
- type: 'v2.money_management.outbound_payment.failed';
1282
- // Object containing the reference to API resource relevant to the event.
1283
- related_object: V2.Core.Events.RelatedObject;
1284
- // Retrieves the object associated with the event.
1285
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1286
- fetchEvent(): Promise<V2MoneyManagementOutboundPaymentFailedEvent>;
1287
- }
1288
-
1289
- /**
1290
- * Occurs when an OutboundPayment transitions into the posted state.
1291
- */
1292
- export interface V2MoneyManagementOutboundPaymentPostedEvent
1293
- extends V2.Core.EventBase {
1294
- type: 'v2.money_management.outbound_payment.posted';
1295
- // Object containing the reference to API resource relevant to the event.
1296
- related_object: V2.Core.Events.RelatedObject;
1297
- // Retrieves the object associated with the event.
1298
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1299
- }
1300
- export interface V2MoneyManagementOutboundPaymentPostedEventNotification
1301
- extends V2.Core.EventNotificationBase {
1302
- type: 'v2.money_management.outbound_payment.posted';
1303
- // Object containing the reference to API resource relevant to the event.
1304
- related_object: V2.Core.Events.RelatedObject;
1305
- // Retrieves the object associated with the event.
1306
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1307
- fetchEvent(): Promise<V2MoneyManagementOutboundPaymentPostedEvent>;
1308
- }
1309
-
1310
- /**
1311
- * Occurs when an OutboundPayment transitions into the returned state.
1312
- */
1313
- export interface V2MoneyManagementOutboundPaymentReturnedEvent
1314
- extends V2.Core.EventBase {
1315
- type: 'v2.money_management.outbound_payment.returned';
1316
- // Object containing the reference to API resource relevant to the event.
1317
- related_object: V2.Core.Events.RelatedObject;
1318
- // Retrieves the object associated with the event.
1319
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1320
- }
1321
- export interface V2MoneyManagementOutboundPaymentReturnedEventNotification
1322
- extends V2.Core.EventNotificationBase {
1323
- type: 'v2.money_management.outbound_payment.returned';
1324
- // Object containing the reference to API resource relevant to the event.
1325
- related_object: V2.Core.Events.RelatedObject;
1326
- // Retrieves the object associated with the event.
1327
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1328
- fetchEvent(): Promise<V2MoneyManagementOutboundPaymentReturnedEvent>;
1329
- }
1330
-
1331
- /**
1332
- * Occurs when an OutboundPayment is updated.
1333
- */
1334
- export interface V2MoneyManagementOutboundPaymentUpdatedEvent
1335
- extends V2.Core.EventBase {
1336
- type: 'v2.money_management.outbound_payment.updated';
1337
- // Object containing the reference to API resource relevant to the event.
1338
- related_object: V2.Core.Events.RelatedObject;
1339
- // Retrieves the object associated with the event.
1340
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1341
- }
1342
- export interface V2MoneyManagementOutboundPaymentUpdatedEventNotification
1343
- extends V2.Core.EventNotificationBase {
1344
- type: 'v2.money_management.outbound_payment.updated';
1345
- // Object containing the reference to API resource relevant to the event.
1346
- related_object: V2.Core.Events.RelatedObject;
1347
- // Retrieves the object associated with the event.
1348
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundPayment>;
1349
- fetchEvent(): Promise<V2MoneyManagementOutboundPaymentUpdatedEvent>;
1350
- }
1351
-
1352
- /**
1353
- * Occurs when an OutboundTransfer transitions into the canceled state.
1354
- */
1355
- export interface V2MoneyManagementOutboundTransferCanceledEvent
1356
- extends V2.Core.EventBase {
1357
- type: 'v2.money_management.outbound_transfer.canceled';
1358
- // Object containing the reference to API resource relevant to the event.
1359
- related_object: V2.Core.Events.RelatedObject;
1360
- // Retrieves the object associated with the event.
1361
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1362
- }
1363
- export interface V2MoneyManagementOutboundTransferCanceledEventNotification
1364
- extends V2.Core.EventNotificationBase {
1365
- type: 'v2.money_management.outbound_transfer.canceled';
1366
- // Object containing the reference to API resource relevant to the event.
1367
- related_object: V2.Core.Events.RelatedObject;
1368
- // Retrieves the object associated with the event.
1369
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1370
- fetchEvent(): Promise<V2MoneyManagementOutboundTransferCanceledEvent>;
1371
- }
1372
-
1373
- /**
1374
- * Occurs when an OutboundTransfer is created.
1375
- */
1376
- export interface V2MoneyManagementOutboundTransferCreatedEvent
1377
- extends V2.Core.EventBase {
1378
- type: 'v2.money_management.outbound_transfer.created';
1379
- // Object containing the reference to API resource relevant to the event.
1380
- related_object: V2.Core.Events.RelatedObject;
1381
- // Retrieves the object associated with the event.
1382
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1383
- }
1384
- export interface V2MoneyManagementOutboundTransferCreatedEventNotification
1385
- extends V2.Core.EventNotificationBase {
1386
- type: 'v2.money_management.outbound_transfer.created';
1387
- // Object containing the reference to API resource relevant to the event.
1388
- related_object: V2.Core.Events.RelatedObject;
1389
- // Retrieves the object associated with the event.
1390
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1391
- fetchEvent(): Promise<V2MoneyManagementOutboundTransferCreatedEvent>;
1392
- }
1393
-
1394
- /**
1395
- * Occurs when an OutboundTransfer transitions into the failed state.
1396
- */
1397
- export interface V2MoneyManagementOutboundTransferFailedEvent
1398
- extends V2.Core.EventBase {
1399
- type: 'v2.money_management.outbound_transfer.failed';
1400
- // Object containing the reference to API resource relevant to the event.
1401
- related_object: V2.Core.Events.RelatedObject;
1402
- // Retrieves the object associated with the event.
1403
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1404
- }
1405
- export interface V2MoneyManagementOutboundTransferFailedEventNotification
1406
- extends V2.Core.EventNotificationBase {
1407
- type: 'v2.money_management.outbound_transfer.failed';
1408
- // Object containing the reference to API resource relevant to the event.
1409
- related_object: V2.Core.Events.RelatedObject;
1410
- // Retrieves the object associated with the event.
1411
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1412
- fetchEvent(): Promise<V2MoneyManagementOutboundTransferFailedEvent>;
1413
- }
1414
-
1415
- /**
1416
- * Occurs when an OutboundTransfer transitions into the posted state.
1417
- */
1418
- export interface V2MoneyManagementOutboundTransferPostedEvent
1419
- extends V2.Core.EventBase {
1420
- type: 'v2.money_management.outbound_transfer.posted';
1421
- // Object containing the reference to API resource relevant to the event.
1422
- related_object: V2.Core.Events.RelatedObject;
1423
- // Retrieves the object associated with the event.
1424
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1425
- }
1426
- export interface V2MoneyManagementOutboundTransferPostedEventNotification
1427
- extends V2.Core.EventNotificationBase {
1428
- type: 'v2.money_management.outbound_transfer.posted';
1429
- // Object containing the reference to API resource relevant to the event.
1430
- related_object: V2.Core.Events.RelatedObject;
1431
- // Retrieves the object associated with the event.
1432
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1433
- fetchEvent(): Promise<V2MoneyManagementOutboundTransferPostedEvent>;
1434
- }
1435
-
1436
- /**
1437
- * Occurs when an OutboundTransfer transitions into the returned state.
1438
- */
1439
- export interface V2MoneyManagementOutboundTransferReturnedEvent
1440
- extends V2.Core.EventBase {
1441
- type: 'v2.money_management.outbound_transfer.returned';
1442
- // Object containing the reference to API resource relevant to the event.
1443
- related_object: V2.Core.Events.RelatedObject;
1444
- // Retrieves the object associated with the event.
1445
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1446
- }
1447
- export interface V2MoneyManagementOutboundTransferReturnedEventNotification
1448
- extends V2.Core.EventNotificationBase {
1449
- type: 'v2.money_management.outbound_transfer.returned';
1450
- // Object containing the reference to API resource relevant to the event.
1451
- related_object: V2.Core.Events.RelatedObject;
1452
- // Retrieves the object associated with the event.
1453
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1454
- fetchEvent(): Promise<V2MoneyManagementOutboundTransferReturnedEvent>;
1455
- }
1456
-
1457
- /**
1458
- * Event that is emitted every time an Outbound Transfer is updated.
1459
- */
1460
- export interface V2MoneyManagementOutboundTransferUpdatedEvent
1461
- extends V2.Core.EventBase {
1462
- type: 'v2.money_management.outbound_transfer.updated';
1463
- // Object containing the reference to API resource relevant to the event.
1464
- related_object: V2.Core.Events.RelatedObject;
1465
- // Retrieves the object associated with the event.
1466
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1467
- }
1468
- export interface V2MoneyManagementOutboundTransferUpdatedEventNotification
1469
- extends V2.Core.EventNotificationBase {
1470
- type: 'v2.money_management.outbound_transfer.updated';
1471
- // Object containing the reference to API resource relevant to the event.
1472
- related_object: V2.Core.Events.RelatedObject;
1473
- // Retrieves the object associated with the event.
1474
- fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
1475
- fetchEvent(): Promise<V2MoneyManagementOutboundTransferUpdatedEvent>;
1476
- }
1477
-
1478
- /**
1479
- * Occurs when a PayoutMethod is updated.
1480
- */
1481
- export interface V2MoneyManagementPayoutMethodUpdatedEvent
1482
- extends V2.Core.EventBase {
1483
- type: 'v2.money_management.payout_method.updated';
1484
- // Object containing the reference to API resource relevant to the event.
1485
- related_object: V2.Core.Events.RelatedObject;
1486
- // Retrieves the object associated with the event.
1487
- fetchRelatedObject(): Promise<V2.MoneyManagement.PayoutMethod>;
1488
- }
1489
- export interface V2MoneyManagementPayoutMethodUpdatedEventNotification
1490
- extends V2.Core.EventNotificationBase {
1491
- type: 'v2.money_management.payout_method.updated';
1492
- // Object containing the reference to API resource relevant to the event.
1493
- related_object: V2.Core.Events.RelatedObject;
1494
- // Retrieves the object associated with the event.
1495
- fetchRelatedObject(): Promise<V2.MoneyManagement.PayoutMethod>;
1496
- fetchEvent(): Promise<V2MoneyManagementPayoutMethodUpdatedEvent>;
1497
- }
1498
-
1499
- /**
1500
- * Occurs when a ReceivedCredit's funds are received and are available in your balance.
1501
- */
1502
- export interface V2MoneyManagementReceivedCreditAvailableEvent
1503
- extends V2.Core.EventBase {
1504
- type: 'v2.money_management.received_credit.available';
1505
- // Retrieves data specific to this event.
1506
- data: V2MoneyManagementReceivedCreditAvailableEvent.Data;
1507
- // Object containing the reference to API resource relevant to the event.
1508
- related_object: V2.Core.Events.RelatedObject;
1509
- // Retrieves the object associated with the event.
1510
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
1511
- }
1512
- export interface V2MoneyManagementReceivedCreditAvailableEventNotification
1513
- extends V2.Core.EventNotificationBase {
1514
- type: 'v2.money_management.received_credit.available';
1515
- // Object containing the reference to API resource relevant to the event.
1516
- related_object: V2.Core.Events.RelatedObject;
1517
- // Retrieves the object associated with the event.
1518
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
1519
- fetchEvent(): Promise<V2MoneyManagementReceivedCreditAvailableEvent>;
1520
- }
1521
-
1522
- namespace V2MoneyManagementReceivedCreditAvailableEvent {
1523
- export interface Data {
1524
- /**
1525
- * The transaction ID of the received credit.
1526
- */
1527
- transaction_id: string;
1528
- }
1529
- }
1530
-
1531
- /**
1532
- * Occurs when a ReceivedCredit is attempted to your balance and fails. See the status_details for more information.
1533
- */
1534
- export interface V2MoneyManagementReceivedCreditFailedEvent
1535
- extends V2.Core.EventBase {
1536
- type: 'v2.money_management.received_credit.failed';
1537
- // Object containing the reference to API resource relevant to the event.
1538
- related_object: V2.Core.Events.RelatedObject;
1539
- // Retrieves the object associated with the event.
1540
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
1541
- }
1542
- export interface V2MoneyManagementReceivedCreditFailedEventNotification
1543
- extends V2.Core.EventNotificationBase {
1544
- type: 'v2.money_management.received_credit.failed';
1545
- // Object containing the reference to API resource relevant to the event.
1546
- related_object: V2.Core.Events.RelatedObject;
1547
- // Retrieves the object associated with the event.
1548
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
1549
- fetchEvent(): Promise<V2MoneyManagementReceivedCreditFailedEvent>;
1550
- }
1551
-
1552
- /**
1553
- * Occurs when a ReceivedCredit is reversed, returned to the originator, and deducted from your balance.
1554
- */
1555
- export interface V2MoneyManagementReceivedCreditReturnedEvent
1556
- extends V2.Core.EventBase {
1557
- type: 'v2.money_management.received_credit.returned';
1558
- // Object containing the reference to API resource relevant to the event.
1559
- related_object: V2.Core.Events.RelatedObject;
1560
- // Retrieves the object associated with the event.
1561
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
1562
- }
1563
- export interface V2MoneyManagementReceivedCreditReturnedEventNotification
1564
- extends V2.Core.EventNotificationBase {
1565
- type: 'v2.money_management.received_credit.returned';
1566
- // Object containing the reference to API resource relevant to the event.
1567
- related_object: V2.Core.Events.RelatedObject;
1568
- // Retrieves the object associated with the event.
1569
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
1570
- fetchEvent(): Promise<V2MoneyManagementReceivedCreditReturnedEvent>;
1571
- }
1572
-
1573
- /**
1574
- * Occurs when a ReceivedCredit succeeds.
1575
- */
1576
- export interface V2MoneyManagementReceivedCreditSucceededEvent
1577
- extends V2.Core.EventBase {
1578
- type: 'v2.money_management.received_credit.succeeded';
1579
- // Object containing the reference to API resource relevant to the event.
1580
- related_object: V2.Core.Events.RelatedObject;
1581
- // Retrieves the object associated with the event.
1582
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
1583
- }
1584
- export interface V2MoneyManagementReceivedCreditSucceededEventNotification
1585
- extends V2.Core.EventNotificationBase {
1586
- type: 'v2.money_management.received_credit.succeeded';
1587
- // Object containing the reference to API resource relevant to the event.
1588
- related_object: V2.Core.Events.RelatedObject;
1589
- // Retrieves the object associated with the event.
1590
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedCredit>;
1591
- fetchEvent(): Promise<V2MoneyManagementReceivedCreditSucceededEvent>;
1592
- }
1593
-
1594
- /**
1595
- * Occurs when a ReceivedDebit is canceled.
1596
- */
1597
- export interface V2MoneyManagementReceivedDebitCanceledEvent
1598
- extends V2.Core.EventBase {
1599
- type: 'v2.money_management.received_debit.canceled';
1600
- // Object containing the reference to API resource relevant to the event.
1601
- related_object: V2.Core.Events.RelatedObject;
1602
- // Retrieves the object associated with the event.
1603
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1604
- }
1605
- export interface V2MoneyManagementReceivedDebitCanceledEventNotification
1606
- extends V2.Core.EventNotificationBase {
1607
- type: 'v2.money_management.received_debit.canceled';
1608
- // Object containing the reference to API resource relevant to the event.
1609
- related_object: V2.Core.Events.RelatedObject;
1610
- // Retrieves the object associated with the event.
1611
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1612
- fetchEvent(): Promise<V2MoneyManagementReceivedDebitCanceledEvent>;
1613
- }
1614
-
1615
- /**
1616
- * Occurs when a ReceivedDebit fails.
1617
- */
1618
- export interface V2MoneyManagementReceivedDebitFailedEvent
1619
- extends V2.Core.EventBase {
1620
- type: 'v2.money_management.received_debit.failed';
1621
- // Object containing the reference to API resource relevant to the event.
1622
- related_object: V2.Core.Events.RelatedObject;
1623
- // Retrieves the object associated with the event.
1624
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1625
- }
1626
- export interface V2MoneyManagementReceivedDebitFailedEventNotification
1627
- extends V2.Core.EventNotificationBase {
1628
- type: 'v2.money_management.received_debit.failed';
1629
- // Object containing the reference to API resource relevant to the event.
1630
- related_object: V2.Core.Events.RelatedObject;
1631
- // Retrieves the object associated with the event.
1632
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1633
- fetchEvent(): Promise<V2MoneyManagementReceivedDebitFailedEvent>;
1634
- }
1635
-
1636
- /**
1637
- * Occurs when a ReceivedDebit is set to pending.
1638
- */
1639
- export interface V2MoneyManagementReceivedDebitPendingEvent
1640
- extends V2.Core.EventBase {
1641
- type: 'v2.money_management.received_debit.pending';
1642
- // Object containing the reference to API resource relevant to the event.
1643
- related_object: V2.Core.Events.RelatedObject;
1644
- // Retrieves the object associated with the event.
1645
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1646
- }
1647
- export interface V2MoneyManagementReceivedDebitPendingEventNotification
1648
- extends V2.Core.EventNotificationBase {
1649
- type: 'v2.money_management.received_debit.pending';
1650
- // Object containing the reference to API resource relevant to the event.
1651
- related_object: V2.Core.Events.RelatedObject;
1652
- // Retrieves the object associated with the event.
1653
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1654
- fetchEvent(): Promise<V2MoneyManagementReceivedDebitPendingEvent>;
1655
- }
1656
-
1657
- /**
1658
- * Occurs when a ReceivedDebit succeeds.
1659
- */
1660
- export interface V2MoneyManagementReceivedDebitSucceededEvent
1661
- extends V2.Core.EventBase {
1662
- type: 'v2.money_management.received_debit.succeeded';
1663
- // Object containing the reference to API resource relevant to the event.
1664
- related_object: V2.Core.Events.RelatedObject;
1665
- // Retrieves the object associated with the event.
1666
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1667
- }
1668
- export interface V2MoneyManagementReceivedDebitSucceededEventNotification
1669
- extends V2.Core.EventNotificationBase {
1670
- type: 'v2.money_management.received_debit.succeeded';
1671
- // Object containing the reference to API resource relevant to the event.
1672
- related_object: V2.Core.Events.RelatedObject;
1673
- // Retrieves the object associated with the event.
1674
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1675
- fetchEvent(): Promise<V2MoneyManagementReceivedDebitSucceededEvent>;
1676
- }
1677
-
1678
- /**
1679
- * Occurs when a ReceivedDebit is updated.
1680
- */
1681
- export interface V2MoneyManagementReceivedDebitUpdatedEvent
1682
- extends V2.Core.EventBase {
1683
- type: 'v2.money_management.received_debit.updated';
1684
- // Object containing the reference to API resource relevant to the event.
1685
- related_object: V2.Core.Events.RelatedObject;
1686
- // Retrieves the object associated with the event.
1687
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1688
- }
1689
- export interface V2MoneyManagementReceivedDebitUpdatedEventNotification
1690
- extends V2.Core.EventNotificationBase {
1691
- type: 'v2.money_management.received_debit.updated';
1692
- // Object containing the reference to API resource relevant to the event.
1693
- related_object: V2.Core.Events.RelatedObject;
1694
- // Retrieves the object associated with the event.
1695
- fetchRelatedObject(): Promise<V2.MoneyManagement.ReceivedDebit>;
1696
- fetchEvent(): Promise<V2MoneyManagementReceivedDebitUpdatedEvent>;
1697
- }
1698
-
1699
- /**
1700
- * Occurs when a Transaction is created.
1701
- */
1702
- export interface V2MoneyManagementTransactionCreatedEvent
1703
- extends V2.Core.EventBase {
1704
- type: 'v2.money_management.transaction.created';
1705
- // Object containing the reference to API resource relevant to the event.
1706
- related_object: V2.Core.Events.RelatedObject;
1707
- // Retrieves the object associated with the event.
1708
- fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
1709
- }
1710
- export interface V2MoneyManagementTransactionCreatedEventNotification
1711
- extends V2.Core.EventNotificationBase {
1712
- type: 'v2.money_management.transaction.created';
1713
- // Object containing the reference to API resource relevant to the event.
1714
- related_object: V2.Core.Events.RelatedObject;
1715
- // Retrieves the object associated with the event.
1716
- fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
1717
- fetchEvent(): Promise<V2MoneyManagementTransactionCreatedEvent>;
1718
- }
1719
-
1720
- /**
1721
- * Occurs when a Transaction is updated.
1722
- */
1723
- export interface V2MoneyManagementTransactionUpdatedEvent
1724
- extends V2.Core.EventBase {
1725
- type: 'v2.money_management.transaction.updated';
1726
- // Object containing the reference to API resource relevant to the event.
1727
- related_object: V2.Core.Events.RelatedObject;
1728
- // Retrieves the object associated with the event.
1729
- fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
1730
- }
1731
- export interface V2MoneyManagementTransactionUpdatedEventNotification
1732
- extends V2.Core.EventNotificationBase {
1733
- type: 'v2.money_management.transaction.updated';
1734
- // Object containing the reference to API resource relevant to the event.
1735
- related_object: V2.Core.Events.RelatedObject;
1736
- // Retrieves the object associated with the event.
1737
- fetchRelatedObject(): Promise<V2.MoneyManagement.Transaction>;
1738
- fetchEvent(): Promise<V2MoneyManagementTransactionUpdatedEvent>;
1739
- }
1740
-
1741
- /**
1742
- * Sent after a failed authorization if there are still retries available on the OffSessionPayment.
1743
- */
1744
- export interface V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
1745
- extends V2.Core.EventBase {
1746
- type: 'v2.payments.off_session_payment.authorization_attempt_failed';
1747
- // Object containing the reference to API resource relevant to the event.
1748
- related_object: V2.Core.Events.RelatedObject;
1749
- // Retrieves the object associated with the event.
1750
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1751
- }
1752
- export interface V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEventNotification
1753
- extends V2.Core.EventNotificationBase {
1754
- type: 'v2.payments.off_session_payment.authorization_attempt_failed';
1755
- // Object containing the reference to API resource relevant to the event.
1756
- related_object: V2.Core.Events.RelatedObject;
1757
- // Retrieves the object associated with the event.
1758
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1759
- fetchEvent(): Promise<
1760
- V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
1761
- >;
1762
- }
1763
-
1764
- /**
1765
- * Sent when our internal scheduling system kicks off an attempt at authorization, whether it's a
1766
- * retry or an initial authorization.
1767
- */
1768
- export interface V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
1769
- extends V2.Core.EventBase {
1770
- type: 'v2.payments.off_session_payment.authorization_attempt_started';
1771
- // Object containing the reference to API resource relevant to the event.
1772
- related_object: V2.Core.Events.RelatedObject;
1773
- // Retrieves the object associated with the event.
1774
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1775
- }
1776
- export interface V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEventNotification
1777
- extends V2.Core.EventNotificationBase {
1778
- type: 'v2.payments.off_session_payment.authorization_attempt_started';
1779
- // Object containing the reference to API resource relevant to the event.
1780
- related_object: V2.Core.Events.RelatedObject;
1781
- // Retrieves the object associated with the event.
1782
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1783
- fetchEvent(): Promise<
1784
- V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
1785
- >;
1786
- }
1787
-
1788
- /**
1789
- * Sent immediately following a user's call to the Off-Session Payments cancel endpoint.
1790
- */
1791
- export interface V2PaymentsOffSessionPaymentCanceledEvent
1792
- extends V2.Core.EventBase {
1793
- type: 'v2.payments.off_session_payment.canceled';
1794
- // Object containing the reference to API resource relevant to the event.
1795
- related_object: V2.Core.Events.RelatedObject;
1796
- // Retrieves the object associated with the event.
1797
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1798
- }
1799
- export interface V2PaymentsOffSessionPaymentCanceledEventNotification
1800
- extends V2.Core.EventNotificationBase {
1801
- type: 'v2.payments.off_session_payment.canceled';
1802
- // Object containing the reference to API resource relevant to the event.
1803
- related_object: V2.Core.Events.RelatedObject;
1804
- // Retrieves the object associated with the event.
1805
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1806
- fetchEvent(): Promise<V2PaymentsOffSessionPaymentCanceledEvent>;
1807
- }
1808
-
1809
- /**
1810
- * Sent immediately following a user's call to the Off-Session Payments create endpoint.
1811
- */
1812
- export interface V2PaymentsOffSessionPaymentCreatedEvent
1813
- extends V2.Core.EventBase {
1814
- type: 'v2.payments.off_session_payment.created';
1815
- // Object containing the reference to API resource relevant to the event.
1816
- related_object: V2.Core.Events.RelatedObject;
1817
- // Retrieves the object associated with the event.
1818
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1819
- }
1820
- export interface V2PaymentsOffSessionPaymentCreatedEventNotification
1821
- extends V2.Core.EventNotificationBase {
1822
- type: 'v2.payments.off_session_payment.created';
1823
- // Object containing the reference to API resource relevant to the event.
1824
- related_object: V2.Core.Events.RelatedObject;
1825
- // Retrieves the object associated with the event.
1826
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1827
- fetchEvent(): Promise<V2PaymentsOffSessionPaymentCreatedEvent>;
1828
- }
1829
-
1830
- /**
1831
- * Sent after a failed authorization if there are no retries remaining, or if the failure is unretryable.
1832
- */
1833
- export interface V2PaymentsOffSessionPaymentFailedEvent
1834
- extends V2.Core.EventBase {
1835
- type: 'v2.payments.off_session_payment.failed';
1836
- // Object containing the reference to API resource relevant to the event.
1837
- related_object: V2.Core.Events.RelatedObject;
1838
- // Retrieves the object associated with the event.
1839
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1840
- }
1841
- export interface V2PaymentsOffSessionPaymentFailedEventNotification
1842
- extends V2.Core.EventNotificationBase {
1843
- type: 'v2.payments.off_session_payment.failed';
1844
- // Object containing the reference to API resource relevant to the event.
1845
- related_object: V2.Core.Events.RelatedObject;
1846
- // Retrieves the object associated with the event.
1847
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1848
- fetchEvent(): Promise<V2PaymentsOffSessionPaymentFailedEvent>;
1849
- }
1850
-
1851
- /**
1852
- * Off-Session payment requires capture event definition.
1853
- */
1854
- export interface V2PaymentsOffSessionPaymentRequiresCaptureEvent
1855
- extends V2.Core.EventBase {
1856
- type: 'v2.payments.off_session_payment.requires_capture';
1857
- // Object containing the reference to API resource relevant to the event.
1858
- related_object: V2.Core.Events.RelatedObject;
1859
- // Retrieves the object associated with the event.
1860
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1861
- }
1862
- export interface V2PaymentsOffSessionPaymentRequiresCaptureEventNotification
1863
- extends V2.Core.EventNotificationBase {
1864
- type: 'v2.payments.off_session_payment.requires_capture';
1865
- // Object containing the reference to API resource relevant to the event.
1866
- related_object: V2.Core.Events.RelatedObject;
1867
- // Retrieves the object associated with the event.
1868
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1869
- fetchEvent(): Promise<V2PaymentsOffSessionPaymentRequiresCaptureEvent>;
1870
- }
1871
-
1872
- /**
1873
- * Sent immediately after a successful authorization.
237
+ * A ping event used to test the connection to an EventDestination.
1874
238
  */
1875
- export interface V2PaymentsOffSessionPaymentSucceededEvent
1876
- extends V2.Core.EventBase {
1877
- type: 'v2.payments.off_session_payment.succeeded';
239
+ export interface V2CoreEventDestinationPingEvent extends V2.Core.EventBase {
240
+ type: 'v2.core.event_destination.ping';
1878
241
  // Object containing the reference to API resource relevant to the event.
1879
242
  related_object: V2.Core.Events.RelatedObject;
1880
243
  // Retrieves the object associated with the event.
1881
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
244
+ fetchRelatedObject(): Promise<V2.Core.EventDestination>;
1882
245
  }
1883
- export interface V2PaymentsOffSessionPaymentSucceededEventNotification
246
+ export interface V2CoreEventDestinationPingEventNotification
1884
247
  extends V2.Core.EventNotificationBase {
1885
- type: 'v2.payments.off_session_payment.succeeded';
248
+ type: 'v2.core.event_destination.ping';
1886
249
  // Object containing the reference to API resource relevant to the event.
1887
250
  related_object: V2.Core.Events.RelatedObject;
1888
251
  // Retrieves the object associated with the event.
1889
- fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
1890
- fetchEvent(): Promise<V2PaymentsOffSessionPaymentSucceededEvent>;
252
+ fetchRelatedObject(): Promise<V2.Core.EventDestination>;
253
+ fetchEvent(): Promise<V2CoreEventDestinationPingEvent>;
1891
254
  }
1892
255
  }
1893
256
  }