stripe 18.2.1 → 18.3.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/CHANGELOG.md +1243 -14
  2. package/README.md +1 -0
  3. package/VERSION +1 -1
  4. package/cjs/Error.js +91 -1
  5. package/cjs/RequestSender.js +1 -1
  6. package/cjs/apiVersion.js +1 -1
  7. package/cjs/resources/AccountNotices.js +21 -0
  8. package/cjs/resources/BalanceSettings.js +10 -0
  9. package/cjs/resources/Capital/FinancingOffers.js +21 -0
  10. package/cjs/resources/Capital/FinancingSummary.js +12 -0
  11. package/cjs/resources/Capital/FinancingTransactions.js +17 -0
  12. package/cjs/resources/ExternalAccounts.js +23 -0
  13. package/cjs/resources/FinancialConnections/Accounts.js +5 -0
  14. package/cjs/resources/FinancialConnections/Institutions.js +17 -0
  15. package/cjs/resources/FxQuotes.js +15 -0
  16. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +33 -0
  17. package/cjs/resources/Issuing/DisputeSettlementDetails.js +17 -0
  18. package/cjs/resources/Issuing/FraudLiabilityDebits.js +17 -0
  19. package/cjs/resources/Margins.js +22 -0
  20. package/cjs/resources/Orders.js +24 -0
  21. package/cjs/resources/{InvoicePayments.js → PaymentAttemptRecords.js} +4 -4
  22. package/cjs/resources/PaymentIntents.js +13 -0
  23. package/cjs/resources/PaymentRecords.js +29 -0
  24. package/cjs/resources/Privacy/RedactionJobs.js +42 -0
  25. package/cjs/resources/Quotes.js +32 -0
  26. package/cjs/resources/SubscriptionSchedules.js +4 -0
  27. package/cjs/resources/Subscriptions.js +4 -0
  28. package/cjs/resources/Tax/Associations.js +9 -0
  29. package/cjs/resources/Tax/Forms.js +20 -0
  30. package/cjs/resources/Terminal/ReaderCollectedData.js +12 -0
  31. package/cjs/resources/Terminal/Readers.js +8 -0
  32. package/cjs/resources/V2/Core/AccountLinks.js +9 -0
  33. package/cjs/resources/V2/Core/Accounts/Persons.js +29 -0
  34. package/cjs/resources/V2/Core/Accounts.js +25 -0
  35. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +28 -0
  36. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +24 -0
  37. package/cjs/resources/V2/MoneyManagement/Adjustments.js +17 -0
  38. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +17 -0
  39. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +21 -0
  40. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +21 -0
  41. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +16 -0
  42. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +25 -0
  43. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +29 -0
  44. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +25 -0
  45. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +25 -0
  46. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +12 -0
  47. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +17 -0
  48. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +17 -0
  49. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +17 -0
  50. package/cjs/resources/V2/MoneyManagement/Transactions.js +17 -0
  51. package/cjs/resources/V2/Payments/OffSessionPayments.js +25 -0
  52. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +16 -0
  53. package/cjs/resources.js +98 -10
  54. package/cjs/stripe.core.js +1 -1
  55. package/esm/Error.js +79 -0
  56. package/esm/RequestSender.js +1 -1
  57. package/esm/apiVersion.js +1 -1
  58. package/esm/resources/AccountNotices.js +18 -0
  59. package/esm/resources/BalanceSettings.js +7 -0
  60. package/esm/resources/Capital/FinancingOffers.js +18 -0
  61. package/esm/resources/Capital/FinancingSummary.js +9 -0
  62. package/esm/resources/Capital/FinancingTransactions.js +14 -0
  63. package/esm/resources/ExternalAccounts.js +20 -0
  64. package/esm/resources/FinancialConnections/Accounts.js +5 -0
  65. package/esm/resources/FinancialConnections/Institutions.js +14 -0
  66. package/esm/resources/FxQuotes.js +12 -0
  67. package/esm/resources/Issuing/CreditUnderwritingRecords.js +30 -0
  68. package/esm/resources/Issuing/DisputeSettlementDetails.js +14 -0
  69. package/esm/resources/Issuing/FraudLiabilityDebits.js +14 -0
  70. package/esm/resources/Margins.js +19 -0
  71. package/esm/resources/Orders.js +21 -0
  72. package/esm/resources/{InvoicePayments.js → PaymentAttemptRecords.js} +3 -3
  73. package/esm/resources/PaymentIntents.js +13 -0
  74. package/esm/resources/PaymentRecords.js +26 -0
  75. package/esm/resources/Privacy/RedactionJobs.js +39 -0
  76. package/esm/resources/Quotes.js +32 -0
  77. package/esm/resources/SubscriptionSchedules.js +4 -0
  78. package/esm/resources/Subscriptions.js +4 -0
  79. package/esm/resources/Tax/Associations.js +6 -0
  80. package/esm/resources/Tax/Forms.js +17 -0
  81. package/esm/resources/Terminal/ReaderCollectedData.js +9 -0
  82. package/esm/resources/Terminal/Readers.js +8 -0
  83. package/esm/resources/V2/Core/AccountLinks.js +6 -0
  84. package/esm/resources/V2/Core/Accounts/Persons.js +26 -0
  85. package/esm/resources/V2/Core/Accounts.js +22 -0
  86. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +25 -0
  87. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +21 -0
  88. package/esm/resources/V2/MoneyManagement/Adjustments.js +14 -0
  89. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +14 -0
  90. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +18 -0
  91. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +18 -0
  92. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +13 -0
  93. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +22 -0
  94. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +26 -0
  95. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +22 -0
  96. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +22 -0
  97. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +9 -0
  98. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +14 -0
  99. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +14 -0
  100. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +14 -0
  101. package/esm/resources/V2/MoneyManagement/Transactions.js +14 -0
  102. package/esm/resources/V2/Payments/OffSessionPayments.js +22 -0
  103. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +13 -0
  104. package/esm/resources.js +82 -1
  105. package/esm/stripe.core.js +1 -1
  106. package/package.json +1 -1
  107. package/types/AccountLinksResource.d.ts +5 -1
  108. package/types/AccountNotices.d.ts +113 -0
  109. package/types/AccountNoticesResource.d.ts +98 -0
  110. package/types/AccountSessions.d.ts +45 -0
  111. package/types/AccountSessionsResource.d.ts +264 -0
  112. package/types/Accounts.d.ts +212 -1
  113. package/types/AccountsResource.d.ts +544 -0
  114. package/types/BalanceSettings.d.ts +89 -0
  115. package/types/BalanceSettingsResource.d.ts +108 -0
  116. package/types/Billing/CreditBalanceSummary.d.ts +5 -0
  117. package/types/Billing/CreditBalanceSummaryResource.d.ts +8 -3
  118. package/types/Billing/CreditBalanceTransactionsResource.d.ts +12 -4
  119. package/types/Billing/CreditGrants.d.ts +5 -0
  120. package/types/Billing/CreditGrantsResource.d.ts +11 -1
  121. package/types/BillingPortal/Sessions.d.ts +5 -0
  122. package/types/BillingPortal/SessionsResource.d.ts +12 -4
  123. package/types/Capital/FinancingOffers.d.ts +188 -0
  124. package/types/Capital/FinancingOffersResource.d.ts +97 -0
  125. package/types/Capital/FinancingSummary.d.ts +106 -0
  126. package/types/Capital/FinancingSummaryResource.d.ts +27 -0
  127. package/types/Capital/FinancingTransactions.d.ts +135 -0
  128. package/types/Capital/FinancingTransactionsResource.d.ts +68 -0
  129. package/types/Cards.d.ts +5 -0
  130. package/types/CashBalances.d.ts +5 -0
  131. package/types/Charges.d.ts +166 -0
  132. package/types/ChargesResource.d.ts +1406 -0
  133. package/types/Checkout/Sessions.d.ts +314 -1
  134. package/types/Checkout/SessionsResource.d.ts +340 -1
  135. package/types/ConfirmationTokens.d.ts +125 -0
  136. package/types/Coupons.d.ts +33 -0
  137. package/types/CouponsResource.d.ts +21 -0
  138. package/types/CreditNoteLineItems.d.ts +17 -0
  139. package/types/CreditNotes.d.ts +5 -0
  140. package/types/CreditNotesResource.d.ts +5 -0
  141. package/types/CustomerBalanceTransactions.d.ts +2 -0
  142. package/types/CustomerCashBalanceTransactions.d.ts +2 -0
  143. package/types/CustomerSessions.d.ts +5 -0
  144. package/types/CustomerSessionsResource.d.ts +6 -1
  145. package/types/Customers.d.ts +2 -0
  146. package/types/CustomersResource.d.ts +8 -0
  147. package/types/Discounts.d.ts +10 -0
  148. package/types/Errors.d.ts +69 -2
  149. package/types/EventTypes.d.ts +681 -0
  150. package/types/Events.d.ts +98 -0
  151. package/types/ExternalAccountsResource.d.ts +304 -0
  152. package/types/FinancialConnections/AccountInferredBalances.d.ts +38 -0
  153. package/types/FinancialConnections/Accounts.d.ts +36 -1
  154. package/types/FinancialConnections/AccountsResource.d.ts +40 -3
  155. package/types/FinancialConnections/Institutions.d.ts +98 -0
  156. package/types/FinancialConnections/InstitutionsResource.d.ts +47 -0
  157. package/types/FinancialConnections/Sessions.d.ts +51 -1
  158. package/types/FinancialConnections/SessionsResource.d.ts +43 -1
  159. package/types/FxQuotes.d.ts +153 -0
  160. package/types/FxQuotesResource.d.ts +130 -0
  161. package/types/Identity/VerificationSessions.d.ts +5 -0
  162. package/types/Identity/VerificationSessionsResource.d.ts +7 -0
  163. package/types/InvoiceItems.d.ts +10 -0
  164. package/types/InvoiceItemsResource.d.ts +117 -6
  165. package/types/InvoiceLineItems.d.ts +45 -1
  166. package/types/InvoicePayments.d.ts +5 -0
  167. package/types/Invoices.d.ts +133 -3
  168. package/types/InvoicesResource.d.ts +1458 -13
  169. package/types/Issuing/CardholdersResource.d.ts +2 -1
  170. package/types/Issuing/CreditUnderwritingRecords.d.ts +451 -0
  171. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +1032 -0
  172. package/types/Issuing/DisputeSettlementDetails.d.ts +85 -0
  173. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +52 -0
  174. package/types/Issuing/FraudLiabilityDebits.d.ts +52 -0
  175. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +52 -0
  176. package/types/Issuing/Settlements.d.ts +113 -0
  177. package/types/Issuing/Transactions.d.ts +5 -0
  178. package/types/Issuing/TransactionsResource.d.ts +5 -0
  179. package/types/LineItems.d.ts +49 -0
  180. package/types/Mandates.d.ts +77 -0
  181. package/types/Margins.d.ts +56 -0
  182. package/types/MarginsResource.d.ts +114 -0
  183. package/types/Orders.d.ts +1159 -0
  184. package/types/OrdersResource.d.ts +2967 -0
  185. package/types/PaymentAttemptRecords.d.ts +2132 -0
  186. package/types/PaymentAttemptRecordsResource.d.ts +47 -0
  187. package/types/PaymentIntentAmountDetailsLineItems.d.ts +116 -0
  188. package/types/PaymentIntents.d.ts +764 -2
  189. package/types/PaymentIntentsResource.d.ts +8819 -4111
  190. package/types/PaymentLinks.d.ts +6 -0
  191. package/types/PaymentLinksResource.d.ts +12 -0
  192. package/types/PaymentMethodConfigurations.d.ts +180 -0
  193. package/types/PaymentMethodConfigurationsResource.d.ts +250 -0
  194. package/types/PaymentMethods.d.ts +125 -0
  195. package/types/PaymentMethodsResource.d.ts +167 -2
  196. package/types/PaymentRecords.d.ts +2125 -0
  197. package/types/PaymentRecordsResource.d.ts +455 -0
  198. package/types/Payouts.d.ts +5 -0
  199. package/types/PayoutsResource.d.ts +5 -0
  200. package/types/Prices.d.ts +22 -0
  201. package/types/PricesResource.d.ts +22 -0
  202. package/types/Privacy/RedactionJobValidationErrors.d.ts +60 -0
  203. package/types/Privacy/RedactionJobs.d.ts +111 -0
  204. package/types/Privacy/RedactionJobsResource.d.ts +230 -0
  205. package/types/PromotionCodes.d.ts +5 -0
  206. package/types/PromotionCodesResource.d.ts +10 -0
  207. package/types/QuoteLines.d.ts +634 -0
  208. package/types/QuotePreviewInvoices.d.ts +1695 -0
  209. package/types/QuotePreviewSubscriptionSchedules.d.ts +831 -0
  210. package/types/Quotes.d.ts +603 -1
  211. package/types/QuotesResource.d.ts +2572 -218
  212. package/types/Refunds.d.ts +14 -0
  213. package/types/SetupAttempts.d.ts +47 -1
  214. package/types/SetupIntents.d.ts +118 -2
  215. package/types/SetupIntentsResource.d.ts +730 -3
  216. package/types/Sources.d.ts +29 -0
  217. package/types/SubscriptionItems.d.ts +30 -0
  218. package/types/SubscriptionItemsResource.d.ts +109 -0
  219. package/types/SubscriptionSchedules.d.ts +212 -0
  220. package/types/SubscriptionSchedulesResource.d.ts +1240 -5
  221. package/types/Subscriptions.d.ts +116 -1
  222. package/types/SubscriptionsResource.d.ts +424 -10
  223. package/types/Tax/Associations.d.ts +82 -0
  224. package/types/Tax/AssociationsResource.d.ts +29 -0
  225. package/types/Tax/Forms.d.ts +220 -0
  226. package/types/Tax/FormsResource.d.ts +107 -0
  227. package/types/TaxIds.d.ts +10 -0
  228. package/types/TaxIdsResource.d.ts +10 -0
  229. package/types/Terminal/ReaderCollectedData.d.ts +51 -0
  230. package/types/Terminal/ReaderCollectedDataResource.d.ts +29 -0
  231. package/types/Terminal/Readers.d.ts +102 -0
  232. package/types/Terminal/ReadersResource.d.ts +96 -0
  233. package/types/TestHelpers/ConfirmationTokensResource.d.ts +126 -0
  234. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +26 -0
  235. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +26 -0
  236. package/types/Transfers.d.ts +5 -0
  237. package/types/TransfersResource.d.ts +5 -0
  238. package/types/Treasury/FinancialAccountFeatures.d.ts +7 -0
  239. package/types/Treasury/FinancialAccounts.d.ts +5 -0
  240. package/types/Treasury/FinancialAccountsResource.d.ts +37 -0
  241. package/types/Treasury/OutboundTransfers.d.ts +26 -0
  242. package/types/Treasury/OutboundTransfersResource.d.ts +26 -0
  243. package/types/Treasury/ReceivedCredits.d.ts +26 -0
  244. package/types/Treasury/ReceivedDebits.d.ts +31 -0
  245. package/types/V2/Core/AccountLinks.d.ts +106 -0
  246. package/types/V2/Core/AccountLinksResource.d.ts +90 -0
  247. package/types/V2/Core/Accounts/PersonsResource.d.ts +3770 -0
  248. package/types/V2/Core/Accounts.d.ts +8169 -0
  249. package/types/V2/Core/AccountsResource.d.ts +10203 -0
  250. package/types/V2/Core/Persons.d.ts +1867 -0
  251. package/types/V2/Core/Vault/GbBankAccounts.d.ts +160 -0
  252. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +172 -0
  253. package/types/V2/Core/Vault/UsBankAccounts.d.ts +70 -0
  254. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +123 -0
  255. package/types/V2/EventTypes.d.ts +907 -5
  256. package/types/V2/FinancialAddressCreditSimulations.d.ts +27 -0
  257. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +32 -0
  258. package/types/V2/MoneyManagement/Adjustments.d.ts +110 -0
  259. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +83 -0
  260. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +546 -0
  261. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +52 -0
  262. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +314 -0
  263. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +288 -0
  264. package/types/V2/MoneyManagement/InboundTransfers.d.ts +206 -0
  265. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +144 -0
  266. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +168 -0
  267. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +115 -0
  268. package/types/V2/MoneyManagement/OutboundPayments.d.ts +278 -0
  269. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +242 -0
  270. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +97 -0
  271. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +296 -0
  272. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +251 -0
  273. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +207 -0
  274. package/types/V2/MoneyManagement/PayoutMethods.d.ts +151 -0
  275. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +41 -0
  276. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +87 -0
  277. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +113 -0
  278. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +243 -0
  279. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +78 -0
  280. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +176 -0
  281. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +48 -0
  282. package/types/V2/MoneyManagement/TransactionEntries.d.ts +155 -0
  283. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +82 -0
  284. package/types/V2/MoneyManagement/Transactions.d.ts +170 -0
  285. package/types/V2/MoneyManagement/TransactionsResource.d.ts +83 -0
  286. package/types/V2/Payments/OffSessionPayments.d.ts +162 -0
  287. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +159 -0
  288. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +66 -0
  289. package/types/WebhookEndpointsResource.d.ts +80 -0
  290. package/types/index.d.ts +141 -5
  291. package/types/lib.d.ts +11 -1
  292. package/types/test/typescriptTest.ts +3 -3
  293. package/types/InvoicePaymentsResource.d.ts +0 -74
@@ -0,0 +1,2132 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ /**
6
+ * A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe.
7
+ * Each payment attempt tries to collect a fixed amount of money from a fixed customer and payment
8
+ * method. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record
9
+ * can have guaranteed funds.
10
+ */
11
+ interface PaymentAttemptRecord {
12
+ /**
13
+ * Unique identifier for the object.
14
+ */
15
+ id: string;
16
+
17
+ /**
18
+ * String representing the object's type. Objects of the same type share the same value.
19
+ */
20
+ object: 'payment_attempt_record';
21
+
22
+ /**
23
+ * A representation of an amount of money, consisting of an amount and a currency.
24
+ */
25
+ amount_canceled: PaymentAttemptRecord.AmountCanceled;
26
+
27
+ /**
28
+ * A representation of an amount of money, consisting of an amount and a currency.
29
+ */
30
+ amount_failed: PaymentAttemptRecord.AmountFailed;
31
+
32
+ /**
33
+ * A representation of an amount of money, consisting of an amount and a currency.
34
+ */
35
+ amount_guaranteed: PaymentAttemptRecord.AmountGuaranteed;
36
+
37
+ /**
38
+ * A representation of an amount of money, consisting of an amount and a currency.
39
+ */
40
+ amount_requested: PaymentAttemptRecord.AmountRequested;
41
+
42
+ /**
43
+ * Time at which the object was created. Measured in seconds since the Unix epoch.
44
+ */
45
+ created: number;
46
+
47
+ /**
48
+ * Customer information for this payment.
49
+ */
50
+ customer_details: PaymentAttemptRecord.CustomerDetails | null;
51
+
52
+ /**
53
+ * Indicates whether the customer was present in your checkout flow during this payment.
54
+ */
55
+ customer_presence: PaymentAttemptRecord.CustomerPresence | null;
56
+
57
+ /**
58
+ * An arbitrary string attached to the object. Often useful for displaying to users.
59
+ */
60
+ description: string | null;
61
+
62
+ /**
63
+ * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
64
+ */
65
+ livemode: boolean;
66
+
67
+ /**
68
+ * 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.
69
+ */
70
+ metadata: Stripe.Metadata;
71
+
72
+ /**
73
+ * Information about the Payment Method debited for this payment.
74
+ */
75
+ payment_method_details: PaymentAttemptRecord.PaymentMethodDetails | null;
76
+
77
+ /**
78
+ * ID of the Payment Record this Payment Attempt Record belongs to.
79
+ */
80
+ payment_record: string | null;
81
+
82
+ /**
83
+ * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
84
+ */
85
+ payment_reference: string | null;
86
+
87
+ /**
88
+ * Indicates who reported the payment.
89
+ */
90
+ reported_by: PaymentAttemptRecord.ReportedBy;
91
+
92
+ /**
93
+ * Shipping information for this payment.
94
+ */
95
+ shipping_details: PaymentAttemptRecord.ShippingDetails | null;
96
+ }
97
+
98
+ namespace PaymentAttemptRecord {
99
+ interface AmountCanceled {
100
+ /**
101
+ * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
102
+ */
103
+ currency: string;
104
+
105
+ /**
106
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
107
+ */
108
+ value: number;
109
+ }
110
+
111
+ interface AmountFailed {
112
+ /**
113
+ * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
114
+ */
115
+ currency: string;
116
+
117
+ /**
118
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
119
+ */
120
+ value: number;
121
+ }
122
+
123
+ interface AmountGuaranteed {
124
+ /**
125
+ * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
126
+ */
127
+ currency: string;
128
+
129
+ /**
130
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
131
+ */
132
+ value: number;
133
+ }
134
+
135
+ interface AmountRequested {
136
+ /**
137
+ * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
138
+ */
139
+ currency: string;
140
+
141
+ /**
142
+ * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
143
+ */
144
+ value: number;
145
+ }
146
+
147
+ interface CustomerDetails {
148
+ /**
149
+ * ID of the Stripe Customer associated with this payment.
150
+ */
151
+ customer: string | null;
152
+
153
+ /**
154
+ * The customer's email address.
155
+ */
156
+ email: string | null;
157
+
158
+ /**
159
+ * The customer's name.
160
+ */
161
+ name: string | null;
162
+
163
+ /**
164
+ * The customer's phone number.
165
+ */
166
+ phone: string | null;
167
+ }
168
+
169
+ type CustomerPresence = 'off_session' | 'on_session';
170
+
171
+ interface PaymentMethodDetails {
172
+ ach_credit_transfer?: PaymentMethodDetails.AchCreditTransfer;
173
+
174
+ ach_debit?: PaymentMethodDetails.AchDebit;
175
+
176
+ acss_debit?: PaymentMethodDetails.AcssDebit;
177
+
178
+ affirm?: PaymentMethodDetails.Affirm;
179
+
180
+ afterpay_clearpay?: PaymentMethodDetails.AfterpayClearpay;
181
+
182
+ alipay?: PaymentMethodDetails.Alipay;
183
+
184
+ alma?: PaymentMethodDetails.Alma;
185
+
186
+ amazon_pay?: PaymentMethodDetails.AmazonPay;
187
+
188
+ au_becs_debit?: PaymentMethodDetails.AuBecsDebit;
189
+
190
+ bacs_debit?: PaymentMethodDetails.BacsDebit;
191
+
192
+ bancontact?: PaymentMethodDetails.Bancontact;
193
+
194
+ billie?: PaymentMethodDetails.Billie;
195
+
196
+ /**
197
+ * The billing details associated with the method of payment.
198
+ */
199
+ billing_details: PaymentMethodDetails.BillingDetails | null;
200
+
201
+ blik?: PaymentMethodDetails.Blik;
202
+
203
+ boleto?: PaymentMethodDetails.Boleto;
204
+
205
+ /**
206
+ * Details of the card used for this payment attempt.
207
+ */
208
+ card?: PaymentMethodDetails.Card;
209
+
210
+ card_present?: PaymentMethodDetails.CardPresent;
211
+
212
+ cashapp?: PaymentMethodDetails.Cashapp;
213
+
214
+ /**
215
+ * Custom Payment Methods represent Payment Method types not modeled directly in
216
+ * the Stripe API. This resource consists of details about the custom payment method
217
+ * used for this payment attempt.
218
+ */
219
+ custom?: PaymentMethodDetails.Custom;
220
+
221
+ customer_balance?: PaymentMethodDetails.CustomerBalance;
222
+
223
+ eps?: PaymentMethodDetails.Eps;
224
+
225
+ fpx?: PaymentMethodDetails.Fpx;
226
+
227
+ giropay?: PaymentMethodDetails.Giropay;
228
+
229
+ gopay?: PaymentMethodDetails.Gopay;
230
+
231
+ grabpay?: PaymentMethodDetails.Grabpay;
232
+
233
+ id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
234
+
235
+ ideal?: PaymentMethodDetails.Ideal;
236
+
237
+ interac_present?: PaymentMethodDetails.InteracPresent;
238
+
239
+ kakao_pay?: PaymentMethodDetails.KakaoPay;
240
+
241
+ klarna?: PaymentMethodDetails.Klarna;
242
+
243
+ konbini?: PaymentMethodDetails.Konbini;
244
+
245
+ kr_card?: PaymentMethodDetails.KrCard;
246
+
247
+ link?: PaymentMethodDetails.Link;
248
+
249
+ mb_way?: PaymentMethodDetails.MbWay;
250
+
251
+ mobilepay?: PaymentMethodDetails.Mobilepay;
252
+
253
+ multibanco?: PaymentMethodDetails.Multibanco;
254
+
255
+ naver_pay?: PaymentMethodDetails.NaverPay;
256
+
257
+ nz_bank_account?: PaymentMethodDetails.NzBankAccount;
258
+
259
+ oxxo?: PaymentMethodDetails.Oxxo;
260
+
261
+ p24?: PaymentMethodDetails.P24;
262
+
263
+ pay_by_bank?: PaymentMethodDetails.PayByBank;
264
+
265
+ payco?: PaymentMethodDetails.Payco;
266
+
267
+ /**
268
+ * ID of the Stripe PaymentMethod used to make this payment.
269
+ */
270
+ payment_method: string | null;
271
+
272
+ paynow?: PaymentMethodDetails.Paynow;
273
+
274
+ paypal?: PaymentMethodDetails.Paypal;
275
+
276
+ payto?: PaymentMethodDetails.Payto;
277
+
278
+ pix?: PaymentMethodDetails.Pix;
279
+
280
+ promptpay?: PaymentMethodDetails.Promptpay;
281
+
282
+ qris?: PaymentMethodDetails.Qris;
283
+
284
+ rechnung?: PaymentMethodDetails.Rechnung;
285
+
286
+ revolut_pay?: PaymentMethodDetails.RevolutPay;
287
+
288
+ samsung_pay?: PaymentMethodDetails.SamsungPay;
289
+
290
+ satispay?: PaymentMethodDetails.Satispay;
291
+
292
+ sepa_credit_transfer?: PaymentMethodDetails.SepaCreditTransfer;
293
+
294
+ sepa_debit?: PaymentMethodDetails.SepaDebit;
295
+
296
+ shopeepay?: PaymentMethodDetails.Shopeepay;
297
+
298
+ sofort?: PaymentMethodDetails.Sofort;
299
+
300
+ stripe_account?: PaymentMethodDetails.StripeAccount;
301
+
302
+ stripe_balance?: PaymentMethodDetails.StripeBalance;
303
+
304
+ swish?: PaymentMethodDetails.Swish;
305
+
306
+ twint?: PaymentMethodDetails.Twint;
307
+
308
+ /**
309
+ * The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
310
+ * An additional hash is included on `payment_method_details` with a name matching this value.
311
+ * It contains information specific to the payment method.
312
+ */
313
+ type: string;
314
+
315
+ us_bank_account?: PaymentMethodDetails.UsBankAccount;
316
+
317
+ wechat?: PaymentMethodDetails.Wechat;
318
+
319
+ wechat_pay?: PaymentMethodDetails.WechatPay;
320
+
321
+ zip?: PaymentMethodDetails.Zip;
322
+ }
323
+
324
+ namespace PaymentMethodDetails {
325
+ interface AchCreditTransfer {
326
+ /**
327
+ * Account number to transfer funds to.
328
+ */
329
+ account_number: string | null;
330
+
331
+ /**
332
+ * Name of the bank associated with the routing number.
333
+ */
334
+ bank_name: string | null;
335
+
336
+ /**
337
+ * Routing transit number for the bank account to transfer funds to.
338
+ */
339
+ routing_number: string | null;
340
+
341
+ /**
342
+ * SWIFT code of the bank associated with the routing number.
343
+ */
344
+ swift_code: string | null;
345
+ }
346
+
347
+ interface AchDebit {
348
+ /**
349
+ * Type of entity that holds the account. This can be either `individual` or `company`.
350
+ */
351
+ account_holder_type: AchDebit.AccountHolderType | null;
352
+
353
+ /**
354
+ * Name of the bank associated with the bank account.
355
+ */
356
+ bank_name: string | null;
357
+
358
+ /**
359
+ * Two-letter ISO code representing the country the bank account is located in.
360
+ */
361
+ country: string | null;
362
+
363
+ /**
364
+ * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
365
+ */
366
+ fingerprint: string | null;
367
+
368
+ /**
369
+ * Last four digits of the bank account number.
370
+ */
371
+ last4: string | null;
372
+
373
+ /**
374
+ * Routing transit number of the bank account.
375
+ */
376
+ routing_number: string | null;
377
+ }
378
+
379
+ namespace AchDebit {
380
+ type AccountHolderType = 'company' | 'individual';
381
+ }
382
+
383
+ interface AcssDebit {
384
+ /**
385
+ * Name of the bank associated with the bank account.
386
+ */
387
+ bank_name: string | null;
388
+
389
+ /**
390
+ * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
391
+ */
392
+ fingerprint: string | null;
393
+
394
+ /**
395
+ * Institution number of the bank account
396
+ */
397
+ institution_number: string | null;
398
+
399
+ /**
400
+ * Last four digits of the bank account number.
401
+ */
402
+ last4: string | null;
403
+
404
+ /**
405
+ * ID of the mandate used to make this payment.
406
+ */
407
+ mandate?: string;
408
+
409
+ /**
410
+ * Transit number of the bank account.
411
+ */
412
+ transit_number: string | null;
413
+ }
414
+
415
+ interface Affirm {
416
+ /**
417
+ * ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
418
+ */
419
+ location?: string;
420
+
421
+ /**
422
+ * ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
423
+ */
424
+ reader?: string;
425
+
426
+ /**
427
+ * The Affirm transaction ID associated with this payment.
428
+ */
429
+ transaction_id: string | null;
430
+ }
431
+
432
+ interface AfterpayClearpay {
433
+ /**
434
+ * The Afterpay order ID associated with this payment intent.
435
+ */
436
+ order_id: string | null;
437
+
438
+ /**
439
+ * Order identifier shown to the merchant in Afterpay's online portal.
440
+ */
441
+ reference: string | null;
442
+ }
443
+
444
+ interface Alipay {
445
+ /**
446
+ * Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
447
+ */
448
+ buyer_id?: string;
449
+
450
+ /**
451
+ * Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
452
+ */
453
+ fingerprint: string | null;
454
+
455
+ /**
456
+ * Transaction ID of this particular Alipay transaction.
457
+ */
458
+ transaction_id: string | null;
459
+ }
460
+
461
+ interface Alma {}
462
+
463
+ interface AmazonPay {
464
+ funding?: AmazonPay.Funding;
465
+ }
466
+
467
+ namespace AmazonPay {
468
+ interface Funding {
469
+ card?: Funding.Card;
470
+
471
+ /**
472
+ * funding type of the underlying payment method.
473
+ */
474
+ type: 'card' | null;
475
+ }
476
+
477
+ namespace Funding {
478
+ interface Card {
479
+ /**
480
+ * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
481
+ */
482
+ brand: string | null;
483
+
484
+ /**
485
+ * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
486
+ */
487
+ brand_product?: string | null;
488
+
489
+ /**
490
+ * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
491
+ */
492
+ country: string | null;
493
+
494
+ /**
495
+ * Two-digit number representing the card's expiration month.
496
+ */
497
+ exp_month: number | null;
498
+
499
+ /**
500
+ * Four-digit number representing the card's expiration year.
501
+ */
502
+ exp_year: number | null;
503
+
504
+ /**
505
+ * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
506
+ */
507
+ funding: string | null;
508
+
509
+ /**
510
+ * The last four digits of the card.
511
+ */
512
+ last4: string | null;
513
+ }
514
+ }
515
+ }
516
+
517
+ interface AuBecsDebit {
518
+ /**
519
+ * Bank-State-Branch number of the bank account.
520
+ */
521
+ bsb_number: string | null;
522
+
523
+ /**
524
+ * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
525
+ */
526
+ fingerprint: string | null;
527
+
528
+ /**
529
+ * Last four digits of the bank account number.
530
+ */
531
+ last4: string | null;
532
+
533
+ /**
534
+ * ID of the mandate used to make this payment.
535
+ */
536
+ mandate?: string;
537
+ }
538
+
539
+ interface BacsDebit {
540
+ /**
541
+ * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
542
+ */
543
+ fingerprint: string | null;
544
+
545
+ /**
546
+ * Last four digits of the bank account number.
547
+ */
548
+ last4: string | null;
549
+
550
+ /**
551
+ * ID of the mandate used to make this payment.
552
+ */
553
+ mandate: string | null;
554
+
555
+ /**
556
+ * Sort code of the bank account. (e.g., `10-20-30`)
557
+ */
558
+ sort_code: string | null;
559
+ }
560
+
561
+ interface Bancontact {
562
+ /**
563
+ * Bank code of bank associated with the bank account.
564
+ */
565
+ bank_code: string | null;
566
+
567
+ /**
568
+ * Name of the bank associated with the bank account.
569
+ */
570
+ bank_name: string | null;
571
+
572
+ /**
573
+ * Bank Identifier Code of the bank associated with the bank account.
574
+ */
575
+ bic: string | null;
576
+
577
+ /**
578
+ * The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
579
+ */
580
+ generated_sepa_debit: string | Stripe.PaymentMethod | null;
581
+
582
+ /**
583
+ * The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
584
+ */
585
+ generated_sepa_debit_mandate: string | Stripe.Mandate | null;
586
+
587
+ /**
588
+ * Last four characters of the IBAN.
589
+ */
590
+ iban_last4: string | null;
591
+
592
+ /**
593
+ * Preferred language of the Bancontact authorization page that the customer is redirected to.
594
+ * Can be one of `en`, `de`, `fr`, or `nl`
595
+ */
596
+ preferred_language: Bancontact.PreferredLanguage | null;
597
+
598
+ /**
599
+ * Owner's verified full name. Values are verified or provided by Bancontact directly
600
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
601
+ */
602
+ verified_name: string | null;
603
+ }
604
+
605
+ namespace Bancontact {
606
+ type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
607
+ }
608
+
609
+ interface Billie {}
610
+
611
+ interface BillingDetails {
612
+ /**
613
+ * A representation of a physical address.
614
+ */
615
+ address: Stripe.Address;
616
+
617
+ /**
618
+ * The billing email associated with the method of payment.
619
+ */
620
+ email: string | null;
621
+
622
+ /**
623
+ * The billing name associated with the method of payment.
624
+ */
625
+ name: string | null;
626
+
627
+ /**
628
+ * The billing phone number associated with the method of payment.
629
+ */
630
+ phone: string | null;
631
+ }
632
+
633
+ interface Blik {
634
+ /**
635
+ * A unique and immutable identifier assigned by BLIK to every buyer.
636
+ */
637
+ buyer_id: string | null;
638
+ }
639
+
640
+ interface Boleto {
641
+ /**
642
+ * The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
643
+ */
644
+ tax_id: string;
645
+ }
646
+
647
+ interface Card {
648
+ /**
649
+ * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
650
+ */
651
+ brand: Card.Brand;
652
+
653
+ /**
654
+ * When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
655
+ */
656
+ capture_before?: number;
657
+
658
+ /**
659
+ * Check results by Card networks on Card address and CVC at time of payment.
660
+ */
661
+ checks: Card.Checks | null;
662
+
663
+ /**
664
+ * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
665
+ */
666
+ country: string | null;
667
+
668
+ /**
669
+ * Two-digit number representing the card's expiration month.
670
+ */
671
+ exp_month: number;
672
+
673
+ /**
674
+ * Four-digit number representing the card's expiration year.
675
+ */
676
+ exp_year: number;
677
+
678
+ /**
679
+ * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
680
+ *
681
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
682
+ */
683
+ fingerprint?: string | null;
684
+
685
+ /**
686
+ * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
687
+ */
688
+ funding: Card.Funding;
689
+
690
+ /**
691
+ * The last four digits of the card.
692
+ */
693
+ last4: string;
694
+
695
+ /**
696
+ * True if this payment was marked as MOTO and out of scope for SCA.
697
+ */
698
+ moto?: boolean;
699
+
700
+ /**
701
+ * Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
702
+ */
703
+ network: Card.Network | null;
704
+
705
+ /**
706
+ * If this card has network token credentials, this contains the details of the network token credentials.
707
+ */
708
+ network_token?: Card.NetworkToken | null;
709
+
710
+ /**
711
+ * This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
712
+ */
713
+ network_transaction_id: string | null;
714
+
715
+ /**
716
+ * Populated if this transaction used 3D Secure authentication.
717
+ */
718
+ three_d_secure: Card.ThreeDSecure | null;
719
+ }
720
+
721
+ namespace Card {
722
+ type Brand =
723
+ | 'amex'
724
+ | 'cartes_bancaires'
725
+ | 'diners'
726
+ | 'discover'
727
+ | 'eftpos_au'
728
+ | 'interac'
729
+ | 'jcb'
730
+ | 'link'
731
+ | 'mastercard'
732
+ | 'unionpay'
733
+ | 'unknown'
734
+ | 'visa';
735
+
736
+ interface Checks {
737
+ address_line1_check: Checks.AddressLine1Check | null;
738
+
739
+ address_postal_code_check: Checks.AddressPostalCodeCheck | null;
740
+
741
+ cvc_check: Checks.CvcCheck | null;
742
+ }
743
+
744
+ namespace Checks {
745
+ type AddressLine1Check =
746
+ | 'fail'
747
+ | 'pass'
748
+ | 'unavailable'
749
+ | 'unchecked';
750
+
751
+ type AddressPostalCodeCheck =
752
+ | 'fail'
753
+ | 'pass'
754
+ | 'unavailable'
755
+ | 'unchecked';
756
+
757
+ type CvcCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked';
758
+ }
759
+
760
+ type Funding = 'credit' | 'debit' | 'prepaid' | 'unknown';
761
+
762
+ type Network =
763
+ | 'amex'
764
+ | 'cartes_bancaires'
765
+ | 'diners'
766
+ | 'discover'
767
+ | 'eftpos_au'
768
+ | 'interac'
769
+ | 'jcb'
770
+ | 'link'
771
+ | 'mastercard'
772
+ | 'unionpay'
773
+ | 'unknown'
774
+ | 'visa';
775
+
776
+ interface NetworkToken {
777
+ used: boolean;
778
+ }
779
+
780
+ interface ThreeDSecure {
781
+ authentication_flow: ThreeDSecure.AuthenticationFlow | null;
782
+
783
+ result: ThreeDSecure.Result | null;
784
+
785
+ result_reason: ThreeDSecure.ResultReason | null;
786
+
787
+ version: ThreeDSecure.Version | null;
788
+ }
789
+
790
+ namespace ThreeDSecure {
791
+ type AuthenticationFlow = 'challenge' | 'frictionless';
792
+
793
+ type Result =
794
+ | 'attempt_acknowledged'
795
+ | 'authenticated'
796
+ | 'exempted'
797
+ | 'failed'
798
+ | 'not_supported'
799
+ | 'processing_error';
800
+
801
+ type ResultReason =
802
+ | 'abandoned'
803
+ | 'bypassed'
804
+ | 'canceled'
805
+ | 'card_not_enrolled'
806
+ | 'network_not_supported'
807
+ | 'protocol_error'
808
+ | 'rejected';
809
+
810
+ type Version = '1.0.2' | '2.1.0' | '2.2.0';
811
+ }
812
+ }
813
+
814
+ interface CardPresent {
815
+ /**
816
+ * The authorized amount
817
+ */
818
+ amount_authorized: number | null;
819
+
820
+ /**
821
+ * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
822
+ */
823
+ brand: string | null;
824
+
825
+ /**
826
+ * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
827
+ */
828
+ brand_product: string | null;
829
+
830
+ /**
831
+ * When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
832
+ */
833
+ capture_before?: number;
834
+
835
+ /**
836
+ * The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
837
+ */
838
+ cardholder_name: string | null;
839
+
840
+ /**
841
+ * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
842
+ */
843
+ country: string | null;
844
+
845
+ /**
846
+ * A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
847
+ */
848
+ description?: string | null;
849
+
850
+ /**
851
+ * Authorization response cryptogram.
852
+ */
853
+ emv_auth_data: string | null;
854
+
855
+ /**
856
+ * Two-digit number representing the card's expiration month.
857
+ */
858
+ exp_month: number;
859
+
860
+ /**
861
+ * Four-digit number representing the card's expiration year.
862
+ */
863
+ exp_year: number;
864
+
865
+ /**
866
+ * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
867
+ *
868
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
869
+ */
870
+ fingerprint: string | null;
871
+
872
+ /**
873
+ * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
874
+ */
875
+ funding: string | null;
876
+
877
+ /**
878
+ * ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
879
+ */
880
+ generated_card: string | null;
881
+
882
+ /**
883
+ * Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
884
+ */
885
+ iin?: string | null;
886
+
887
+ /**
888
+ * Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
889
+ */
890
+ incremental_authorization_supported: boolean;
891
+
892
+ /**
893
+ * The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
894
+ */
895
+ issuer?: string | null;
896
+
897
+ /**
898
+ * The last four digits of the card.
899
+ */
900
+ last4: string | null;
901
+
902
+ /**
903
+ * Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
904
+ */
905
+ network: string | null;
906
+
907
+ /**
908
+ * This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
909
+ */
910
+ network_transaction_id: string | null;
911
+
912
+ /**
913
+ * Details about payments collected offline.
914
+ */
915
+ offline: CardPresent.Offline | null;
916
+
917
+ /**
918
+ * Defines whether the authorized amount can be over-captured or not
919
+ */
920
+ overcapture_supported: boolean;
921
+
922
+ /**
923
+ * EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
924
+ */
925
+ preferred_locales: Array<string> | null;
926
+
927
+ /**
928
+ * How card details were read in this transaction.
929
+ */
930
+ read_method: CardPresent.ReadMethod | null;
931
+
932
+ /**
933
+ * A collection of fields required to be displayed on receipts. Only required for EMV transactions.
934
+ */
935
+ receipt: CardPresent.Receipt | null;
936
+
937
+ wallet?: CardPresent.Wallet;
938
+ }
939
+
940
+ namespace CardPresent {
941
+ interface Offline {
942
+ /**
943
+ * Time at which the payment was collected while offline
944
+ */
945
+ stored_at: number | null;
946
+
947
+ /**
948
+ * The method used to process this payment method offline. Only deferred is allowed.
949
+ */
950
+ type: 'deferred' | null;
951
+ }
952
+
953
+ type ReadMethod =
954
+ | 'contact_emv'
955
+ | 'contactless_emv'
956
+ | 'contactless_magstripe_mode'
957
+ | 'magnetic_stripe_fallback'
958
+ | 'magnetic_stripe_track2';
959
+
960
+ interface Receipt {
961
+ /**
962
+ * The type of account being debited or credited
963
+ */
964
+ account_type?: Receipt.AccountType;
965
+
966
+ /**
967
+ * EMV tag 9F26, cryptogram generated by the integrated circuit chip.
968
+ */
969
+ application_cryptogram: string | null;
970
+
971
+ /**
972
+ * Mnenomic of the Application Identifier.
973
+ */
974
+ application_preferred_name: string | null;
975
+
976
+ /**
977
+ * Identifier for this transaction.
978
+ */
979
+ authorization_code: string | null;
980
+
981
+ /**
982
+ * EMV tag 8A. A code returned by the card issuer.
983
+ */
984
+ authorization_response_code: string | null;
985
+
986
+ /**
987
+ * Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
988
+ */
989
+ cardholder_verification_method: string | null;
990
+
991
+ /**
992
+ * EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
993
+ */
994
+ dedicated_file_name: string | null;
995
+
996
+ /**
997
+ * The outcome of a series of EMV functions performed by the card reader.
998
+ */
999
+ terminal_verification_results: string | null;
1000
+
1001
+ /**
1002
+ * An indication of various EMV functions performed during the transaction.
1003
+ */
1004
+ transaction_status_information: string | null;
1005
+ }
1006
+
1007
+ namespace Receipt {
1008
+ type AccountType = 'checking' | 'credit' | 'prepaid' | 'unknown';
1009
+ }
1010
+
1011
+ interface Wallet {
1012
+ /**
1013
+ * The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
1014
+ */
1015
+ type: Wallet.Type;
1016
+ }
1017
+
1018
+ namespace Wallet {
1019
+ type Type = 'apple_pay' | 'google_pay' | 'samsung_pay' | 'unknown';
1020
+ }
1021
+ }
1022
+
1023
+ interface Cashapp {
1024
+ /**
1025
+ * A unique and immutable identifier assigned by Cash App to every buyer.
1026
+ */
1027
+ buyer_id: string | null;
1028
+
1029
+ /**
1030
+ * A public identifier for buyers using Cash App.
1031
+ */
1032
+ cashtag: string | null;
1033
+ }
1034
+
1035
+ interface Custom {
1036
+ /**
1037
+ * Display name for the custom (user-defined) payment method type used to make this payment.
1038
+ */
1039
+ display_name: string;
1040
+
1041
+ /**
1042
+ * The custom payment method type associated with this payment.
1043
+ */
1044
+ type: string | null;
1045
+ }
1046
+
1047
+ interface CustomerBalance {}
1048
+
1049
+ interface Eps {
1050
+ /**
1051
+ * The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.
1052
+ */
1053
+ bank: Eps.Bank | null;
1054
+
1055
+ /**
1056
+ * Owner's verified full name. Values are verified or provided by EPS directly
1057
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1058
+ * EPS rarely provides this information so the attribute is usually empty.
1059
+ */
1060
+ verified_name: string | null;
1061
+ }
1062
+
1063
+ namespace Eps {
1064
+ type Bank =
1065
+ | 'arzte_und_apotheker_bank'
1066
+ | 'austrian_anadi_bank_ag'
1067
+ | 'bank_austria'
1068
+ | 'bankhaus_carl_spangler'
1069
+ | 'bankhaus_schelhammer_und_schattera_ag'
1070
+ | 'bawag_psk_ag'
1071
+ | 'bks_bank_ag'
1072
+ | 'brull_kallmus_bank_ag'
1073
+ | 'btv_vier_lander_bank'
1074
+ | 'capital_bank_grawe_gruppe_ag'
1075
+ | 'deutsche_bank_ag'
1076
+ | 'dolomitenbank'
1077
+ | 'easybank_ag'
1078
+ | 'erste_bank_und_sparkassen'
1079
+ | 'hypo_alpeadriabank_international_ag'
1080
+ | 'hypo_bank_burgenland_aktiengesellschaft'
1081
+ | 'hypo_noe_lb_fur_niederosterreich_u_wien'
1082
+ | 'hypo_oberosterreich_salzburg_steiermark'
1083
+ | 'hypo_tirol_bank_ag'
1084
+ | 'hypo_vorarlberg_bank_ag'
1085
+ | 'marchfelder_bank'
1086
+ | 'oberbank_ag'
1087
+ | 'raiffeisen_bankengruppe_osterreich'
1088
+ | 'schoellerbank_ag'
1089
+ | 'sparda_bank_wien'
1090
+ | 'volksbank_gruppe'
1091
+ | 'volkskreditbank_ag'
1092
+ | 'vr_bank_braunau';
1093
+ }
1094
+
1095
+ interface Fpx {
1096
+ /**
1097
+ * Account holder type, if provided. Can be one of `individual` or `company`.
1098
+ */
1099
+ account_holder_type: Fpx.AccountHolderType | null;
1100
+
1101
+ /**
1102
+ * The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
1103
+ */
1104
+ bank: Fpx.Bank;
1105
+
1106
+ /**
1107
+ * Unique transaction id generated by FPX for every request from the merchant
1108
+ */
1109
+ transaction_id: string | null;
1110
+ }
1111
+
1112
+ namespace Fpx {
1113
+ type AccountHolderType = 'company' | 'individual';
1114
+
1115
+ type Bank =
1116
+ | 'affin_bank'
1117
+ | 'agrobank'
1118
+ | 'alliance_bank'
1119
+ | 'ambank'
1120
+ | 'bank_islam'
1121
+ | 'bank_muamalat'
1122
+ | 'bank_of_china'
1123
+ | 'bank_rakyat'
1124
+ | 'bsn'
1125
+ | 'cimb'
1126
+ | 'deutsche_bank'
1127
+ | 'hong_leong_bank'
1128
+ | 'hsbc'
1129
+ | 'kfh'
1130
+ | 'maybank2e'
1131
+ | 'maybank2u'
1132
+ | 'ocbc'
1133
+ | 'pb_enterprise'
1134
+ | 'public_bank'
1135
+ | 'rhb'
1136
+ | 'standard_chartered'
1137
+ | 'uob';
1138
+ }
1139
+
1140
+ interface Giropay {
1141
+ /**
1142
+ * Bank code of bank associated with the bank account.
1143
+ */
1144
+ bank_code: string | null;
1145
+
1146
+ /**
1147
+ * Name of the bank associated with the bank account.
1148
+ */
1149
+ bank_name: string | null;
1150
+
1151
+ /**
1152
+ * Bank Identifier Code of the bank associated with the bank account.
1153
+ */
1154
+ bic: string | null;
1155
+
1156
+ /**
1157
+ * Owner's verified full name. Values are verified or provided by Giropay directly
1158
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1159
+ * Giropay rarely provides this information so the attribute is usually empty.
1160
+ */
1161
+ verified_name: string | null;
1162
+ }
1163
+
1164
+ interface Gopay {}
1165
+
1166
+ interface Grabpay {
1167
+ /**
1168
+ * Unique transaction id generated by GrabPay
1169
+ */
1170
+ transaction_id: string | null;
1171
+ }
1172
+
1173
+ interface IdBankTransfer {
1174
+ /**
1175
+ * Account number of the bank account to transfer funds to.
1176
+ */
1177
+ account_number: string;
1178
+
1179
+ /**
1180
+ * Bank where the account is located.
1181
+ */
1182
+ bank: IdBankTransfer.Bank;
1183
+
1184
+ /**
1185
+ * Local bank code of the bank.
1186
+ */
1187
+ bank_code?: string;
1188
+
1189
+ /**
1190
+ * Name of the bank associated with the bank account.
1191
+ */
1192
+ bank_name?: string;
1193
+
1194
+ /**
1195
+ * Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
1196
+ */
1197
+ display_name?: string;
1198
+ }
1199
+
1200
+ namespace IdBankTransfer {
1201
+ type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
1202
+ }
1203
+
1204
+ interface Ideal {
1205
+ /**
1206
+ * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
1207
+ */
1208
+ bank: Ideal.Bank | null;
1209
+
1210
+ /**
1211
+ * The Bank Identifier Code of the customer's bank.
1212
+ */
1213
+ bic: Ideal.Bic | null;
1214
+
1215
+ /**
1216
+ * The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
1217
+ */
1218
+ generated_sepa_debit: string | Stripe.PaymentMethod | null;
1219
+
1220
+ /**
1221
+ * The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
1222
+ */
1223
+ generated_sepa_debit_mandate: string | Stripe.Mandate | null;
1224
+
1225
+ /**
1226
+ * Last four characters of the IBAN.
1227
+ */
1228
+ iban_last4: string | null;
1229
+
1230
+ /**
1231
+ * Owner's verified full name. Values are verified or provided by iDEAL directly
1232
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1233
+ */
1234
+ verified_name: string | null;
1235
+ }
1236
+
1237
+ namespace Ideal {
1238
+ type Bank =
1239
+ | 'abn_amro'
1240
+ | 'asn_bank'
1241
+ | 'bunq'
1242
+ | 'handelsbanken'
1243
+ | 'ing'
1244
+ | 'knab'
1245
+ | 'moneyou'
1246
+ | 'n26'
1247
+ | 'nn'
1248
+ | 'rabobank'
1249
+ | 'regiobank'
1250
+ | 'revolut'
1251
+ | 'sns_bank'
1252
+ | 'triodos_bank'
1253
+ | 'van_lanschot'
1254
+ | 'yoursafe';
1255
+
1256
+ type Bic =
1257
+ | 'ABNANL2A'
1258
+ | 'ASNBNL21'
1259
+ | 'BITSNL2A'
1260
+ | 'BUNQNL2A'
1261
+ | 'FVLBNL22'
1262
+ | 'HANDNL2A'
1263
+ | 'INGBNL2A'
1264
+ | 'KNABNL2H'
1265
+ | 'MOYONL21'
1266
+ | 'NNBANL2G'
1267
+ | 'NTSBDEB1'
1268
+ | 'RABONL2U'
1269
+ | 'RBRBNL21'
1270
+ | 'REVOIE23'
1271
+ | 'REVOLT21'
1272
+ | 'SNSBNL2A'
1273
+ | 'TRIONL2U';
1274
+ }
1275
+
1276
+ interface InteracPresent {
1277
+ /**
1278
+ * Card brand. Can be `interac`, `mastercard` or `visa`.
1279
+ */
1280
+ brand: string | null;
1281
+
1282
+ /**
1283
+ * The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
1284
+ */
1285
+ cardholder_name: string | null;
1286
+
1287
+ /**
1288
+ * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
1289
+ */
1290
+ country: string | null;
1291
+
1292
+ /**
1293
+ * A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
1294
+ */
1295
+ description?: string | null;
1296
+
1297
+ /**
1298
+ * Authorization response cryptogram.
1299
+ */
1300
+ emv_auth_data: string | null;
1301
+
1302
+ /**
1303
+ * Two-digit number representing the card's expiration month.
1304
+ */
1305
+ exp_month: number;
1306
+
1307
+ /**
1308
+ * Four-digit number representing the card's expiration year.
1309
+ */
1310
+ exp_year: number;
1311
+
1312
+ /**
1313
+ * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
1314
+ *
1315
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
1316
+ */
1317
+ fingerprint: string | null;
1318
+
1319
+ /**
1320
+ * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
1321
+ */
1322
+ funding: string | null;
1323
+
1324
+ /**
1325
+ * ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.
1326
+ */
1327
+ generated_card: string | null;
1328
+
1329
+ /**
1330
+ * Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
1331
+ */
1332
+ iin?: string | null;
1333
+
1334
+ /**
1335
+ * The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
1336
+ */
1337
+ issuer?: string | null;
1338
+
1339
+ /**
1340
+ * The last four digits of the card.
1341
+ */
1342
+ last4: string | null;
1343
+
1344
+ /**
1345
+ * Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
1346
+ */
1347
+ network: string | null;
1348
+
1349
+ /**
1350
+ * This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.
1351
+ */
1352
+ network_transaction_id: string | null;
1353
+
1354
+ /**
1355
+ * EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
1356
+ */
1357
+ preferred_locales: Array<string> | null;
1358
+
1359
+ /**
1360
+ * How card details were read in this transaction.
1361
+ */
1362
+ read_method: InteracPresent.ReadMethod | null;
1363
+
1364
+ /**
1365
+ * A collection of fields required to be displayed on receipts. Only required for EMV transactions.
1366
+ */
1367
+ receipt: InteracPresent.Receipt | null;
1368
+ }
1369
+
1370
+ namespace InteracPresent {
1371
+ type ReadMethod =
1372
+ | 'contact_emv'
1373
+ | 'contactless_emv'
1374
+ | 'contactless_magstripe_mode'
1375
+ | 'magnetic_stripe_fallback'
1376
+ | 'magnetic_stripe_track2';
1377
+
1378
+ interface Receipt {
1379
+ /**
1380
+ * The type of account being debited or credited
1381
+ */
1382
+ account_type?: Receipt.AccountType;
1383
+
1384
+ /**
1385
+ * EMV tag 9F26, cryptogram generated by the integrated circuit chip.
1386
+ */
1387
+ application_cryptogram: string | null;
1388
+
1389
+ /**
1390
+ * Mnenomic of the Application Identifier.
1391
+ */
1392
+ application_preferred_name: string | null;
1393
+
1394
+ /**
1395
+ * Identifier for this transaction.
1396
+ */
1397
+ authorization_code: string | null;
1398
+
1399
+ /**
1400
+ * EMV tag 8A. A code returned by the card issuer.
1401
+ */
1402
+ authorization_response_code: string | null;
1403
+
1404
+ /**
1405
+ * Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.
1406
+ */
1407
+ cardholder_verification_method: string | null;
1408
+
1409
+ /**
1410
+ * EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
1411
+ */
1412
+ dedicated_file_name: string | null;
1413
+
1414
+ /**
1415
+ * The outcome of a series of EMV functions performed by the card reader.
1416
+ */
1417
+ terminal_verification_results: string | null;
1418
+
1419
+ /**
1420
+ * An indication of various EMV functions performed during the transaction.
1421
+ */
1422
+ transaction_status_information: string | null;
1423
+ }
1424
+
1425
+ namespace Receipt {
1426
+ type AccountType = 'checking' | 'savings' | 'unknown';
1427
+ }
1428
+ }
1429
+
1430
+ interface KakaoPay {
1431
+ /**
1432
+ * A unique identifier for the buyer as determined by the local payment processor.
1433
+ */
1434
+ buyer_id: string | null;
1435
+ }
1436
+
1437
+ interface Klarna {
1438
+ /**
1439
+ * The payer details for this transaction.
1440
+ */
1441
+ payer_details: Klarna.PayerDetails | null;
1442
+
1443
+ /**
1444
+ * The Klarna payment method used for this transaction.
1445
+ * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
1446
+ */
1447
+ payment_method_category: string | null;
1448
+
1449
+ /**
1450
+ * Preferred language of the Klarna authorization page that the customer is redirected to.
1451
+ * Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`
1452
+ */
1453
+ preferred_locale: string | null;
1454
+ }
1455
+
1456
+ namespace Klarna {
1457
+ interface PayerDetails {
1458
+ /**
1459
+ * The payer's address
1460
+ */
1461
+ address: PayerDetails.Address | null;
1462
+ }
1463
+
1464
+ namespace PayerDetails {
1465
+ interface Address {
1466
+ /**
1467
+ * The payer address country
1468
+ */
1469
+ country: string | null;
1470
+ }
1471
+ }
1472
+ }
1473
+
1474
+ interface Konbini {
1475
+ /**
1476
+ * If the payment succeeded, this contains the details of the convenience store where the payment was completed.
1477
+ */
1478
+ store: Konbini.Store | null;
1479
+ }
1480
+
1481
+ namespace Konbini {
1482
+ interface Store {
1483
+ /**
1484
+ * The name of the convenience store chain where the payment was completed.
1485
+ */
1486
+ chain: Store.Chain | null;
1487
+ }
1488
+
1489
+ namespace Store {
1490
+ type Chain = 'familymart' | 'lawson' | 'ministop' | 'seicomart';
1491
+ }
1492
+ }
1493
+
1494
+ interface KrCard {
1495
+ /**
1496
+ * The local credit or debit card brand.
1497
+ */
1498
+ brand: KrCard.Brand | null;
1499
+
1500
+ /**
1501
+ * A unique identifier for the buyer as determined by the local payment processor.
1502
+ */
1503
+ buyer_id: string | null;
1504
+
1505
+ /**
1506
+ * The last four digits of the card. This may not be present for American Express cards.
1507
+ */
1508
+ last4: string | null;
1509
+ }
1510
+
1511
+ namespace KrCard {
1512
+ type Brand =
1513
+ | 'bc'
1514
+ | 'citi'
1515
+ | 'hana'
1516
+ | 'hyundai'
1517
+ | 'jeju'
1518
+ | 'jeonbuk'
1519
+ | 'kakaobank'
1520
+ | 'kbank'
1521
+ | 'kdbbank'
1522
+ | 'kookmin'
1523
+ | 'kwangju'
1524
+ | 'lotte'
1525
+ | 'mg'
1526
+ | 'nh'
1527
+ | 'post'
1528
+ | 'samsung'
1529
+ | 'savingsbank'
1530
+ | 'shinhan'
1531
+ | 'shinhyup'
1532
+ | 'suhyup'
1533
+ | 'tossbank'
1534
+ | 'woori';
1535
+ }
1536
+
1537
+ interface Link {
1538
+ /**
1539
+ * Two-letter ISO code representing the funding source country beneath the Link payment.
1540
+ * You could use this attribute to get a sense of international fees.
1541
+ */
1542
+ country: string | null;
1543
+ }
1544
+
1545
+ interface MbWay {}
1546
+
1547
+ interface Mobilepay {
1548
+ /**
1549
+ * Internal card details
1550
+ */
1551
+ card: Mobilepay.Card | null;
1552
+ }
1553
+
1554
+ namespace Mobilepay {
1555
+ interface Card {
1556
+ /**
1557
+ * Brand of the card used in the transaction
1558
+ */
1559
+ brand: string | null;
1560
+
1561
+ /**
1562
+ * Two-letter ISO code representing the country of the card
1563
+ */
1564
+ country: string | null;
1565
+
1566
+ /**
1567
+ * Two digit number representing the card's expiration month
1568
+ */
1569
+ exp_month: number | null;
1570
+
1571
+ /**
1572
+ * Two digit number representing the card's expiration year
1573
+ */
1574
+ exp_year: number | null;
1575
+
1576
+ /**
1577
+ * The last 4 digits of the card
1578
+ */
1579
+ last4: string | null;
1580
+ }
1581
+ }
1582
+
1583
+ interface Multibanco {
1584
+ /**
1585
+ * Entity number associated with this Multibanco payment.
1586
+ */
1587
+ entity: string | null;
1588
+
1589
+ /**
1590
+ * Reference number associated with this Multibanco payment.
1591
+ */
1592
+ reference: string | null;
1593
+ }
1594
+
1595
+ interface NaverPay {
1596
+ /**
1597
+ * A unique identifier for the buyer as determined by the local payment processor.
1598
+ */
1599
+ buyer_id: string | null;
1600
+ }
1601
+
1602
+ interface NzBankAccount {
1603
+ /**
1604
+ * The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
1605
+ */
1606
+ account_holder_name: string | null;
1607
+
1608
+ /**
1609
+ * The numeric code for the bank account's bank.
1610
+ */
1611
+ bank_code: string;
1612
+
1613
+ /**
1614
+ * The name of the bank.
1615
+ */
1616
+ bank_name: string;
1617
+
1618
+ /**
1619
+ * The numeric code for the bank account's bank branch.
1620
+ */
1621
+ branch_code: string;
1622
+
1623
+ /**
1624
+ * Last four digits of the bank account number.
1625
+ */
1626
+ last4: string;
1627
+
1628
+ /**
1629
+ * The suffix of the bank account number.
1630
+ */
1631
+ suffix: string | null;
1632
+ }
1633
+
1634
+ interface Oxxo {
1635
+ /**
1636
+ * OXXO reference number
1637
+ */
1638
+ number: string | null;
1639
+ }
1640
+
1641
+ interface P24 {
1642
+ /**
1643
+ * The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.
1644
+ */
1645
+ bank: P24.Bank | null;
1646
+
1647
+ /**
1648
+ * Unique reference for this Przelewy24 payment.
1649
+ */
1650
+ reference: string | null;
1651
+
1652
+ /**
1653
+ * Owner's verified full name. Values are verified or provided by Przelewy24 directly
1654
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1655
+ * Przelewy24 rarely provides this information so the attribute is usually empty.
1656
+ */
1657
+ verified_name: string | null;
1658
+ }
1659
+
1660
+ namespace P24 {
1661
+ type Bank =
1662
+ | 'alior_bank'
1663
+ | 'bank_millennium'
1664
+ | 'bank_nowy_bfg_sa'
1665
+ | 'bank_pekao_sa'
1666
+ | 'banki_spbdzielcze'
1667
+ | 'blik'
1668
+ | 'bnp_paribas'
1669
+ | 'boz'
1670
+ | 'citi_handlowy'
1671
+ | 'credit_agricole'
1672
+ | 'envelobank'
1673
+ | 'etransfer_pocztowy24'
1674
+ | 'getin_bank'
1675
+ | 'ideabank'
1676
+ | 'ing'
1677
+ | 'inteligo'
1678
+ | 'mbank_mtransfer'
1679
+ | 'nest_przelew'
1680
+ | 'noble_pay'
1681
+ | 'pbac_z_ipko'
1682
+ | 'plus_bank'
1683
+ | 'santander_przelew24'
1684
+ | 'tmobile_usbugi_bankowe'
1685
+ | 'toyota_bank'
1686
+ | 'velobank'
1687
+ | 'volkswagen_bank';
1688
+ }
1689
+
1690
+ interface PayByBank {}
1691
+
1692
+ interface Payco {
1693
+ /**
1694
+ * A unique identifier for the buyer as determined by the local payment processor.
1695
+ */
1696
+ buyer_id: string | null;
1697
+ }
1698
+
1699
+ interface Paynow {
1700
+ /**
1701
+ * Reference number associated with this PayNow payment
1702
+ */
1703
+ reference: string | null;
1704
+ }
1705
+
1706
+ interface Paypal {
1707
+ /**
1708
+ * Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1709
+ */
1710
+ country: string | null;
1711
+
1712
+ /**
1713
+ * Owner's email. Values are provided by PayPal directly
1714
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1715
+ */
1716
+ payer_email: string | null;
1717
+
1718
+ /**
1719
+ * PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
1720
+ */
1721
+ payer_id: string | null;
1722
+
1723
+ /**
1724
+ * Owner's full name. Values provided by PayPal directly
1725
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1726
+ */
1727
+ payer_name: string | null;
1728
+
1729
+ /**
1730
+ * The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
1731
+ */
1732
+ seller_protection: Paypal.SellerProtection | null;
1733
+
1734
+ /**
1735
+ * The shipping address for the customer, as supplied by the merchant at the point of payment
1736
+ * execution. This shipping address will not be updated if the merchant updates the shipping
1737
+ * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
1738
+ */
1739
+ shipping?: Stripe.Address | null;
1740
+
1741
+ /**
1742
+ * A unique ID generated by PayPal for this transaction.
1743
+ */
1744
+ transaction_id: string | null;
1745
+
1746
+ /**
1747
+ * The shipping address for the customer, as supplied by the merchant at the point of payment
1748
+ * execution. This shipping address will not be updated if the merchant updates the shipping
1749
+ * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
1750
+ */
1751
+ verified_address?: Stripe.Address | null;
1752
+
1753
+ /**
1754
+ * Owner's verified email. Values are verified or provided by PayPal directly
1755
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1756
+ */
1757
+ verified_email?: string | null;
1758
+
1759
+ /**
1760
+ * Owner's verified full name. Values are verified or provided by PayPal directly
1761
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1762
+ */
1763
+ verified_name?: string | null;
1764
+ }
1765
+
1766
+ namespace Paypal {
1767
+ interface SellerProtection {
1768
+ /**
1769
+ * An array of conditions that are covered for the transaction, if applicable.
1770
+ */
1771
+ dispute_categories: Array<SellerProtection.DisputeCategory> | null;
1772
+
1773
+ /**
1774
+ * Indicates whether the transaction is eligible for PayPal's seller protection.
1775
+ */
1776
+ status: SellerProtection.Status;
1777
+ }
1778
+
1779
+ namespace SellerProtection {
1780
+ type DisputeCategory = 'fraudulent' | 'product_not_received';
1781
+
1782
+ type Status = 'eligible' | 'not_eligible' | 'partially_eligible';
1783
+ }
1784
+ }
1785
+
1786
+ interface Payto {
1787
+ /**
1788
+ * Bank-State-Branch number of the bank account.
1789
+ */
1790
+ bsb_number: string | null;
1791
+
1792
+ /**
1793
+ * Last four digits of the bank account number.
1794
+ */
1795
+ last4: string | null;
1796
+
1797
+ /**
1798
+ * ID of the mandate used to make this payment.
1799
+ */
1800
+ mandate?: string;
1801
+
1802
+ /**
1803
+ * The PayID alias for the bank account.
1804
+ */
1805
+ pay_id: string | null;
1806
+ }
1807
+
1808
+ interface Pix {
1809
+ /**
1810
+ * Unique transaction id generated by BCB
1811
+ */
1812
+ bank_transaction_id?: string | null;
1813
+ }
1814
+
1815
+ interface Promptpay {
1816
+ /**
1817
+ * Bill reference generated by PromptPay
1818
+ */
1819
+ reference: string | null;
1820
+ }
1821
+
1822
+ interface Qris {}
1823
+
1824
+ interface Rechnung {}
1825
+
1826
+ interface RevolutPay {
1827
+ funding?: RevolutPay.Funding;
1828
+ }
1829
+
1830
+ namespace RevolutPay {
1831
+ interface Funding {
1832
+ card?: Funding.Card;
1833
+
1834
+ /**
1835
+ * funding type of the underlying payment method.
1836
+ */
1837
+ type: 'card' | null;
1838
+ }
1839
+
1840
+ namespace Funding {
1841
+ interface Card {
1842
+ /**
1843
+ * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
1844
+ */
1845
+ brand: string | null;
1846
+
1847
+ /**
1848
+ * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
1849
+ */
1850
+ brand_product?: string | null;
1851
+
1852
+ /**
1853
+ * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
1854
+ */
1855
+ country: string | null;
1856
+
1857
+ /**
1858
+ * Two-digit number representing the card's expiration month.
1859
+ */
1860
+ exp_month: number | null;
1861
+
1862
+ /**
1863
+ * Four-digit number representing the card's expiration year.
1864
+ */
1865
+ exp_year: number | null;
1866
+
1867
+ /**
1868
+ * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
1869
+ */
1870
+ funding: string | null;
1871
+
1872
+ /**
1873
+ * The last four digits of the card.
1874
+ */
1875
+ last4: string | null;
1876
+ }
1877
+ }
1878
+ }
1879
+
1880
+ interface SamsungPay {
1881
+ /**
1882
+ * A unique identifier for the buyer as determined by the local payment processor.
1883
+ */
1884
+ buyer_id: string | null;
1885
+ }
1886
+
1887
+ interface Satispay {}
1888
+
1889
+ interface SepaCreditTransfer {
1890
+ /**
1891
+ * Name of the bank associated with the bank account.
1892
+ */
1893
+ bank_name: string | null;
1894
+
1895
+ /**
1896
+ * Bank Identifier Code of the bank associated with the bank account.
1897
+ */
1898
+ bic: string | null;
1899
+
1900
+ /**
1901
+ * IBAN of the bank account to transfer funds to.
1902
+ */
1903
+ iban: string | null;
1904
+ }
1905
+
1906
+ interface SepaDebit {
1907
+ /**
1908
+ * Bank code of bank associated with the bank account.
1909
+ */
1910
+ bank_code: string | null;
1911
+
1912
+ /**
1913
+ * Branch code of bank associated with the bank account.
1914
+ */
1915
+ branch_code: string | null;
1916
+
1917
+ /**
1918
+ * Two-letter ISO code representing the country the bank account is located in.
1919
+ */
1920
+ country: string | null;
1921
+
1922
+ /**
1923
+ * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
1924
+ */
1925
+ fingerprint: string | null;
1926
+
1927
+ /**
1928
+ * Last four characters of the IBAN.
1929
+ */
1930
+ last4: string | null;
1931
+
1932
+ /**
1933
+ * Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).
1934
+ */
1935
+ mandate: string | null;
1936
+ }
1937
+
1938
+ interface Shopeepay {}
1939
+
1940
+ interface Sofort {
1941
+ /**
1942
+ * Bank code of bank associated with the bank account.
1943
+ */
1944
+ bank_code: string | null;
1945
+
1946
+ /**
1947
+ * Name of the bank associated with the bank account.
1948
+ */
1949
+ bank_name: string | null;
1950
+
1951
+ /**
1952
+ * Bank Identifier Code of the bank associated with the bank account.
1953
+ */
1954
+ bic: string | null;
1955
+
1956
+ /**
1957
+ * Two-letter ISO code representing the country the bank account is located in.
1958
+ */
1959
+ country: string | null;
1960
+
1961
+ /**
1962
+ * The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
1963
+ */
1964
+ generated_sepa_debit: string | Stripe.PaymentMethod | null;
1965
+
1966
+ /**
1967
+ * The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
1968
+ */
1969
+ generated_sepa_debit_mandate: string | Stripe.Mandate | null;
1970
+
1971
+ /**
1972
+ * Last four characters of the IBAN.
1973
+ */
1974
+ iban_last4: string | null;
1975
+
1976
+ /**
1977
+ * Preferred language of the SOFORT authorization page that the customer is redirected to.
1978
+ * Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
1979
+ */
1980
+ preferred_language: Sofort.PreferredLanguage | null;
1981
+
1982
+ /**
1983
+ * Owner's verified full name. Values are verified or provided by SOFORT directly
1984
+ * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1985
+ */
1986
+ verified_name: string | null;
1987
+ }
1988
+
1989
+ namespace Sofort {
1990
+ type PreferredLanguage =
1991
+ | 'de'
1992
+ | 'en'
1993
+ | 'es'
1994
+ | 'fr'
1995
+ | 'it'
1996
+ | 'nl'
1997
+ | 'pl';
1998
+ }
1999
+
2000
+ interface StripeAccount {}
2001
+
2002
+ interface StripeBalance {
2003
+ /**
2004
+ * The connected account ID whose Stripe balance to use as the source of payment
2005
+ */
2006
+ account?: string | null;
2007
+
2008
+ /**
2009
+ * The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
2010
+ */
2011
+ source_type: StripeBalance.SourceType;
2012
+ }
2013
+
2014
+ namespace StripeBalance {
2015
+ type SourceType = 'bank_account' | 'card' | 'fpx';
2016
+ }
2017
+
2018
+ interface Swish {
2019
+ /**
2020
+ * Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
2021
+ */
2022
+ fingerprint: string | null;
2023
+
2024
+ /**
2025
+ * Payer bank reference number for the payment
2026
+ */
2027
+ payment_reference: string | null;
2028
+
2029
+ /**
2030
+ * The last four digits of the Swish account phone number
2031
+ */
2032
+ verified_phone_last4: string | null;
2033
+ }
2034
+
2035
+ interface Twint {}
2036
+
2037
+ interface UsBankAccount {
2038
+ /**
2039
+ * Account holder type: individual or company.
2040
+ */
2041
+ account_holder_type: UsBankAccount.AccountHolderType | null;
2042
+
2043
+ /**
2044
+ * Account type: checkings or savings. Defaults to checking if omitted.
2045
+ */
2046
+ account_type: UsBankAccount.AccountType | null;
2047
+
2048
+ /**
2049
+ * Name of the bank associated with the bank account.
2050
+ */
2051
+ bank_name: string | null;
2052
+
2053
+ /**
2054
+ * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
2055
+ */
2056
+ fingerprint: string | null;
2057
+
2058
+ /**
2059
+ * Last four digits of the bank account number.
2060
+ */
2061
+ last4: string | null;
2062
+
2063
+ /**
2064
+ * ID of the mandate used to make this payment.
2065
+ */
2066
+ mandate?: string | Stripe.Mandate;
2067
+
2068
+ /**
2069
+ * Reference number to locate ACH payments with customer's bank.
2070
+ */
2071
+ payment_reference: string | null;
2072
+
2073
+ /**
2074
+ * Routing number of the bank account.
2075
+ */
2076
+ routing_number: string | null;
2077
+ }
2078
+
2079
+ namespace UsBankAccount {
2080
+ type AccountHolderType = 'company' | 'individual';
2081
+
2082
+ type AccountType = 'checking' | 'savings';
2083
+ }
2084
+
2085
+ interface Wechat {}
2086
+
2087
+ interface WechatPay {
2088
+ /**
2089
+ * Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
2090
+ */
2091
+ fingerprint: string | null;
2092
+
2093
+ /**
2094
+ * ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
2095
+ */
2096
+ location?: string;
2097
+
2098
+ /**
2099
+ * ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
2100
+ */
2101
+ reader?: string;
2102
+
2103
+ /**
2104
+ * Transaction ID of this particular WeChat Pay transaction.
2105
+ */
2106
+ transaction_id: string | null;
2107
+ }
2108
+
2109
+ interface Zip {}
2110
+ }
2111
+
2112
+ type ReportedBy = 'self' | 'stripe';
2113
+
2114
+ interface ShippingDetails {
2115
+ /**
2116
+ * A representation of a physical address.
2117
+ */
2118
+ address: Stripe.Address;
2119
+
2120
+ /**
2121
+ * The shipping recipient's name.
2122
+ */
2123
+ name: string | null;
2124
+
2125
+ /**
2126
+ * The shipping recipient's phone number.
2127
+ */
2128
+ phone: string | null;
2129
+ }
2130
+ }
2131
+ }
2132
+ }