stripe 18.1.0-beta.2 → 18.1.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 (309) hide show
  1. package/CHANGELOG.md +140 -1185
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +3 -93
  6. package/cjs/RequestSender.js +3 -7
  7. package/cjs/Webhooks.js +6 -2
  8. package/cjs/apiVersion.js +1 -1
  9. package/cjs/net/FetchHttpClient.js +3 -4
  10. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  11. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  12. package/cjs/resources/Invoices.js +0 -17
  13. package/cjs/resources/PaymentIntents.js +0 -8
  14. package/cjs/resources/Quotes.js +0 -32
  15. package/cjs/resources/SubscriptionSchedules.js +0 -4
  16. package/cjs/resources/Terminal/Readers.js +0 -12
  17. package/cjs/resources/TestHelpers/Terminal/Readers.js +0 -8
  18. package/cjs/resources.js +18 -106
  19. package/cjs/stripe.core.js +2 -4
  20. package/cjs/utils.js +28 -4
  21. package/esm/Error.js +2 -81
  22. package/esm/RequestSender.js +4 -8
  23. package/esm/Webhooks.js +6 -2
  24. package/esm/apiVersion.js +1 -1
  25. package/esm/net/FetchHttpClient.js +3 -4
  26. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  27. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  28. package/esm/resources/Invoices.js +0 -17
  29. package/esm/resources/PaymentIntents.js +0 -8
  30. package/esm/resources/Quotes.js +0 -32
  31. package/esm/resources/SubscriptionSchedules.js +0 -4
  32. package/esm/resources/Terminal/Readers.js +0 -12
  33. package/esm/resources/TestHelpers/Terminal/Readers.js +0 -8
  34. package/esm/resources.js +1 -83
  35. package/esm/stripe.core.js +2 -4
  36. package/esm/utils.js +24 -3
  37. package/package.json +12 -3
  38. package/types/AccountLinksResource.d.ts +1 -5
  39. package/types/AccountSessions.d.ts +0 -45
  40. package/types/AccountSessionsResource.d.ts +0 -300
  41. package/types/Accounts.d.ts +20 -212
  42. package/types/AccountsResource.d.ts +214 -546
  43. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  44. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  45. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  46. package/types/Billing/CreditGrants.d.ts +0 -5
  47. package/types/Billing/CreditGrantsResource.d.ts +1 -11
  48. package/types/BillingPortal/Sessions.d.ts +0 -5
  49. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  50. package/types/Cards.d.ts +0 -5
  51. package/types/CashBalances.d.ts +0 -5
  52. package/types/Charges.d.ts +5 -166
  53. package/types/ChargesResource.d.ts +0 -1294
  54. package/types/Checkout/Sessions.d.ts +13 -306
  55. package/types/Checkout/SessionsResource.d.ts +3 -246
  56. package/types/ConfirmationTokens.d.ts +5 -120
  57. package/types/CreditNoteLineItems.d.ts +0 -17
  58. package/types/CreditNotes.d.ts +0 -9
  59. package/types/CreditNotesResource.d.ts +0 -5
  60. package/types/CustomerBalanceTransactions.d.ts +0 -2
  61. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  62. package/types/CustomerSessions.d.ts +0 -5
  63. package/types/CustomerSessionsResource.d.ts +1 -6
  64. package/types/Customers.d.ts +0 -2
  65. package/types/CustomersResource.d.ts +23 -11
  66. package/types/Discounts.d.ts +0 -10
  67. package/types/Errors.d.ts +2 -69
  68. package/types/EventTypes.d.ts +0 -681
  69. package/types/Events.d.ts +1 -99
  70. package/types/FinancialConnections/Accounts.d.ts +1 -31
  71. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  72. package/types/FinancialConnections/Sessions.d.ts +1 -51
  73. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  74. package/types/Identity/VerificationSessions.d.ts +0 -5
  75. package/types/Identity/VerificationSessionsResource.d.ts +0 -7
  76. package/types/InvoiceItems.d.ts +0 -10
  77. package/types/InvoiceItemsResource.d.ts +6 -117
  78. package/types/InvoiceLineItems.d.ts +2 -46
  79. package/types/InvoicePayments.d.ts +0 -5
  80. package/types/InvoicePaymentsResource.d.ts +74 -0
  81. package/types/Invoices.d.ts +16 -138
  82. package/types/InvoicesResource.d.ts +20 -1550
  83. package/types/Issuing/CardholdersResource.d.ts +1 -2
  84. package/types/Issuing/Transactions.d.ts +0 -5
  85. package/types/Issuing/TransactionsResource.d.ts +0 -5
  86. package/types/LineItems.d.ts +0 -49
  87. package/types/Mandates.d.ts +0 -77
  88. package/types/PaymentIntents.d.ts +2 -675
  89. package/types/PaymentIntentsResource.d.ts +3983 -8416
  90. package/types/PaymentLinks.d.ts +0 -6
  91. package/types/PaymentLinksResource.d.ts +0 -12
  92. package/types/PaymentMethodConfigurations.d.ts +4 -148
  93. package/types/PaymentMethodConfigurationsResource.d.ts +10 -210
  94. package/types/PaymentMethods.d.ts +5 -120
  95. package/types/PaymentMethodsResource.d.ts +12 -167
  96. package/types/Payouts.d.ts +0 -5
  97. package/types/PayoutsResource.d.ts +0 -5
  98. package/types/Persons.d.ts +88 -1
  99. package/types/Prices.d.ts +0 -22
  100. package/types/PricesResource.d.ts +0 -22
  101. package/types/Products.d.ts +0 -39
  102. package/types/ProductsResource.d.ts +0 -36
  103. package/types/PromotionCodes.d.ts +0 -5
  104. package/types/PromotionCodesResource.d.ts +0 -10
  105. package/types/Quotes.d.ts +2 -597
  106. package/types/QuotesResource.d.ts +224 -2571
  107. package/types/Refunds.d.ts +10 -14
  108. package/types/SetupAttempts.d.ts +1 -50
  109. package/types/SetupIntents.d.ts +2 -121
  110. package/types/SetupIntentsResource.d.ts +18 -730
  111. package/types/Sources.d.ts +0 -29
  112. package/types/SubscriptionItems.d.ts +0 -23
  113. package/types/SubscriptionItemsResource.d.ts +0 -109
  114. package/types/SubscriptionSchedules.d.ts +0 -205
  115. package/types/SubscriptionSchedulesResource.d.ts +8 -1236
  116. package/types/Subscriptions.d.ts +2 -97
  117. package/types/SubscriptionsResource.d.ts +11 -391
  118. package/types/Tax/Calculations.d.ts +11 -1
  119. package/types/Tax/CalculationsResource.d.ts +11 -1
  120. package/types/Tax/Registrations.d.ts +99 -0
  121. package/types/Tax/RegistrationsResource.d.ts +132 -0
  122. package/types/Tax/Transactions.d.ts +11 -1
  123. package/types/TaxIds.d.ts +11 -11
  124. package/types/TaxIdsResource.d.ts +11 -11
  125. package/types/Terminal/Readers.d.ts +0 -300
  126. package/types/Terminal/ReadersResource.d.ts +0 -220
  127. package/types/TestHelpers/ConfirmationTokensResource.d.ts +12 -127
  128. package/types/TestHelpers/Terminal/ReadersResource.d.ts +0 -53
  129. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  130. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  131. package/types/TokensResource.d.ts +106 -0
  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/EventTypes.d.ts +7 -677
  140. package/types/WebhookEndpointsResource.d.ts +4 -83
  141. package/types/index.d.ts +5 -142
  142. package/types/lib.d.ts +1 -11
  143. package/types/test/typescriptTest.ts +3 -3
  144. package/cjs/resources/AccountNotices.js +0 -21
  145. package/cjs/resources/BalanceSettings.js +0 -10
  146. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  147. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  148. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  149. package/cjs/resources/ExternalAccounts.js +0 -23
  150. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  151. package/cjs/resources/GiftCards/Cards.js +0 -23
  152. package/cjs/resources/GiftCards/Transactions.js +0 -33
  153. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  154. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  155. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  156. package/cjs/resources/Margins.js +0 -22
  157. package/cjs/resources/Orders.js +0 -24
  158. package/cjs/resources/PaymentRecords.js +0 -29
  159. package/cjs/resources/Privacy/RedactionJobs.js +0 -46
  160. package/cjs/resources/Tax/Associations.js +0 -9
  161. package/cjs/resources/Tax/Forms.js +0 -20
  162. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  163. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  164. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  165. package/cjs/resources/V2/Core/Accounts.js +0 -25
  166. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  167. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  168. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  169. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -17
  170. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  171. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  172. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -12
  173. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  174. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  175. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  176. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  177. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  178. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  179. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  180. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  181. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  182. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  183. package/esm/resources/AccountNotices.js +0 -18
  184. package/esm/resources/BalanceSettings.js +0 -7
  185. package/esm/resources/Capital/FinancingOffers.js +0 -18
  186. package/esm/resources/Capital/FinancingSummary.js +0 -9
  187. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  188. package/esm/resources/ExternalAccounts.js +0 -20
  189. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  190. package/esm/resources/GiftCards/Cards.js +0 -20
  191. package/esm/resources/GiftCards/Transactions.js +0 -30
  192. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  193. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  194. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  195. package/esm/resources/Margins.js +0 -19
  196. package/esm/resources/Orders.js +0 -21
  197. package/esm/resources/PaymentRecords.js +0 -26
  198. package/esm/resources/Privacy/RedactionJobs.js +0 -43
  199. package/esm/resources/Tax/Associations.js +0 -6
  200. package/esm/resources/Tax/Forms.js +0 -17
  201. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  202. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  203. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  204. package/esm/resources/V2/Core/Accounts.js +0 -22
  205. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  206. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  207. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  208. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -14
  209. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  210. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  211. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -9
  212. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  213. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  214. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  215. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  216. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  217. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  218. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  219. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  220. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  221. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  222. package/types/AccountNotices.d.ts +0 -113
  223. package/types/AccountNoticesResource.d.ts +0 -98
  224. package/types/BalanceSettings.d.ts +0 -85
  225. package/types/BalanceSettingsResource.d.ts +0 -108
  226. package/types/Billing/MeterErrorReports.d.ts +0 -106
  227. package/types/Capital/FinancingOffers.d.ts +0 -188
  228. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  229. package/types/Capital/FinancingSummary.d.ts +0 -106
  230. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  231. package/types/Capital/FinancingTransactions.d.ts +0 -135
  232. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  233. package/types/ExternalAccountsResource.d.ts +0 -304
  234. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  235. package/types/FinancialConnections/Institutions.d.ts +0 -93
  236. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  237. package/types/GiftCards/Cards.d.ts +0 -118
  238. package/types/GiftCards/CardsResource.d.ts +0 -159
  239. package/types/GiftCards/Transactions.d.ts +0 -129
  240. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  241. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  242. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  243. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  244. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  245. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  246. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  247. package/types/Issuing/Settlements.d.ts +0 -113
  248. package/types/Margins.d.ts +0 -56
  249. package/types/MarginsResource.d.ts +0 -114
  250. package/types/Orders.d.ts +0 -1189
  251. package/types/OrdersResource.d.ts +0 -2981
  252. package/types/PaymentAttemptRecords.d.ts +0 -2112
  253. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  254. package/types/PaymentRecords.d.ts +0 -2105
  255. package/types/PaymentRecordsResource.d.ts +0 -455
  256. package/types/Privacy/RedactionJobRootObjects.d.ts +0 -35
  257. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -30
  258. package/types/Privacy/RedactionJobs.d.ts +0 -43
  259. package/types/Privacy/RedactionJobsResource.d.ts +0 -240
  260. package/types/QuoteLines.d.ts +0 -634
  261. package/types/QuotePreviewInvoices.d.ts +0 -1686
  262. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -778
  263. package/types/Tax/Associations.d.ts +0 -126
  264. package/types/Tax/AssociationsResource.d.ts +0 -29
  265. package/types/Tax/Forms.d.ts +0 -220
  266. package/types/Tax/FormsResource.d.ts +0 -107
  267. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  268. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  269. package/types/V2/Core/AccountLinks.d.ts +0 -101
  270. package/types/V2/Core/AccountLinksResource.d.ts +0 -90
  271. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3760
  272. package/types/V2/Core/Accounts.d.ts +0 -8057
  273. package/types/V2/Core/AccountsResource.d.ts +0 -10184
  274. package/types/V2/Core/Persons.d.ts +0 -1857
  275. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -155
  276. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  277. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -65
  278. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  279. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -22
  280. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -27
  281. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -105
  282. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  283. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -540
  284. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -52
  285. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -308
  286. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -287
  287. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -201
  288. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  289. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -141
  290. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -93
  291. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -273
  292. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  293. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -92
  294. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  295. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -246
  296. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -207
  297. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -146
  298. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  299. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -82
  300. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  301. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -280
  302. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  303. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -219
  304. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  305. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -151
  306. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  307. package/types/V2/MoneyManagement/Transactions.d.ts +0 -166
  308. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  309. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -66
@@ -1,1032 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Issuing {
6
- interface CreditUnderwritingRecordRetrieveParams {
7
- /**
8
- * Specifies which fields in the response should be expanded.
9
- */
10
- expand?: Array<string>;
11
- }
12
-
13
- interface CreditUnderwritingRecordListParams extends PaginationParams {
14
- /**
15
- * Specifies which fields in the response should be expanded.
16
- */
17
- expand?: Array<string>;
18
- }
19
-
20
- interface CreditUnderwritingRecordCorrectParams {
21
- /**
22
- * Details about the application submission.
23
- */
24
- application?: CreditUnderwritingRecordCorrectParams.Application;
25
-
26
- /**
27
- * Information about the company or person applying or holding the account.
28
- */
29
- credit_user?: CreditUnderwritingRecordCorrectParams.CreditUser;
30
-
31
- /**
32
- * Date when a decision was made.
33
- */
34
- decided_at?: number;
35
-
36
- /**
37
- * Details about the decision.
38
- */
39
- decision?: CreditUnderwritingRecordCorrectParams.Decision;
40
-
41
- /**
42
- * Specifies which fields in the response should be expanded.
43
- */
44
- expand?: Array<string>;
45
-
46
- /**
47
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
48
- */
49
- metadata?: Stripe.MetadataParam;
50
-
51
- /**
52
- * File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions). Optional if previously provided and no changes are needed.
53
- */
54
- regulatory_reporting_file?: string;
55
-
56
- /**
57
- * If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
58
- */
59
- underwriting_exception?: CreditUnderwritingRecordCorrectParams.UnderwritingException;
60
- }
61
-
62
- namespace CreditUnderwritingRecordCorrectParams {
63
- interface Application {
64
- /**
65
- * The channel through which the applicant has submitted their application. Defaults to `online`.
66
- */
67
- application_method?: Application.ApplicationMethod;
68
-
69
- /**
70
- * Scope of demand made by the applicant.
71
- */
72
- purpose: Application.Purpose;
73
-
74
- /**
75
- * Date when the applicant submitted their application.
76
- */
77
- submitted_at: number;
78
- }
79
-
80
- namespace Application {
81
- type ApplicationMethod = 'in_person' | 'mail' | 'online' | 'phone';
82
-
83
- type Purpose = 'credit_limit_increase' | 'credit_line_opening';
84
- }
85
-
86
- interface CreditUser {
87
- /**
88
- * Email of the applicant or accountholder.
89
- */
90
- email: string;
91
-
92
- /**
93
- * Full name of the company or person.
94
- */
95
- name: string;
96
- }
97
-
98
- interface Decision {
99
- /**
100
- * Details about the application rejection.
101
- */
102
- application_rejected?: Decision.ApplicationRejected;
103
-
104
- /**
105
- * Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
106
- */
107
- credit_limit_approved?: Decision.CreditLimitApproved;
108
-
109
- /**
110
- * Details about the credit limit decreased.
111
- */
112
- credit_limit_decreased?: Decision.CreditLimitDecreased;
113
-
114
- /**
115
- * Details about the credit line closed.
116
- */
117
- credit_line_closed?: Decision.CreditLineClosed;
118
-
119
- /**
120
- * Outcome of the decision.
121
- */
122
- type: Decision.Type;
123
- }
124
-
125
- namespace Decision {
126
- interface ApplicationRejected {
127
- /**
128
- * Details about the `reasons.other` when present.
129
- */
130
- reason_other_explanation?: string;
131
-
132
- /**
133
- * List of reasons why the application was rejected, up to 4 reasons, in order of importance.
134
- */
135
- reasons: Array<ApplicationRejected.Reason>;
136
- }
137
-
138
- namespace ApplicationRejected {
139
- type Reason =
140
- | 'applicant_is_not_beneficial_owner'
141
- | 'applicant_too_young'
142
- | 'application_is_not_beneficial_owner'
143
- | 'bankruptcy'
144
- | 'business_size_too_small'
145
- | 'current_account_tier_ineligible'
146
- | 'customer_already_exists'
147
- | 'customer_requested_account_closure'
148
- | 'debt_to_cash_balance_ratio_too_high'
149
- | 'debt_to_equity_ratio_too_high'
150
- | 'delinquent_credit_obligations'
151
- | 'dispute_rate_too_high'
152
- | 'duration_of_residence'
153
- | 'excessive_income_or_revenue_obligations'
154
- | 'expenses_to_cash_balance_ratio_too_high'
155
- | 'foreclosure_or_repossession'
156
- | 'frozen_file_at_credit_bureau'
157
- | 'garnishment_or_attachment'
158
- | 'government_loan_program_criteria'
159
- | 'high_concentration_of_clients'
160
- | 'high_risk_industry'
161
- | 'incomplete_application'
162
- | 'inconsistent_monthly_revenues'
163
- | 'insufficient_account_history_with_platform'
164
- | 'insufficient_bank_account_history'
165
- | 'insufficient_cash_balance'
166
- | 'insufficient_cash_flow'
167
- | 'insufficient_collateral'
168
- | 'insufficient_credit_experience'
169
- | 'insufficient_deposits'
170
- | 'insufficient_income'
171
- | 'insufficient_margin_ratio'
172
- | 'insufficient_operating_profit'
173
- | 'insufficient_period_in_operation'
174
- | 'insufficient_reserves'
175
- | 'insufficient_revenue'
176
- | 'insufficient_social_media_performance'
177
- | 'insufficient_time_in_network'
178
- | 'insufficient_trade_credit_insurance'
179
- | 'invalid_business_license'
180
- | 'lacking_cash_account'
181
- | 'late_payment_history_reported_to_bureau'
182
- | 'lien_collection_action_or_judgement'
183
- | 'negative_public_information'
184
- | 'no_credit_file'
185
- | 'other'
186
- | 'outside_supported_country'
187
- | 'outside_supported_state'
188
- | 'poor_payment_history_with_platform'
189
- | 'prior_or_current_legal_action'
190
- | 'prohibited_industry'
191
- | 'rate_of_cash_balance_fluctuation_too_high'
192
- | 'recent_inquiries_on_business_credit_report'
193
- | 'removal_of_bank_account_connection'
194
- | 'revenue_discrepancy'
195
- | 'runway_too_short'
196
- | 'suspected_fraud'
197
- | 'too_many_non_sufficient_funds_or_overdrafts'
198
- | 'unable_to_verify_address'
199
- | 'unable_to_verify_identity'
200
- | 'unable_to_verify_income_or_revenue'
201
- | 'unprofitable'
202
- | 'unsupportable_business_type';
203
- }
204
-
205
- interface CreditLimitApproved {
206
- /**
207
- * The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
208
- */
209
- amount: number;
210
-
211
- /**
212
- * The currency of the credit approved, will default to the Account's Issuing currency.
213
- */
214
- currency?: string;
215
- }
216
-
217
- interface CreditLimitDecreased {
218
- /**
219
- * The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
220
- */
221
- amount: number;
222
-
223
- /**
224
- * The currency of the credit approved, will default to the Account's Issuing currency.
225
- */
226
- currency?: string;
227
-
228
- /**
229
- * Details about the `reasons.other` when present.
230
- */
231
- reason_other_explanation?: string;
232
-
233
- /**
234
- * List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.
235
- */
236
- reasons: Array<CreditLimitDecreased.Reason>;
237
- }
238
-
239
- namespace CreditLimitDecreased {
240
- type Reason =
241
- | 'applicant_is_not_beneficial_owner'
242
- | 'applicant_too_young'
243
- | 'application_is_not_beneficial_owner'
244
- | 'bankruptcy'
245
- | 'business_size_too_small'
246
- | 'change_in_financial_state'
247
- | 'change_in_utilization_of_credit_line'
248
- | 'current_account_tier_ineligible'
249
- | 'customer_already_exists'
250
- | 'customer_requested_account_closure'
251
- | 'debt_to_cash_balance_ratio_too_high'
252
- | 'debt_to_equity_ratio_too_high'
253
- | 'decrease_in_income_to_expense_ratio'
254
- | 'decrease_in_social_media_performance'
255
- | 'delinquent_credit_obligations'
256
- | 'dispute_rate_too_high'
257
- | 'duration_of_residence'
258
- | 'exceeds_acceptable_platform_exposure'
259
- | 'excessive_income_or_revenue_obligations'
260
- | 'expenses_to_cash_balance_ratio_too_high'
261
- | 'foreclosure_or_repossession'
262
- | 'frozen_file_at_credit_bureau'
263
- | 'garnishment_or_attachment'
264
- | 'government_loan_program_criteria'
265
- | 'has_recent_credit_limit_increase'
266
- | 'high_concentration_of_clients'
267
- | 'high_risk_industry'
268
- | 'incomplete_application'
269
- | 'inconsistent_monthly_revenues'
270
- | 'insufficient_account_history_with_platform'
271
- | 'insufficient_bank_account_history'
272
- | 'insufficient_cash_balance'
273
- | 'insufficient_cash_flow'
274
- | 'insufficient_collateral'
275
- | 'insufficient_credit_experience'
276
- | 'insufficient_credit_utilization'
277
- | 'insufficient_deposits'
278
- | 'insufficient_income'
279
- | 'insufficient_margin_ratio'
280
- | 'insufficient_operating_profit'
281
- | 'insufficient_period_in_operation'
282
- | 'insufficient_reserves'
283
- | 'insufficient_revenue'
284
- | 'insufficient_social_media_performance'
285
- | 'insufficient_time_in_network'
286
- | 'insufficient_trade_credit_insurance'
287
- | 'insufficient_usage_as_qualified_expenses'
288
- | 'invalid_business_license'
289
- | 'lacking_cash_account'
290
- | 'late_payment_history_reported_to_bureau'
291
- | 'lien_collection_action_or_judgement'
292
- | 'negative_public_information'
293
- | 'no_credit_file'
294
- | 'other'
295
- | 'outside_supported_country'
296
- | 'outside_supported_state'
297
- | 'poor_payment_history_with_platform'
298
- | 'prior_or_current_legal_action'
299
- | 'prohibited_industry'
300
- | 'rate_of_cash_balance_fluctuation_too_high'
301
- | 'recent_inquiries_on_business_credit_report'
302
- | 'removal_of_bank_account_connection'
303
- | 'revenue_discrepancy'
304
- | 'runway_too_short'
305
- | 'suspected_fraud'
306
- | 'too_many_non_sufficient_funds_or_overdrafts'
307
- | 'unable_to_verify_address'
308
- | 'unable_to_verify_identity'
309
- | 'unable_to_verify_income_or_revenue'
310
- | 'unprofitable'
311
- | 'unsupportable_business_type';
312
- }
313
-
314
- interface CreditLineClosed {
315
- /**
316
- * Details about the `reasons.other` when present.
317
- */
318
- reason_other_explanation?: string;
319
-
320
- /**
321
- * List of reasons why the credit line was closed, up to 4 reasons, in order of importance.
322
- */
323
- reasons: Array<CreditLineClosed.Reason>;
324
- }
325
-
326
- namespace CreditLineClosed {
327
- type Reason =
328
- | 'applicant_is_not_beneficial_owner'
329
- | 'applicant_too_young'
330
- | 'application_is_not_beneficial_owner'
331
- | 'bankruptcy'
332
- | 'business_size_too_small'
333
- | 'change_in_financial_state'
334
- | 'change_in_utilization_of_credit_line'
335
- | 'current_account_tier_ineligible'
336
- | 'customer_already_exists'
337
- | 'customer_requested_account_closure'
338
- | 'debt_to_cash_balance_ratio_too_high'
339
- | 'debt_to_equity_ratio_too_high'
340
- | 'decrease_in_income_to_expense_ratio'
341
- | 'decrease_in_social_media_performance'
342
- | 'delinquent_credit_obligations'
343
- | 'dispute_rate_too_high'
344
- | 'duration_of_residence'
345
- | 'exceeds_acceptable_platform_exposure'
346
- | 'excessive_income_or_revenue_obligations'
347
- | 'expenses_to_cash_balance_ratio_too_high'
348
- | 'foreclosure_or_repossession'
349
- | 'frozen_file_at_credit_bureau'
350
- | 'garnishment_or_attachment'
351
- | 'government_loan_program_criteria'
352
- | 'has_recent_credit_limit_increase'
353
- | 'high_concentration_of_clients'
354
- | 'high_risk_industry'
355
- | 'incomplete_application'
356
- | 'inconsistent_monthly_revenues'
357
- | 'insufficient_account_history_with_platform'
358
- | 'insufficient_bank_account_history'
359
- | 'insufficient_cash_balance'
360
- | 'insufficient_cash_flow'
361
- | 'insufficient_collateral'
362
- | 'insufficient_credit_experience'
363
- | 'insufficient_credit_utilization'
364
- | 'insufficient_deposits'
365
- | 'insufficient_income'
366
- | 'insufficient_margin_ratio'
367
- | 'insufficient_operating_profit'
368
- | 'insufficient_period_in_operation'
369
- | 'insufficient_reserves'
370
- | 'insufficient_revenue'
371
- | 'insufficient_social_media_performance'
372
- | 'insufficient_time_in_network'
373
- | 'insufficient_trade_credit_insurance'
374
- | 'insufficient_usage_as_qualified_expenses'
375
- | 'invalid_business_license'
376
- | 'lacking_cash_account'
377
- | 'late_payment_history_reported_to_bureau'
378
- | 'lien_collection_action_or_judgement'
379
- | 'negative_public_information'
380
- | 'no_credit_file'
381
- | 'other'
382
- | 'outside_supported_country'
383
- | 'outside_supported_state'
384
- | 'poor_payment_history_with_platform'
385
- | 'prior_or_current_legal_action'
386
- | 'prohibited_industry'
387
- | 'rate_of_cash_balance_fluctuation_too_high'
388
- | 'recent_inquiries_on_business_credit_report'
389
- | 'removal_of_bank_account_connection'
390
- | 'revenue_discrepancy'
391
- | 'runway_too_short'
392
- | 'suspected_fraud'
393
- | 'too_many_non_sufficient_funds_or_overdrafts'
394
- | 'unable_to_verify_address'
395
- | 'unable_to_verify_identity'
396
- | 'unable_to_verify_income_or_revenue'
397
- | 'unprofitable'
398
- | 'unsupportable_business_type';
399
- }
400
-
401
- type Type =
402
- | 'additional_information_requested'
403
- | 'application_rejected'
404
- | 'credit_limit_approved'
405
- | 'credit_limit_decreased'
406
- | 'credit_line_closed'
407
- | 'no_changes'
408
- | 'withdrawn_by_applicant';
409
- }
410
-
411
- interface UnderwritingException {
412
- /**
413
- * Written explanation for the exception.
414
- */
415
- explanation: string;
416
-
417
- /**
418
- * The decision before the exception was applied.
419
- */
420
- original_decision_type: UnderwritingException.OriginalDecisionType;
421
- }
422
-
423
- namespace UnderwritingException {
424
- type OriginalDecisionType =
425
- | 'additional_information_requested'
426
- | 'application_rejected'
427
- | 'credit_limit_approved'
428
- | 'credit_limit_decreased'
429
- | 'credit_line_closed'
430
- | 'no_changes'
431
- | 'withdrawn_by_applicant';
432
- }
433
- }
434
-
435
- interface CreditUnderwritingRecordCreateFromApplicationParams {
436
- /**
437
- * Details about the application submission.
438
- */
439
- application: CreditUnderwritingRecordCreateFromApplicationParams.Application;
440
-
441
- /**
442
- * Information about the company or person applying or holding the account.
443
- */
444
- credit_user: CreditUnderwritingRecordCreateFromApplicationParams.CreditUser;
445
-
446
- /**
447
- * Specifies which fields in the response should be expanded.
448
- */
449
- expand?: Array<string>;
450
-
451
- /**
452
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
453
- */
454
- metadata?: Stripe.MetadataParam;
455
- }
456
-
457
- namespace CreditUnderwritingRecordCreateFromApplicationParams {
458
- interface Application {
459
- /**
460
- * The channel through which the applicant has submitted their application. Defaults to `online`.
461
- */
462
- application_method?: Application.ApplicationMethod;
463
-
464
- /**
465
- * Scope of demand made by the applicant.
466
- */
467
- purpose: Application.Purpose;
468
-
469
- /**
470
- * Date when the applicant submitted their application.
471
- */
472
- submitted_at: number;
473
- }
474
-
475
- namespace Application {
476
- type ApplicationMethod = 'in_person' | 'mail' | 'online' | 'phone';
477
-
478
- type Purpose = 'credit_limit_increase' | 'credit_line_opening';
479
- }
480
-
481
- interface CreditUser {
482
- /**
483
- * Email of the applicant or accountholder.
484
- */
485
- email: string;
486
-
487
- /**
488
- * Full name of the company or person.
489
- */
490
- name: string;
491
- }
492
- }
493
-
494
- interface CreditUnderwritingRecordCreateFromProactiveReviewParams {
495
- /**
496
- * Information about the company or person applying or holding the account.
497
- */
498
- credit_user: CreditUnderwritingRecordCreateFromProactiveReviewParams.CreditUser;
499
-
500
- /**
501
- * Date when a decision was made.
502
- */
503
- decided_at: number;
504
-
505
- /**
506
- * Details about the decision.
507
- */
508
- decision: CreditUnderwritingRecordCreateFromProactiveReviewParams.Decision;
509
-
510
- /**
511
- * Specifies which fields in the response should be expanded.
512
- */
513
- expand?: Array<string>;
514
-
515
- /**
516
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
517
- */
518
- metadata?: Stripe.MetadataParam;
519
-
520
- /**
521
- * File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).
522
- */
523
- regulatory_reporting_file?: string;
524
-
525
- /**
526
- * If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
527
- */
528
- underwriting_exception?: CreditUnderwritingRecordCreateFromProactiveReviewParams.UnderwritingException;
529
- }
530
-
531
- namespace CreditUnderwritingRecordCreateFromProactiveReviewParams {
532
- interface CreditUser {
533
- /**
534
- * Email of the applicant or accountholder.
535
- */
536
- email: string;
537
-
538
- /**
539
- * Full name of the company or person.
540
- */
541
- name: string;
542
- }
543
-
544
- interface Decision {
545
- /**
546
- * Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
547
- */
548
- credit_limit_approved?: Decision.CreditLimitApproved;
549
-
550
- /**
551
- * Details about the credit limit decreased.
552
- */
553
- credit_limit_decreased?: Decision.CreditLimitDecreased;
554
-
555
- /**
556
- * Details about the credit line closed.
557
- */
558
- credit_line_closed?: Decision.CreditLineClosed;
559
-
560
- /**
561
- * Outcome of the decision.
562
- */
563
- type: Decision.Type;
564
- }
565
-
566
- namespace Decision {
567
- interface CreditLimitApproved {
568
- /**
569
- * The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
570
- */
571
- amount: number;
572
-
573
- /**
574
- * The currency of the credit approved, will default to the Account's Issuing currency.
575
- */
576
- currency?: string;
577
- }
578
-
579
- interface CreditLimitDecreased {
580
- /**
581
- * The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
582
- */
583
- amount: number;
584
-
585
- /**
586
- * The currency of the credit approved, will default to the Account's Issuing currency.
587
- */
588
- currency?: string;
589
-
590
- /**
591
- * Details about the `reasons.other` when present.
592
- */
593
- reason_other_explanation?: string;
594
-
595
- /**
596
- * List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.
597
- */
598
- reasons: Array<CreditLimitDecreased.Reason>;
599
- }
600
-
601
- namespace CreditLimitDecreased {
602
- type Reason =
603
- | 'applicant_is_not_beneficial_owner'
604
- | 'applicant_too_young'
605
- | 'application_is_not_beneficial_owner'
606
- | 'bankruptcy'
607
- | 'business_size_too_small'
608
- | 'change_in_financial_state'
609
- | 'change_in_utilization_of_credit_line'
610
- | 'current_account_tier_ineligible'
611
- | 'customer_already_exists'
612
- | 'customer_requested_account_closure'
613
- | 'debt_to_cash_balance_ratio_too_high'
614
- | 'debt_to_equity_ratio_too_high'
615
- | 'decrease_in_income_to_expense_ratio'
616
- | 'decrease_in_social_media_performance'
617
- | 'delinquent_credit_obligations'
618
- | 'dispute_rate_too_high'
619
- | 'duration_of_residence'
620
- | 'exceeds_acceptable_platform_exposure'
621
- | 'excessive_income_or_revenue_obligations'
622
- | 'expenses_to_cash_balance_ratio_too_high'
623
- | 'foreclosure_or_repossession'
624
- | 'frozen_file_at_credit_bureau'
625
- | 'garnishment_or_attachment'
626
- | 'government_loan_program_criteria'
627
- | 'has_recent_credit_limit_increase'
628
- | 'high_concentration_of_clients'
629
- | 'high_risk_industry'
630
- | 'incomplete_application'
631
- | 'inconsistent_monthly_revenues'
632
- | 'insufficient_account_history_with_platform'
633
- | 'insufficient_bank_account_history'
634
- | 'insufficient_cash_balance'
635
- | 'insufficient_cash_flow'
636
- | 'insufficient_collateral'
637
- | 'insufficient_credit_experience'
638
- | 'insufficient_credit_utilization'
639
- | 'insufficient_deposits'
640
- | 'insufficient_income'
641
- | 'insufficient_margin_ratio'
642
- | 'insufficient_operating_profit'
643
- | 'insufficient_period_in_operation'
644
- | 'insufficient_reserves'
645
- | 'insufficient_revenue'
646
- | 'insufficient_social_media_performance'
647
- | 'insufficient_time_in_network'
648
- | 'insufficient_trade_credit_insurance'
649
- | 'insufficient_usage_as_qualified_expenses'
650
- | 'invalid_business_license'
651
- | 'lacking_cash_account'
652
- | 'late_payment_history_reported_to_bureau'
653
- | 'lien_collection_action_or_judgement'
654
- | 'negative_public_information'
655
- | 'no_credit_file'
656
- | 'other'
657
- | 'outside_supported_country'
658
- | 'outside_supported_state'
659
- | 'poor_payment_history_with_platform'
660
- | 'prior_or_current_legal_action'
661
- | 'prohibited_industry'
662
- | 'rate_of_cash_balance_fluctuation_too_high'
663
- | 'recent_inquiries_on_business_credit_report'
664
- | 'removal_of_bank_account_connection'
665
- | 'revenue_discrepancy'
666
- | 'runway_too_short'
667
- | 'suspected_fraud'
668
- | 'too_many_non_sufficient_funds_or_overdrafts'
669
- | 'unable_to_verify_address'
670
- | 'unable_to_verify_identity'
671
- | 'unable_to_verify_income_or_revenue'
672
- | 'unprofitable'
673
- | 'unsupportable_business_type';
674
- }
675
-
676
- interface CreditLineClosed {
677
- /**
678
- * Details about the `reasons.other` when present.
679
- */
680
- reason_other_explanation?: string;
681
-
682
- /**
683
- * List of reasons why the credit line was closed, up to 4 reasons, in order of importance.
684
- */
685
- reasons: Array<CreditLineClosed.Reason>;
686
- }
687
-
688
- namespace CreditLineClosed {
689
- type Reason =
690
- | 'applicant_is_not_beneficial_owner'
691
- | 'applicant_too_young'
692
- | 'application_is_not_beneficial_owner'
693
- | 'bankruptcy'
694
- | 'business_size_too_small'
695
- | 'change_in_financial_state'
696
- | 'change_in_utilization_of_credit_line'
697
- | 'current_account_tier_ineligible'
698
- | 'customer_already_exists'
699
- | 'customer_requested_account_closure'
700
- | 'debt_to_cash_balance_ratio_too_high'
701
- | 'debt_to_equity_ratio_too_high'
702
- | 'decrease_in_income_to_expense_ratio'
703
- | 'decrease_in_social_media_performance'
704
- | 'delinquent_credit_obligations'
705
- | 'dispute_rate_too_high'
706
- | 'duration_of_residence'
707
- | 'exceeds_acceptable_platform_exposure'
708
- | 'excessive_income_or_revenue_obligations'
709
- | 'expenses_to_cash_balance_ratio_too_high'
710
- | 'foreclosure_or_repossession'
711
- | 'frozen_file_at_credit_bureau'
712
- | 'garnishment_or_attachment'
713
- | 'government_loan_program_criteria'
714
- | 'has_recent_credit_limit_increase'
715
- | 'high_concentration_of_clients'
716
- | 'high_risk_industry'
717
- | 'incomplete_application'
718
- | 'inconsistent_monthly_revenues'
719
- | 'insufficient_account_history_with_platform'
720
- | 'insufficient_bank_account_history'
721
- | 'insufficient_cash_balance'
722
- | 'insufficient_cash_flow'
723
- | 'insufficient_collateral'
724
- | 'insufficient_credit_experience'
725
- | 'insufficient_credit_utilization'
726
- | 'insufficient_deposits'
727
- | 'insufficient_income'
728
- | 'insufficient_margin_ratio'
729
- | 'insufficient_operating_profit'
730
- | 'insufficient_period_in_operation'
731
- | 'insufficient_reserves'
732
- | 'insufficient_revenue'
733
- | 'insufficient_social_media_performance'
734
- | 'insufficient_time_in_network'
735
- | 'insufficient_trade_credit_insurance'
736
- | 'insufficient_usage_as_qualified_expenses'
737
- | 'invalid_business_license'
738
- | 'lacking_cash_account'
739
- | 'late_payment_history_reported_to_bureau'
740
- | 'lien_collection_action_or_judgement'
741
- | 'negative_public_information'
742
- | 'no_credit_file'
743
- | 'other'
744
- | 'outside_supported_country'
745
- | 'outside_supported_state'
746
- | 'poor_payment_history_with_platform'
747
- | 'prior_or_current_legal_action'
748
- | 'prohibited_industry'
749
- | 'rate_of_cash_balance_fluctuation_too_high'
750
- | 'recent_inquiries_on_business_credit_report'
751
- | 'removal_of_bank_account_connection'
752
- | 'revenue_discrepancy'
753
- | 'runway_too_short'
754
- | 'suspected_fraud'
755
- | 'too_many_non_sufficient_funds_or_overdrafts'
756
- | 'unable_to_verify_address'
757
- | 'unable_to_verify_identity'
758
- | 'unable_to_verify_income_or_revenue'
759
- | 'unprofitable'
760
- | 'unsupportable_business_type';
761
- }
762
-
763
- type Type =
764
- | 'credit_limit_approved'
765
- | 'credit_limit_decreased'
766
- | 'credit_line_closed'
767
- | 'no_changes';
768
- }
769
-
770
- interface UnderwritingException {
771
- /**
772
- * Written explanation for the exception.
773
- */
774
- explanation: string;
775
-
776
- /**
777
- * The decision before the exception was applied.
778
- */
779
- original_decision_type: UnderwritingException.OriginalDecisionType;
780
- }
781
-
782
- namespace UnderwritingException {
783
- type OriginalDecisionType =
784
- | 'additional_information_requested'
785
- | 'application_rejected'
786
- | 'credit_limit_approved'
787
- | 'credit_limit_decreased'
788
- | 'credit_line_closed'
789
- | 'no_changes'
790
- | 'withdrawn_by_applicant';
791
- }
792
- }
793
-
794
- interface CreditUnderwritingRecordReportDecisionParams {
795
- /**
796
- * Date when a decision was made.
797
- */
798
- decided_at: number;
799
-
800
- /**
801
- * Details about the decision.
802
- */
803
- decision: CreditUnderwritingRecordReportDecisionParams.Decision;
804
-
805
- /**
806
- * Specifies which fields in the response should be expanded.
807
- */
808
- expand?: Array<string>;
809
-
810
- /**
811
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
812
- */
813
- metadata?: Stripe.MetadataParam;
814
-
815
- /**
816
- * File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).
817
- */
818
- regulatory_reporting_file?: string;
819
-
820
- /**
821
- * If an exception to the usual underwriting criteria was made for this decision, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
822
- */
823
- underwriting_exception?: CreditUnderwritingRecordReportDecisionParams.UnderwritingException;
824
- }
825
-
826
- namespace CreditUnderwritingRecordReportDecisionParams {
827
- interface Decision {
828
- /**
829
- * Details about the application rejection.
830
- */
831
- application_rejected?: Decision.ApplicationRejected;
832
-
833
- /**
834
- * Details about the credit limit approved. An approved credit limit is required before you can set a `credit_limit_amount` in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy/)
835
- */
836
- credit_limit_approved?: Decision.CreditLimitApproved;
837
-
838
- /**
839
- * Outcome of the decision.
840
- */
841
- type: Decision.Type;
842
- }
843
-
844
- namespace Decision {
845
- interface ApplicationRejected {
846
- /**
847
- * Details about the `reasons.other` when present.
848
- */
849
- reason_other_explanation?: string;
850
-
851
- /**
852
- * List of reasons why the application was rejected, up to 4 reasons, in order of importance.
853
- */
854
- reasons: Array<ApplicationRejected.Reason>;
855
- }
856
-
857
- namespace ApplicationRejected {
858
- type Reason =
859
- | 'applicant_is_not_beneficial_owner'
860
- | 'applicant_too_young'
861
- | 'application_is_not_beneficial_owner'
862
- | 'bankruptcy'
863
- | 'business_size_too_small'
864
- | 'current_account_tier_ineligible'
865
- | 'customer_already_exists'
866
- | 'customer_requested_account_closure'
867
- | 'debt_to_cash_balance_ratio_too_high'
868
- | 'debt_to_equity_ratio_too_high'
869
- | 'delinquent_credit_obligations'
870
- | 'dispute_rate_too_high'
871
- | 'duration_of_residence'
872
- | 'excessive_income_or_revenue_obligations'
873
- | 'expenses_to_cash_balance_ratio_too_high'
874
- | 'foreclosure_or_repossession'
875
- | 'frozen_file_at_credit_bureau'
876
- | 'garnishment_or_attachment'
877
- | 'government_loan_program_criteria'
878
- | 'high_concentration_of_clients'
879
- | 'high_risk_industry'
880
- | 'incomplete_application'
881
- | 'inconsistent_monthly_revenues'
882
- | 'insufficient_account_history_with_platform'
883
- | 'insufficient_bank_account_history'
884
- | 'insufficient_cash_balance'
885
- | 'insufficient_cash_flow'
886
- | 'insufficient_collateral'
887
- | 'insufficient_credit_experience'
888
- | 'insufficient_deposits'
889
- | 'insufficient_income'
890
- | 'insufficient_margin_ratio'
891
- | 'insufficient_operating_profit'
892
- | 'insufficient_period_in_operation'
893
- | 'insufficient_reserves'
894
- | 'insufficient_revenue'
895
- | 'insufficient_social_media_performance'
896
- | 'insufficient_time_in_network'
897
- | 'insufficient_trade_credit_insurance'
898
- | 'invalid_business_license'
899
- | 'lacking_cash_account'
900
- | 'late_payment_history_reported_to_bureau'
901
- | 'lien_collection_action_or_judgement'
902
- | 'negative_public_information'
903
- | 'no_credit_file'
904
- | 'other'
905
- | 'outside_supported_country'
906
- | 'outside_supported_state'
907
- | 'poor_payment_history_with_platform'
908
- | 'prior_or_current_legal_action'
909
- | 'prohibited_industry'
910
- | 'rate_of_cash_balance_fluctuation_too_high'
911
- | 'recent_inquiries_on_business_credit_report'
912
- | 'removal_of_bank_account_connection'
913
- | 'revenue_discrepancy'
914
- | 'runway_too_short'
915
- | 'suspected_fraud'
916
- | 'too_many_non_sufficient_funds_or_overdrafts'
917
- | 'unable_to_verify_address'
918
- | 'unable_to_verify_identity'
919
- | 'unable_to_verify_income_or_revenue'
920
- | 'unprofitable'
921
- | 'unsupportable_business_type';
922
- }
923
-
924
- interface CreditLimitApproved {
925
- /**
926
- * The credit approved, in the currency of the account and [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
927
- */
928
- amount: number;
929
-
930
- /**
931
- * The currency of the credit approved, will default to the Account's Issuing currency.
932
- */
933
- currency?: string;
934
- }
935
-
936
- type Type =
937
- | 'additional_information_requested'
938
- | 'application_rejected'
939
- | 'credit_limit_approved'
940
- | 'withdrawn_by_applicant';
941
- }
942
-
943
- interface UnderwritingException {
944
- /**
945
- * Written explanation for the exception.
946
- */
947
- explanation: string;
948
-
949
- /**
950
- * The decision before the exception was applied.
951
- */
952
- original_decision_type: UnderwritingException.OriginalDecisionType;
953
- }
954
-
955
- namespace UnderwritingException {
956
- type OriginalDecisionType =
957
- | 'additional_information_requested'
958
- | 'application_rejected'
959
- | 'credit_limit_approved'
960
- | 'credit_limit_decreased'
961
- | 'credit_line_closed'
962
- | 'no_changes'
963
- | 'withdrawn_by_applicant';
964
- }
965
- }
966
-
967
- class CreditUnderwritingRecordsResource {
968
- /**
969
- * Retrieves a CreditUnderwritingRecord object.
970
- */
971
- retrieve(
972
- id: string,
973
- params?: CreditUnderwritingRecordRetrieveParams,
974
- options?: RequestOptions
975
- ): Promise<Stripe.Response<Stripe.Issuing.CreditUnderwritingRecord>>;
976
- retrieve(
977
- id: string,
978
- options?: RequestOptions
979
- ): Promise<Stripe.Response<Stripe.Issuing.CreditUnderwritingRecord>>;
980
-
981
- /**
982
- * Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
983
- */
984
- list(
985
- params?: CreditUnderwritingRecordListParams,
986
- options?: RequestOptions
987
- ): ApiListPromise<Stripe.Issuing.CreditUnderwritingRecord>;
988
- list(
989
- options?: RequestOptions
990
- ): ApiListPromise<Stripe.Issuing.CreditUnderwritingRecord>;
991
-
992
- /**
993
- * Update a CreditUnderwritingRecord object to correct mistakes.
994
- */
995
- correct(
996
- id: string,
997
- params?: CreditUnderwritingRecordCorrectParams,
998
- options?: RequestOptions
999
- ): Promise<Stripe.Response<Stripe.Issuing.CreditUnderwritingRecord>>;
1000
- correct(
1001
- id: string,
1002
- options?: RequestOptions
1003
- ): Promise<Stripe.Response<Stripe.Issuing.CreditUnderwritingRecord>>;
1004
-
1005
- /**
1006
- * Creates a CreditUnderwritingRecord object with information about a credit application submission.
1007
- */
1008
- createFromApplication(
1009
- params: CreditUnderwritingRecordCreateFromApplicationParams,
1010
- options?: RequestOptions
1011
- ): Promise<Stripe.Response<Stripe.Issuing.CreditUnderwritingRecord>>;
1012
-
1013
- /**
1014
- * Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
1015
- */
1016
- createFromProactiveReview(
1017
- params: CreditUnderwritingRecordCreateFromProactiveReviewParams,
1018
- options?: RequestOptions
1019
- ): Promise<Stripe.Response<Stripe.Issuing.CreditUnderwritingRecord>>;
1020
-
1021
- /**
1022
- * Update a CreditUnderwritingRecord object from a decision made on a credit application.
1023
- */
1024
- reportDecision(
1025
- id: string,
1026
- params: CreditUnderwritingRecordReportDecisionParams,
1027
- options?: RequestOptions
1028
- ): Promise<Stripe.Response<Stripe.Issuing.CreditUnderwritingRecord>>;
1029
- }
1030
- }
1031
- }
1032
- }