stripe 15.2.0.pre.beta.1 → 15.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (648) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +718 -1556
  3. data/CONTRIBUTING.md +25 -0
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +10 -7
  6. data/VERSION +1 -1
  7. data/lib/stripe/api_requestor.rb +0 -28
  8. data/lib/stripe/api_version.rb +1 -1
  9. data/lib/stripe/errors.rb +0 -54
  10. data/lib/stripe/event_types.rb +0 -89
  11. data/lib/stripe/object_types.rb +0 -52
  12. data/lib/stripe/resources/account.rb +32 -657
  13. data/lib/stripe/resources/account_session.rb +59 -253
  14. data/lib/stripe/resources/apple_pay_domain.rb +1 -2
  15. data/lib/stripe/resources/balance.rb +42 -0
  16. data/lib/stripe/resources/balance_transaction.rb +2 -0
  17. data/lib/stripe/resources/bank_account.rb +2 -2
  18. data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -2
  19. data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -4
  20. data/lib/stripe/resources/billing/credit_grant.rb +0 -10
  21. data/lib/stripe/resources/billing_portal/session.rb +1 -7
  22. data/lib/stripe/resources/capability.rb +1 -1
  23. data/lib/stripe/resources/card.rb +0 -2
  24. data/lib/stripe/resources/cash_balance.rb +0 -2
  25. data/lib/stripe/resources/charge.rb +13 -1475
  26. data/lib/stripe/resources/checkout/session.rb +21 -333
  27. data/lib/stripe/resources/confirmation_token.rb +33 -263
  28. data/lib/stripe/resources/country_spec.rb +1 -1
  29. data/lib/stripe/resources/coupon.rb +2 -32
  30. data/lib/stripe/resources/credit_note.rb +10 -17
  31. data/lib/stripe/resources/credit_note_line_item.rb +0 -9
  32. data/lib/stripe/resources/customer.rb +2 -6
  33. data/lib/stripe/resources/customer_balance_transaction.rb +0 -2
  34. data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -2
  35. data/lib/stripe/resources/customer_session.rb +4 -9
  36. data/lib/stripe/resources/discount.rb +0 -2
  37. data/lib/stripe/resources/dispute.rb +2 -2
  38. data/lib/stripe/resources/event.rb +1 -32
  39. data/lib/stripe/resources/file.rb +1 -1
  40. data/lib/stripe/resources/financial_connections/account.rb +1 -20
  41. data/lib/stripe/resources/financial_connections/session.rb +2 -62
  42. data/lib/stripe/resources/identity/verification_report.rb +6 -0
  43. data/lib/stripe/resources/identity/verification_session.rb +17 -21
  44. data/lib/stripe/resources/invoice.rb +79 -1106
  45. data/lib/stripe/resources/invoice_item.rb +4 -81
  46. data/lib/stripe/resources/invoice_line_item.rb +2 -56
  47. data/lib/stripe/resources/invoice_payment.rb +62 -4
  48. data/lib/stripe/resources/issuing/authorization.rb +8 -8
  49. data/lib/stripe/resources/issuing/card.rb +1 -1
  50. data/lib/stripe/resources/issuing/cardholder.rb +1 -2
  51. data/lib/stripe/resources/issuing/dispute.rb +3 -3
  52. data/lib/stripe/resources/issuing/transaction.rb +0 -6
  53. data/lib/stripe/resources/line_item.rb +0 -37
  54. data/lib/stripe/resources/mandate.rb +0 -24
  55. data/lib/stripe/resources/payment_intent.rb +1912 -6840
  56. data/lib/stripe/resources/payment_method.rb +47 -301
  57. data/lib/stripe/resources/payment_method_configuration.rb +112 -112
  58. data/lib/stripe/resources/payment_method_domain.rb +2 -2
  59. data/lib/stripe/resources/payout.rb +4 -10
  60. data/lib/stripe/resources/person.rb +2 -2
  61. data/lib/stripe/resources/plan.rb +2 -3
  62. data/lib/stripe/resources/price.rb +1 -31
  63. data/lib/stripe/resources/product.rb +1 -61
  64. data/lib/stripe/resources/promotion_code.rb +0 -10
  65. data/lib/stripe/resources/quote.rb +6 -2046
  66. data/lib/stripe/resources/radar/value_list.rb +1 -2
  67. data/lib/stripe/resources/radar/value_list_item.rb +1 -2
  68. data/lib/stripe/resources/refund.rb +6 -10
  69. data/lib/stripe/resources/reversal.rb +1 -1
  70. data/lib/stripe/resources/review.rb +1 -1
  71. data/lib/stripe/resources/setup_attempt.rb +0 -21
  72. data/lib/stripe/resources/setup_intent.rb +120 -877
  73. data/lib/stripe/resources/source.rb +1 -30
  74. data/lib/stripe/resources/subscription.rb +97 -326
  75. data/lib/stripe/resources/subscription_item.rb +32 -80
  76. data/lib/stripe/resources/subscription_schedule.rb +127 -1015
  77. data/lib/stripe/resources/tax/calculation.rb +4 -0
  78. data/lib/stripe/resources/tax/calculation_line_item.rb +2 -0
  79. data/lib/stripe/resources/tax/registration.rb +1 -1
  80. data/lib/stripe/resources/tax_id.rb +3 -14
  81. data/lib/stripe/resources/tax_rate.rb +2 -2
  82. data/lib/stripe/resources/terminal/configuration.rb +1 -2
  83. data/lib/stripe/resources/terminal/location.rb +2 -3
  84. data/lib/stripe/resources/terminal/reader.rb +8 -142
  85. data/lib/stripe/resources/test_helpers/test_clock.rb +1 -2
  86. data/lib/stripe/resources/token.rb +2 -2
  87. data/lib/stripe/resources/transfer.rb +1 -7
  88. data/lib/stripe/resources/treasury/financial_account.rb +3 -22
  89. data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
  90. data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -37
  91. data/lib/stripe/resources/treasury/received_credit.rb +1 -38
  92. data/lib/stripe/resources/treasury/received_debit.rb +1 -40
  93. data/lib/stripe/resources/webhook_endpoint.rb +1 -2
  94. data/lib/stripe/resources.rb +0 -99
  95. data/lib/stripe/services/account_external_account_service.rb +2 -3
  96. data/lib/stripe/services/account_login_link_service.rb +1 -1
  97. data/lib/stripe/services/account_person_service.rb +1 -2
  98. data/lib/stripe/services/account_service.rb +23 -559
  99. data/lib/stripe/services/account_session_service.rb +29 -229
  100. data/lib/stripe/services/apple_pay_domain_service.rb +1 -2
  101. data/lib/stripe/services/balance_service.rb +1 -1
  102. data/lib/stripe/services/billing/credit_balance_summary_service.rb +1 -4
  103. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -4
  104. data/lib/stripe/services/billing/credit_grant_service.rb +0 -8
  105. data/lib/stripe/services/billing_portal/session_service.rb +0 -4
  106. data/lib/stripe/services/charge_service.rb +4 -1354
  107. data/lib/stripe/services/checkout/session_service.rb +13 -250
  108. data/lib/stripe/services/coupon_service.rb +2 -19
  109. data/lib/stripe/services/credit_note_service.rb +7 -12
  110. data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
  111. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
  112. data/lib/stripe/services/customer_payment_source_service.rb +1 -1
  113. data/lib/stripe/services/customer_service.rb +3 -5
  114. data/lib/stripe/services/customer_session_service.rb +1 -4
  115. data/lib/stripe/services/customer_tax_id_service.rb +1 -2
  116. data/lib/stripe/services/dispute_service.rb +1 -1
  117. data/lib/stripe/services/file_service.rb +1 -1
  118. data/lib/stripe/services/financial_connections/account_service.rb +2 -7
  119. data/lib/stripe/services/financial_connections/session_service.rb +2 -34
  120. data/lib/stripe/services/financial_connections_service.rb +1 -2
  121. data/lib/stripe/services/identity/verification_session_service.rb +5 -13
  122. data/lib/stripe/services/invoice_item_service.rb +3 -76
  123. data/lib/stripe/services/invoice_line_item_service.rb +1 -33
  124. data/lib/stripe/services/invoice_payment_service.rb +83 -0
  125. data/lib/stripe/services/invoice_service.rb +74 -1049
  126. data/lib/stripe/services/issuing/authorization_service.rb +4 -4
  127. data/lib/stripe/services/issuing/card_service.rb +1 -1
  128. data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
  129. data/lib/stripe/services/issuing/dispute_service.rb +2 -2
  130. data/lib/stripe/services/issuing/transaction_service.rb +0 -4
  131. data/lib/stripe/services/issuing_service.rb +1 -5
  132. data/lib/stripe/services/payment_intent_service.rb +439 -4928
  133. data/lib/stripe/services/payment_method_configuration_service.rb +82 -82
  134. data/lib/stripe/services/payment_method_domain_service.rb +1 -1
  135. data/lib/stripe/services/payment_method_service.rb +44 -226
  136. data/lib/stripe/services/payout_service.rb +2 -6
  137. data/lib/stripe/services/plan_service.rb +2 -3
  138. data/lib/stripe/services/price_service.rb +2 -21
  139. data/lib/stripe/services/product_feature_service.rb +1 -2
  140. data/lib/stripe/services/product_service.rb +2 -41
  141. data/lib/stripe/services/promotion_code_service.rb +1 -9
  142. data/lib/stripe/services/quote_service.rb +7 -1730
  143. data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
  144. data/lib/stripe/services/radar/value_list_item_service.rb +1 -2
  145. data/lib/stripe/services/radar/value_list_service.rb +1 -2
  146. data/lib/stripe/services/setup_intent_service.rb +119 -836
  147. data/lib/stripe/services/source_service.rb +1 -1
  148. data/lib/stripe/services/subscription_item_service.rb +27 -73
  149. data/lib/stripe/services/subscription_schedule_service.rb +101 -916
  150. data/lib/stripe/services/subscription_service.rb +85 -282
  151. data/lib/stripe/services/tax/calculation_service.rb +4 -0
  152. data/lib/stripe/services/tax/registration_service.rb +1 -1
  153. data/lib/stripe/services/tax_id_service.rb +3 -10
  154. data/lib/stripe/services/tax_service.rb +1 -3
  155. data/lib/stripe/services/terminal/configuration_service.rb +1 -2
  156. data/lib/stripe/services/terminal/location_service.rb +2 -3
  157. data/lib/stripe/services/terminal/reader_service.rb +5 -81
  158. data/lib/stripe/services/terminal_service.rb +1 -2
  159. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +33 -190
  160. data/lib/stripe/services/test_helpers/test_clock_service.rb +1 -2
  161. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
  162. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
  163. data/lib/stripe/services/token_service.rb +1 -1
  164. data/lib/stripe/services/transfer_service.rb +1 -5
  165. data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
  166. data/lib/stripe/services/treasury/financial_account_service.rb +2 -16
  167. data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
  168. data/lib/stripe/services/v1_services.rb +2 -12
  169. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +1 -2
  170. data/lib/stripe/services/v2/core/event_destination_service.rb +4 -10
  171. data/lib/stripe/services/v2/core/event_service.rb +1 -2
  172. data/lib/stripe/services/v2/core_service.rb +1 -4
  173. data/lib/stripe/services/v2_services.rb +2 -4
  174. data/lib/stripe/services/webhook_endpoint_service.rb +1 -2
  175. data/lib/stripe/services.rb +1 -54
  176. data/lib/stripe/stripe_configuration.rb +1 -3
  177. data/lib/stripe/stripe_object.rb +1 -1
  178. data/lib/stripe/util.rb +1 -7
  179. data/lib/stripe/version.rb +1 -1
  180. data/lib/stripe.rb +0 -53
  181. data/rbi/stripe/resources/account.rbi +4926 -0
  182. data/rbi/stripe/resources/account_link.rbi +74 -0
  183. data/rbi/stripe/resources/account_session.rbi +1013 -0
  184. data/rbi/stripe/resources/apple_pay_domain.rbi +88 -0
  185. data/rbi/stripe/resources/application.rbi +20 -0
  186. data/rbi/stripe/resources/application_fee.rbi +118 -0
  187. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  188. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  189. data/rbi/stripe/resources/balance.rbi +235 -0
  190. data/rbi/stripe/resources/balance_transaction.rbi +147 -0
  191. data/rbi/stripe/resources/bank_account.rbi +127 -0
  192. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  193. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  194. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  195. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  196. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  197. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  198. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  199. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  200. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  201. data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
  202. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  203. data/rbi/stripe/resources/capability.rbi +125 -0
  204. data/rbi/stripe/resources/card.rbi +125 -0
  205. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  206. data/rbi/stripe/resources/charge.rbi +2069 -0
  207. data/rbi/stripe/resources/checkout/session.rbi +4004 -0
  208. data/rbi/stripe/resources/climate/order.rbi +245 -0
  209. data/rbi/stripe/resources/climate/product.rbi +75 -0
  210. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  211. data/rbi/stripe/resources/confirmation_token.rbi +1807 -0
  212. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  213. data/rbi/stripe/resources/country_spec.rbi +85 -0
  214. data/rbi/stripe/resources/coupon.rbi +250 -0
  215. data/rbi/stripe/resources/credit_note.rbi +752 -0
  216. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  217. data/rbi/stripe/resources/customer.rbi +1005 -0
  218. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  219. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  220. data/rbi/stripe/resources/customer_session.rbi +200 -0
  221. data/rbi/stripe/resources/discount.rbi +53 -0
  222. data/rbi/stripe/resources/dispute.rbi +761 -0
  223. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  224. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  225. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  226. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  227. data/rbi/stripe/resources/event.rbi +149 -0
  228. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  229. data/rbi/stripe/resources/file.rbi +143 -0
  230. data/rbi/stripe/resources/file_link.rbi +141 -0
  231. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  232. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  233. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  234. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  235. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  236. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  237. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  238. data/rbi/stripe/resources/identity/verification_report.rbi +360 -0
  239. data/rbi/stripe/resources/identity/verification_session.rbi +526 -0
  240. data/rbi/stripe/resources/invoice.rbi +3812 -0
  241. data/rbi/stripe/resources/invoice_item.rbi +473 -0
  242. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  243. data/rbi/stripe/resources/invoice_payment.rbi +121 -0
  244. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  245. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  246. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  247. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  248. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  249. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  250. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  251. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  252. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  253. data/rbi/stripe/resources/line_item.rbi +72 -0
  254. data/rbi/stripe/resources/login_link.rbi +19 -0
  255. data/rbi/stripe/resources/mandate.rbi +187 -0
  256. data/rbi/stripe/resources/payment_intent.rbi +9647 -0
  257. data/rbi/stripe/resources/payment_link.rbi +1801 -0
  258. data/rbi/stripe/resources/payment_method.rbi +1761 -0
  259. data/rbi/stripe/resources/payment_method_configuration.rbi +3550 -0
  260. data/rbi/stripe/resources/payment_method_domain.rbi +228 -0
  261. data/rbi/stripe/resources/payout.rbi +300 -0
  262. data/rbi/stripe/resources/person.rbi +401 -0
  263. data/rbi/stripe/resources/plan.rbi +371 -0
  264. data/rbi/stripe/resources/price.rbi +694 -0
  265. data/rbi/stripe/resources/product.rbi +555 -0
  266. data/rbi/stripe/resources/product_feature.rbi +26 -0
  267. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  268. data/rbi/stripe/resources/quote.rbi +1126 -0
  269. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  270. data/rbi/stripe/resources/radar/value_list.rbi +168 -0
  271. data/rbi/stripe/resources/radar/value_list_item.rbi +129 -0
  272. data/rbi/stripe/resources/refund.rbi +523 -0
  273. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  274. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  275. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  276. data/rbi/stripe/resources/reversal.rbi +51 -0
  277. data/rbi/stripe/resources/review.rbi +154 -0
  278. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  279. data/rbi/stripe/resources/setup_intent.rbi +3655 -0
  280. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  281. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  282. data/rbi/stripe/resources/source.rbi +1496 -0
  283. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  284. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  285. data/rbi/stripe/resources/subscription.rbi +2027 -0
  286. data/rbi/stripe/resources/subscription_item.rbi +404 -0
  287. data/rbi/stripe/resources/subscription_schedule.rbi +1623 -0
  288. data/rbi/stripe/resources/tax/calculation.rbi +478 -0
  289. data/rbi/stripe/resources/tax/calculation_line_item.rbi +91 -0
  290. data/rbi/stripe/resources/tax/registration.rbi +2713 -0
  291. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  292. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  293. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  294. data/rbi/stripe/resources/tax_code.rbi +44 -0
  295. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  296. data/rbi/stripe/resources/tax_id.rbi +165 -0
  297. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  298. data/rbi/stripe/resources/terminal/configuration.rbi +1386 -0
  299. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  300. data/rbi/stripe/resources/terminal/location.rbi +222 -0
  301. data/rbi/stripe/resources/terminal/reader.rbi +847 -0
  302. data/rbi/stripe/resources/test_helpers/test_clock.rbi +132 -0
  303. data/rbi/stripe/resources/token.rbi +1283 -0
  304. data/rbi/stripe/resources/topup.rbi +222 -0
  305. data/rbi/stripe/resources/transfer.rbi +199 -0
  306. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  307. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  308. data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
  309. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  310. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  311. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  312. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  313. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  314. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  315. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  316. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  317. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  318. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  319. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  320. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  321. data/rbi/stripe/resources/v2/event.rbi +48 -0
  322. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  323. data/rbi/stripe/resources/webhook_endpoint.rbi +168 -0
  324. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  325. data/{lib/stripe/services/external_account_service.rb → rbi/stripe/services/account_external_account_service.rbi} +124 -138
  326. data/rbi/stripe/services/account_link_service.rbi +58 -0
  327. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  328. data/rbi/stripe/services/account_person_service.rbi +1011 -0
  329. data/rbi/stripe/services/account_service.rbi +4213 -0
  330. data/rbi/stripe/services/account_session_service.rbi +646 -0
  331. data/rbi/stripe/services/apple_pay_domain_service.rbi +76 -0
  332. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  333. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  334. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  335. data/rbi/stripe/services/apps_service.rbi +9 -0
  336. data/rbi/stripe/services/balance_service.rbi +21 -0
  337. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  338. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  339. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  340. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  341. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  342. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  343. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  344. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  345. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  346. data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
  347. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  348. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  349. data/rbi/stripe/services/billing_service.rbi +15 -0
  350. data/rbi/stripe/services/charge_service.rbi +448 -0
  351. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  352. data/rbi/stripe/services/checkout/session_service.rbi +2614 -0
  353. data/rbi/stripe/services/checkout_service.rbi +9 -0
  354. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  355. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  356. data/{lib/stripe/services/financial_connections/institution_service.rb → rbi/stripe/services/climate/supplier_service.rbi} +25 -36
  357. data/rbi/stripe/services/climate_service.rbi +11 -0
  358. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  359. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  360. data/rbi/stripe/services/coupon_service.rbi +194 -0
  361. data/{lib/stripe/services/quote_preview_invoice_service.rb → rbi/stripe/services/credit_note_line_item_service.rbi} +16 -20
  362. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  363. data/rbi/stripe/services/credit_note_service.rbi +415 -0
  364. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  365. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  366. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  367. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  368. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  369. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  370. data/rbi/stripe/services/customer_service.rbi +647 -0
  371. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  372. data/rbi/stripe/services/customer_tax_id_service.rbi +70 -0
  373. data/rbi/stripe/services/dispute_service.rbi +424 -0
  374. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  375. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  376. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  377. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  378. data/rbi/stripe/services/event_service.rbi +83 -0
  379. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  380. data/rbi/stripe/services/file_link_service.rbi +124 -0
  381. data/rbi/stripe/services/file_service.rbi +116 -0
  382. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  383. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  384. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  385. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  386. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  387. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  388. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  389. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  390. data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
  391. data/rbi/stripe/services/identity_service.rbi +10 -0
  392. data/rbi/stripe/services/invoice_item_service.rbi +366 -0
  393. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  394. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  395. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  396. data/rbi/stripe/services/invoice_service.rbi +2981 -0
  397. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  398. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  399. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  400. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  401. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  402. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  403. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  404. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  405. data/rbi/stripe/services/issuing_service.rbi +16 -0
  406. data/rbi/stripe/services/mandate_service.rbi +20 -0
  407. data/rbi/stripe/services/payment_intent_service.rbi +7659 -0
  408. data/{lib/stripe/services/payment_intent_amount_details_line_item_service.rb → rbi/stripe/services/payment_link_line_item_service.rbi} +16 -20
  409. data/rbi/stripe/services/payment_link_service.rbi +1352 -0
  410. data/rbi/stripe/services/payment_method_configuration_service.rbi +2487 -0
  411. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  412. data/rbi/stripe/services/payment_method_service.rbi +776 -0
  413. data/rbi/stripe/services/payout_service.rbi +205 -0
  414. data/rbi/stripe/services/plan_service.rbi +282 -0
  415. data/rbi/stripe/services/price_service.rbi +546 -0
  416. data/rbi/stripe/services/product_feature_service.rbi +67 -0
  417. data/rbi/stripe/services/product_service.rbi +477 -0
  418. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  419. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  420. data/{lib/stripe/services/order_line_item_service.rb → rbi/stripe/services/quote_line_item_service.rbi} +16 -20
  421. data/rbi/stripe/services/quote_service.rbi +686 -0
  422. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  423. data/rbi/stripe/services/radar/value_list_item_service.rbi +109 -0
  424. data/rbi/stripe/services/radar/value_list_service.rbi +141 -0
  425. data/rbi/stripe/services/radar_service.rbi +11 -0
  426. data/rbi/stripe/services/refund_service.rbi +185 -0
  427. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  428. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  429. data/rbi/stripe/services/reporting_service.rbi +10 -0
  430. data/rbi/stripe/services/review_service.rbi +84 -0
  431. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  432. data/rbi/stripe/services/setup_intent_service.rbi +3391 -0
  433. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  434. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  435. data/rbi/stripe/services/sigma_service.rbi +9 -0
  436. data/rbi/stripe/services/source_service.rbi +663 -0
  437. data/{lib/stripe/services/quote_line_service.rb → rbi/stripe/services/source_transaction_service.rbi} +16 -20
  438. data/rbi/stripe/services/subscription_item_service.rbi +350 -0
  439. data/rbi/stripe/services/subscription_schedule_service.rbi +1290 -0
  440. data/rbi/stripe/services/subscription_service.rbi +1648 -0
  441. data/{lib/stripe/services/financial_connections/account_inferred_balance_service.rb → rbi/stripe/services/tax/calculation_line_item_service.rbi} +17 -21
  442. data/rbi/stripe/services/tax/calculation_service.rbi +234 -0
  443. data/rbi/stripe/services/tax/registration_service.rbi +1845 -0
  444. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  445. data/{lib/stripe/services/privacy/redaction_job_validation_error_service.rb → rbi/stripe/services/tax/transaction_line_item_service.rbi} +17 -21
  446. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  447. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  448. data/rbi/stripe/services/tax_id_service.rbi +110 -0
  449. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  450. data/rbi/stripe/services/tax_service.rbi +12 -0
  451. data/rbi/stripe/services/terminal/configuration_service.rbi +1118 -0
  452. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  453. data/rbi/stripe/services/terminal/location_service.rbi +182 -0
  454. data/rbi/stripe/services/terminal/reader_service.rbi +455 -0
  455. data/rbi/stripe/services/terminal_service.rbi +12 -0
  456. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +739 -0
  457. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  458. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  459. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  460. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  461. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  462. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  463. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  464. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +93 -0
  465. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  466. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +90 -0
  467. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  468. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  469. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  470. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  471. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  472. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  473. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  474. data/rbi/stripe/services/token_service.rbi +1257 -0
  475. data/rbi/stripe/services/topup_service.rbi +176 -0
  476. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  477. data/rbi/stripe/services/transfer_service.rbi +152 -0
  478. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  479. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  480. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  481. data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
  482. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  483. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  484. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  485. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  486. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  487. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  488. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  489. data/rbi/stripe/services/treasury_service.rbi +18 -0
  490. data/rbi/stripe/services/v1_services.rbi +77 -0
  491. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  492. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  493. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +18 -0
  494. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  495. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  496. data/rbi/stripe/services/v2/core/event_destination_service.rbi +192 -0
  497. data/rbi/stripe/services/v2/core/event_service.rbi +36 -0
  498. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  499. data/rbi/stripe/services/v2_services.rbi +10 -0
  500. data/rbi/stripe/services/webhook_endpoint_service.rbi +129 -0
  501. data/stripe.gemspec +1 -4
  502. metadata +326 -158
  503. data/lib/stripe/events/v2_core_account_closed_event.rb +0 -21
  504. data/lib/stripe/events/v2_core_account_created_event.rb +0 -21
  505. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -23
  506. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -21
  507. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -23
  508. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -21
  509. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -23
  510. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -21
  511. data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +0 -21
  512. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +0 -21
  513. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -21
  514. data/lib/stripe/events/v2_core_account_link_completed_event.rb +0 -13
  515. data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
  516. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
  517. data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
  518. data/lib/stripe/events/v2_core_account_updated_event.rb +0 -21
  519. data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +0 -21
  520. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -21
  521. data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +0 -21
  522. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -21
  523. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -21
  524. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -23
  525. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -21
  526. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -21
  527. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -21
  528. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -21
  529. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -21
  530. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -21
  531. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -21
  532. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -21
  533. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -21
  534. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -21
  535. data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +0 -21
  536. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -21
  537. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -21
  538. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -21
  539. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -21
  540. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -21
  541. data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +0 -21
  542. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -23
  543. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -21
  544. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -21
  545. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -21
  546. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -21
  547. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -21
  548. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -21
  549. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -21
  550. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -21
  551. data/lib/stripe/events/v2_money_management_transaction_created_event.rb +0 -21
  552. data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +0 -21
  553. data/lib/stripe/resources/account_notice.rb +0 -123
  554. data/lib/stripe/resources/balance_settings.rb +0 -105
  555. data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
  556. data/lib/stripe/resources/capital/financing_offer.rb +0 -179
  557. data/lib/stripe/resources/capital/financing_summary.rb +0 -55
  558. data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
  559. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
  560. data/lib/stripe/resources/financial_connections/institution.rb +0 -90
  561. data/lib/stripe/resources/fx_quote.rb +0 -184
  562. data/lib/stripe/resources/gift_cards/card.rb +0 -208
  563. data/lib/stripe/resources/gift_cards/transaction.rb +0 -272
  564. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
  565. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
  566. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
  567. data/lib/stripe/resources/issuing/settlement.rb +0 -53
  568. data/lib/stripe/resources/margin.rb +0 -115
  569. data/lib/stripe/resources/order.rb +0 -2859
  570. data/lib/stripe/resources/payment_attempt_record.rb +0 -1078
  571. data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +0 -65
  572. data/lib/stripe/resources/payment_record.rb +0 -1607
  573. data/lib/stripe/resources/privacy/redaction_job.rb +0 -275
  574. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -25
  575. data/lib/stripe/resources/quote_line.rb +0 -274
  576. data/lib/stripe/resources/quote_preview_invoice.rb +0 -663
  577. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -339
  578. data/lib/stripe/resources/tax/association.rb +0 -89
  579. data/lib/stripe/resources/tax/form.rb +0 -211
  580. data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
  581. data/lib/stripe/resources/v2/core/account.rb +0 -1746
  582. data/lib/stripe/resources/v2/core/account_link.rb +0 -56
  583. data/lib/stripe/resources/v2/core/person.rb +0 -276
  584. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -74
  585. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -39
  586. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -20
  587. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -22
  588. data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -51
  589. data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -58
  590. data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -68
  591. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -94
  592. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -129
  593. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -82
  594. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -45
  595. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -117
  596. data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -75
  597. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -49
  598. data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -136
  599. data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -108
  600. data/lib/stripe/resources/v2/money_management/transaction.rb +0 -78
  601. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -68
  602. data/lib/stripe/services/account_notice_service.rb +0 -101
  603. data/lib/stripe/services/balance_settings_service.rb +0 -96
  604. data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
  605. data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
  606. data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
  607. data/lib/stripe/services/capital_service.rb +0 -15
  608. data/lib/stripe/services/fx_quote_service.rb +0 -123
  609. data/lib/stripe/services/gift_cards/card_service.rb +0 -170
  610. data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
  611. data/lib/stripe/services/gift_cards_service.rb +0 -14
  612. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
  613. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
  614. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
  615. data/lib/stripe/services/margin_service.rb +0 -119
  616. data/lib/stripe/services/order_service.rb +0 -2268
  617. data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
  618. data/lib/stripe/services/payment_record_service.rb +0 -542
  619. data/lib/stripe/services/privacy/redaction_job_service.rb +0 -231
  620. data/lib/stripe/services/privacy_service.rb +0 -13
  621. data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
  622. data/lib/stripe/services/tax/association_service.rb +0 -31
  623. data/lib/stripe/services/tax/form_service.rb +0 -100
  624. data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
  625. data/lib/stripe/services/v2/core/account_link_service.rb +0 -76
  626. data/lib/stripe/services/v2/core/account_service.rb +0 -4138
  627. data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1048
  628. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -135
  629. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -109
  630. data/lib/stripe/services/v2/core/vault_service.rb +0 -18
  631. data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -75
  632. data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -44
  633. data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -81
  634. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -126
  635. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -96
  636. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -202
  637. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -237
  638. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -174
  639. data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -95
  640. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
  641. data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -71
  642. data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -44
  643. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -70
  644. data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -74
  645. data/lib/stripe/services/v2/money_management_service.rb +0 -31
  646. data/lib/stripe/services/v2/test_helper_service.rb +0 -15
  647. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -50
  648. data/rbi/stripe.rbi +0 -191867
@@ -0,0 +1,2069 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # typed: true
5
+ module Stripe
6
+ # The `Charge` object represents a single attempt to move money into your Stripe account.
7
+ # PaymentIntent confirmation is the most common way to create Charges, but transferring
8
+ # money to a different Stripe account through Connect also creates Charges.
9
+ # Some legacy payment flows create Charges directly, which is not recommended for new integrations.
10
+ class Charge < APIResource
11
+ class BillingDetails < Stripe::StripeObject
12
+ class Address < Stripe::StripeObject
13
+ # City, district, suburb, town, or village.
14
+ sig { returns(T.nilable(String)) }
15
+ attr_reader :city
16
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
17
+ sig { returns(T.nilable(String)) }
18
+ attr_reader :country
19
+ # Address line 1 (e.g., street, PO Box, or company name).
20
+ sig { returns(T.nilable(String)) }
21
+ attr_reader :line1
22
+ # Address line 2 (e.g., apartment, suite, unit, or building).
23
+ sig { returns(T.nilable(String)) }
24
+ attr_reader :line2
25
+ # ZIP or postal code.
26
+ sig { returns(T.nilable(String)) }
27
+ attr_reader :postal_code
28
+ # State, county, province, or region.
29
+ sig { returns(T.nilable(String)) }
30
+ attr_reader :state
31
+ end
32
+ # Billing address.
33
+ sig { returns(T.nilable(Address)) }
34
+ attr_reader :address
35
+ # Email address.
36
+ sig { returns(T.nilable(String)) }
37
+ attr_reader :email
38
+ # Full name.
39
+ sig { returns(T.nilable(String)) }
40
+ attr_reader :name
41
+ # Billing phone number (including extension).
42
+ sig { returns(T.nilable(String)) }
43
+ attr_reader :phone
44
+ # Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
45
+ sig { returns(T.nilable(String)) }
46
+ attr_reader :tax_id
47
+ end
48
+ class FraudDetails < Stripe::StripeObject
49
+ # Assessments from Stripe. If set, the value is `fraudulent`.
50
+ sig { returns(String) }
51
+ attr_reader :stripe_report
52
+ # Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.
53
+ sig { returns(String) }
54
+ attr_reader :user_report
55
+ end
56
+ class Level3 < Stripe::StripeObject
57
+ class LineItem < Stripe::StripeObject
58
+ # Attribute for field discount_amount
59
+ sig { returns(T.nilable(Integer)) }
60
+ attr_reader :discount_amount
61
+ # Attribute for field product_code
62
+ sig { returns(String) }
63
+ attr_reader :product_code
64
+ # Attribute for field product_description
65
+ sig { returns(String) }
66
+ attr_reader :product_description
67
+ # Attribute for field quantity
68
+ sig { returns(T.nilable(Integer)) }
69
+ attr_reader :quantity
70
+ # Attribute for field tax_amount
71
+ sig { returns(T.nilable(Integer)) }
72
+ attr_reader :tax_amount
73
+ # Attribute for field unit_cost
74
+ sig { returns(T.nilable(Integer)) }
75
+ attr_reader :unit_cost
76
+ end
77
+ # Attribute for field customer_reference
78
+ sig { returns(String) }
79
+ attr_reader :customer_reference
80
+ # Attribute for field line_items
81
+ sig { returns(T::Array[LineItem]) }
82
+ attr_reader :line_items
83
+ # Attribute for field merchant_reference
84
+ sig { returns(String) }
85
+ attr_reader :merchant_reference
86
+ # Attribute for field shipping_address_zip
87
+ sig { returns(String) }
88
+ attr_reader :shipping_address_zip
89
+ # Attribute for field shipping_amount
90
+ sig { returns(Integer) }
91
+ attr_reader :shipping_amount
92
+ # Attribute for field shipping_from_zip
93
+ sig { returns(String) }
94
+ attr_reader :shipping_from_zip
95
+ end
96
+ class Outcome < Stripe::StripeObject
97
+ class Rule < Stripe::StripeObject
98
+ # The action taken on the payment.
99
+ sig { returns(String) }
100
+ attr_reader :action
101
+ # Unique identifier for the object.
102
+ sig { returns(String) }
103
+ attr_reader :id
104
+ # The predicate to evaluate the payment against.
105
+ sig { returns(String) }
106
+ attr_reader :predicate
107
+ end
108
+ # An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).
109
+ sig { returns(T.nilable(String)) }
110
+ attr_reader :advice_code
111
+ # For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
112
+ sig { returns(T.nilable(String)) }
113
+ attr_reader :network_advice_code
114
+ # For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
115
+ sig { returns(T.nilable(String)) }
116
+ attr_reader :network_decline_code
117
+ # Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
118
+ sig { returns(T.nilable(String)) }
119
+ attr_reader :network_status
120
+ # An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
121
+ sig { returns(T.nilable(String)) }
122
+ attr_reader :reason
123
+ # Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.
124
+ sig { returns(String) }
125
+ attr_reader :risk_level
126
+ # Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.
127
+ sig { returns(Integer) }
128
+ attr_reader :risk_score
129
+ # The ID of the Radar rule that matched the payment, if applicable.
130
+ sig { returns(T.any(String, Rule)) }
131
+ attr_reader :rule
132
+ # A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
133
+ sig { returns(T.nilable(String)) }
134
+ attr_reader :seller_message
135
+ # Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.
136
+ sig { returns(String) }
137
+ attr_reader :type
138
+ end
139
+ class PaymentMethodDetails < Stripe::StripeObject
140
+ class AchCreditTransfer < Stripe::StripeObject
141
+ # Account number to transfer funds to.
142
+ sig { returns(T.nilable(String)) }
143
+ attr_reader :account_number
144
+ # Name of the bank associated with the routing number.
145
+ sig { returns(T.nilable(String)) }
146
+ attr_reader :bank_name
147
+ # Routing transit number for the bank account to transfer funds to.
148
+ sig { returns(T.nilable(String)) }
149
+ attr_reader :routing_number
150
+ # SWIFT code of the bank associated with the routing number.
151
+ sig { returns(T.nilable(String)) }
152
+ attr_reader :swift_code
153
+ end
154
+ class AchDebit < Stripe::StripeObject
155
+ # Type of entity that holds the account. This can be either `individual` or `company`.
156
+ sig { returns(T.nilable(String)) }
157
+ attr_reader :account_holder_type
158
+ # Name of the bank associated with the bank account.
159
+ sig { returns(T.nilable(String)) }
160
+ attr_reader :bank_name
161
+ # Two-letter ISO code representing the country the bank account is located in.
162
+ sig { returns(T.nilable(String)) }
163
+ attr_reader :country
164
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
165
+ sig { returns(T.nilable(String)) }
166
+ attr_reader :fingerprint
167
+ # Last four digits of the bank account number.
168
+ sig { returns(T.nilable(String)) }
169
+ attr_reader :last4
170
+ # Routing transit number of the bank account.
171
+ sig { returns(T.nilable(String)) }
172
+ attr_reader :routing_number
173
+ end
174
+ class AcssDebit < Stripe::StripeObject
175
+ # Name of the bank associated with the bank account.
176
+ sig { returns(T.nilable(String)) }
177
+ attr_reader :bank_name
178
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
179
+ sig { returns(T.nilable(String)) }
180
+ attr_reader :fingerprint
181
+ # Institution number of the bank account
182
+ sig { returns(T.nilable(String)) }
183
+ attr_reader :institution_number
184
+ # Last four digits of the bank account number.
185
+ sig { returns(T.nilable(String)) }
186
+ attr_reader :last4
187
+ # ID of the mandate used to make this payment.
188
+ sig { returns(String) }
189
+ attr_reader :mandate
190
+ # Transit number of the bank account.
191
+ sig { returns(T.nilable(String)) }
192
+ attr_reader :transit_number
193
+ end
194
+ class Affirm < Stripe::StripeObject
195
+ # ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
196
+ sig { returns(String) }
197
+ attr_reader :location
198
+ # ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
199
+ sig { returns(String) }
200
+ attr_reader :reader
201
+ # The Affirm transaction ID associated with this payment.
202
+ sig { returns(T.nilable(String)) }
203
+ attr_reader :transaction_id
204
+ end
205
+ class AfterpayClearpay < Stripe::StripeObject
206
+ # The Afterpay order ID associated with this payment intent.
207
+ sig { returns(T.nilable(String)) }
208
+ attr_reader :order_id
209
+ # Order identifier shown to the merchant in Afterpay’s online portal.
210
+ sig { returns(T.nilable(String)) }
211
+ attr_reader :reference
212
+ end
213
+ class Alipay < Stripe::StripeObject
214
+ # Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
215
+ sig { returns(String) }
216
+ attr_reader :buyer_id
217
+ # Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
218
+ sig { returns(T.nilable(String)) }
219
+ attr_reader :fingerprint
220
+ # Transaction ID of this particular Alipay transaction.
221
+ sig { returns(T.nilable(String)) }
222
+ attr_reader :transaction_id
223
+ end
224
+ class Alma < Stripe::StripeObject; end
225
+ class AmazonPay < Stripe::StripeObject
226
+ class Funding < Stripe::StripeObject
227
+ class Card < Stripe::StripeObject
228
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
229
+ sig { returns(T.nilable(String)) }
230
+ attr_reader :brand
231
+ # 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.
232
+ sig { returns(T.nilable(String)) }
233
+ attr_reader :country
234
+ # Two-digit number representing the card's expiration month.
235
+ sig { returns(T.nilable(Integer)) }
236
+ attr_reader :exp_month
237
+ # Four-digit number representing the card's expiration year.
238
+ sig { returns(T.nilable(Integer)) }
239
+ attr_reader :exp_year
240
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
241
+ sig { returns(T.nilable(String)) }
242
+ attr_reader :funding
243
+ # The last four digits of the card.
244
+ sig { returns(T.nilable(String)) }
245
+ attr_reader :last4
246
+ end
247
+ # Attribute for field card
248
+ sig { returns(Card) }
249
+ attr_reader :card
250
+ # funding type of the underlying payment method.
251
+ sig { returns(T.nilable(String)) }
252
+ attr_reader :type
253
+ end
254
+ # Attribute for field funding
255
+ sig { returns(Funding) }
256
+ attr_reader :funding
257
+ end
258
+ class AuBecsDebit < Stripe::StripeObject
259
+ # Bank-State-Branch number of the bank account.
260
+ sig { returns(T.nilable(String)) }
261
+ attr_reader :bsb_number
262
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
263
+ sig { returns(T.nilable(String)) }
264
+ attr_reader :fingerprint
265
+ # Last four digits of the bank account number.
266
+ sig { returns(T.nilable(String)) }
267
+ attr_reader :last4
268
+ # ID of the mandate used to make this payment.
269
+ sig { returns(String) }
270
+ attr_reader :mandate
271
+ end
272
+ class BacsDebit < Stripe::StripeObject
273
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
274
+ sig { returns(T.nilable(String)) }
275
+ attr_reader :fingerprint
276
+ # Last four digits of the bank account number.
277
+ sig { returns(T.nilable(String)) }
278
+ attr_reader :last4
279
+ # ID of the mandate used to make this payment.
280
+ sig { returns(T.nilable(String)) }
281
+ attr_reader :mandate
282
+ # Sort code of the bank account. (e.g., `10-20-30`)
283
+ sig { returns(T.nilable(String)) }
284
+ attr_reader :sort_code
285
+ end
286
+ class Bancontact < Stripe::StripeObject
287
+ # Bank code of bank associated with the bank account.
288
+ sig { returns(T.nilable(String)) }
289
+ attr_reader :bank_code
290
+ # Name of the bank associated with the bank account.
291
+ sig { returns(T.nilable(String)) }
292
+ attr_reader :bank_name
293
+ # Bank Identifier Code of the bank associated with the bank account.
294
+ sig { returns(T.nilable(String)) }
295
+ attr_reader :bic
296
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
297
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
298
+ attr_reader :generated_sepa_debit
299
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
300
+ sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
301
+ attr_reader :generated_sepa_debit_mandate
302
+ # Last four characters of the IBAN.
303
+ sig { returns(T.nilable(String)) }
304
+ attr_reader :iban_last4
305
+ # Preferred language of the Bancontact authorization page that the customer is redirected to.
306
+ # Can be one of `en`, `de`, `fr`, or `nl`
307
+ sig { returns(T.nilable(String)) }
308
+ attr_reader :preferred_language
309
+ # Owner's verified full name. Values are verified or provided by Bancontact directly
310
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
311
+ sig { returns(T.nilable(String)) }
312
+ attr_reader :verified_name
313
+ end
314
+ class Billie < Stripe::StripeObject; end
315
+ class Blik < Stripe::StripeObject
316
+ # A unique and immutable identifier assigned by BLIK to every buyer.
317
+ sig { returns(T.nilable(String)) }
318
+ attr_reader :buyer_id
319
+ end
320
+ class Boleto < Stripe::StripeObject
321
+ # The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
322
+ sig { returns(String) }
323
+ attr_reader :tax_id
324
+ end
325
+ class Card < Stripe::StripeObject
326
+ class Checks < Stripe::StripeObject
327
+ # If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
328
+ sig { returns(T.nilable(String)) }
329
+ attr_reader :address_line1_check
330
+ # If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
331
+ sig { returns(T.nilable(String)) }
332
+ attr_reader :address_postal_code_check
333
+ # If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
334
+ sig { returns(T.nilable(String)) }
335
+ attr_reader :cvc_check
336
+ end
337
+ class ExtendedAuthorization < Stripe::StripeObject
338
+ # Indicates whether or not the capture window is extended beyond the standard authorization.
339
+ sig { returns(String) }
340
+ attr_reader :status
341
+ end
342
+ class IncrementalAuthorization < Stripe::StripeObject
343
+ # Indicates whether or not the incremental authorization feature is supported.
344
+ sig { returns(String) }
345
+ attr_reader :status
346
+ end
347
+ class Installments < Stripe::StripeObject
348
+ class Plan < Stripe::StripeObject
349
+ # For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
350
+ sig { returns(T.nilable(Integer)) }
351
+ attr_reader :count
352
+ # For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
353
+ # One of `month`.
354
+ sig { returns(T.nilable(String)) }
355
+ attr_reader :interval
356
+ # Type of installment plan, one of `fixed_count`.
357
+ sig { returns(String) }
358
+ attr_reader :type
359
+ end
360
+ # Installment plan selected for the payment.
361
+ sig { returns(T.nilable(Plan)) }
362
+ attr_reader :plan
363
+ end
364
+ class Multicapture < Stripe::StripeObject
365
+ # Indicates whether or not multiple captures are supported.
366
+ sig { returns(String) }
367
+ attr_reader :status
368
+ end
369
+ class NetworkToken < Stripe::StripeObject
370
+ # Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
371
+ sig { returns(T::Boolean) }
372
+ attr_reader :used
373
+ end
374
+ class Overcapture < Stripe::StripeObject
375
+ # The maximum amount that can be captured.
376
+ sig { returns(Integer) }
377
+ attr_reader :maximum_amount_capturable
378
+ # Indicates whether or not the authorized amount can be over-captured.
379
+ sig { returns(String) }
380
+ attr_reader :status
381
+ end
382
+ class ThreeDSecure < Stripe::StripeObject
383
+ # For authenticated transactions: how the customer was authenticated by
384
+ # the issuing bank.
385
+ sig { returns(T.nilable(String)) }
386
+ attr_reader :authentication_flow
387
+ # The Electronic Commerce Indicator (ECI). A protocol-level field
388
+ # indicating what degree of authentication was performed.
389
+ sig { returns(T.nilable(String)) }
390
+ attr_reader :electronic_commerce_indicator
391
+ # The exemption requested via 3DS and accepted by the issuer at authentication time.
392
+ sig { returns(T.nilable(String)) }
393
+ attr_reader :exemption_indicator
394
+ # Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on
395
+ # the outcome of Stripe's internal risk assessment.
396
+ sig { returns(T::Boolean) }
397
+ attr_reader :exemption_indicator_applied
398
+ # Indicates the outcome of 3D Secure authentication.
399
+ sig { returns(T.nilable(String)) }
400
+ attr_reader :result
401
+ # Additional information about why 3D Secure succeeded or failed based
402
+ # on the `result`.
403
+ sig { returns(T.nilable(String)) }
404
+ attr_reader :result_reason
405
+ # The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
406
+ # (dsTransId) for this payment.
407
+ sig { returns(T.nilable(String)) }
408
+ attr_reader :transaction_id
409
+ # The version of 3D Secure that was used.
410
+ sig { returns(T.nilable(String)) }
411
+ attr_reader :version
412
+ end
413
+ class Wallet < Stripe::StripeObject
414
+ class AmexExpressCheckout < Stripe::StripeObject; end
415
+ class ApplePay < Stripe::StripeObject; end
416
+ class GooglePay < Stripe::StripeObject; end
417
+ class Link < Stripe::StripeObject; end
418
+ class Masterpass < Stripe::StripeObject
419
+ class BillingAddress < Stripe::StripeObject
420
+ # City, district, suburb, town, or village.
421
+ sig { returns(T.nilable(String)) }
422
+ attr_reader :city
423
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
424
+ sig { returns(T.nilable(String)) }
425
+ attr_reader :country
426
+ # Address line 1 (e.g., street, PO Box, or company name).
427
+ sig { returns(T.nilable(String)) }
428
+ attr_reader :line1
429
+ # Address line 2 (e.g., apartment, suite, unit, or building).
430
+ sig { returns(T.nilable(String)) }
431
+ attr_reader :line2
432
+ # ZIP or postal code.
433
+ sig { returns(T.nilable(String)) }
434
+ attr_reader :postal_code
435
+ # State, county, province, or region.
436
+ sig { returns(T.nilable(String)) }
437
+ attr_reader :state
438
+ end
439
+ class ShippingAddress < Stripe::StripeObject
440
+ # City, district, suburb, town, or village.
441
+ sig { returns(T.nilable(String)) }
442
+ attr_reader :city
443
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
444
+ sig { returns(T.nilable(String)) }
445
+ attr_reader :country
446
+ # Address line 1 (e.g., street, PO Box, or company name).
447
+ sig { returns(T.nilable(String)) }
448
+ attr_reader :line1
449
+ # Address line 2 (e.g., apartment, suite, unit, or building).
450
+ sig { returns(T.nilable(String)) }
451
+ attr_reader :line2
452
+ # ZIP or postal code.
453
+ sig { returns(T.nilable(String)) }
454
+ attr_reader :postal_code
455
+ # State, county, province, or region.
456
+ sig { returns(T.nilable(String)) }
457
+ attr_reader :state
458
+ end
459
+ # Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
460
+ sig { returns(T.nilable(BillingAddress)) }
461
+ attr_reader :billing_address
462
+ # Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
463
+ sig { returns(T.nilable(String)) }
464
+ attr_reader :email
465
+ # Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
466
+ sig { returns(T.nilable(String)) }
467
+ attr_reader :name
468
+ # Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
469
+ sig { returns(T.nilable(ShippingAddress)) }
470
+ attr_reader :shipping_address
471
+ end
472
+ class SamsungPay < Stripe::StripeObject; end
473
+ class VisaCheckout < Stripe::StripeObject
474
+ class BillingAddress < Stripe::StripeObject
475
+ # City, district, suburb, town, or village.
476
+ sig { returns(T.nilable(String)) }
477
+ attr_reader :city
478
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
479
+ sig { returns(T.nilable(String)) }
480
+ attr_reader :country
481
+ # Address line 1 (e.g., street, PO Box, or company name).
482
+ sig { returns(T.nilable(String)) }
483
+ attr_reader :line1
484
+ # Address line 2 (e.g., apartment, suite, unit, or building).
485
+ sig { returns(T.nilable(String)) }
486
+ attr_reader :line2
487
+ # ZIP or postal code.
488
+ sig { returns(T.nilable(String)) }
489
+ attr_reader :postal_code
490
+ # State, county, province, or region.
491
+ sig { returns(T.nilable(String)) }
492
+ attr_reader :state
493
+ end
494
+ class ShippingAddress < Stripe::StripeObject
495
+ # City, district, suburb, town, or village.
496
+ sig { returns(T.nilable(String)) }
497
+ attr_reader :city
498
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
499
+ sig { returns(T.nilable(String)) }
500
+ attr_reader :country
501
+ # Address line 1 (e.g., street, PO Box, or company name).
502
+ sig { returns(T.nilable(String)) }
503
+ attr_reader :line1
504
+ # Address line 2 (e.g., apartment, suite, unit, or building).
505
+ sig { returns(T.nilable(String)) }
506
+ attr_reader :line2
507
+ # ZIP or postal code.
508
+ sig { returns(T.nilable(String)) }
509
+ attr_reader :postal_code
510
+ # State, county, province, or region.
511
+ sig { returns(T.nilable(String)) }
512
+ attr_reader :state
513
+ end
514
+ # Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
515
+ sig { returns(T.nilable(BillingAddress)) }
516
+ attr_reader :billing_address
517
+ # Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
518
+ sig { returns(T.nilable(String)) }
519
+ attr_reader :email
520
+ # Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
521
+ sig { returns(T.nilable(String)) }
522
+ attr_reader :name
523
+ # Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
524
+ sig { returns(T.nilable(ShippingAddress)) }
525
+ attr_reader :shipping_address
526
+ end
527
+ # Attribute for field amex_express_checkout
528
+ sig { returns(AmexExpressCheckout) }
529
+ attr_reader :amex_express_checkout
530
+ # Attribute for field apple_pay
531
+ sig { returns(ApplePay) }
532
+ attr_reader :apple_pay
533
+ # (For tokenized numbers only.) The last four digits of the device account number.
534
+ sig { returns(T.nilable(String)) }
535
+ attr_reader :dynamic_last4
536
+ # Attribute for field google_pay
537
+ sig { returns(GooglePay) }
538
+ attr_reader :google_pay
539
+ # Attribute for field link
540
+ sig { returns(Link) }
541
+ attr_reader :link
542
+ # Attribute for field masterpass
543
+ sig { returns(Masterpass) }
544
+ attr_reader :masterpass
545
+ # Attribute for field samsung_pay
546
+ sig { returns(SamsungPay) }
547
+ attr_reader :samsung_pay
548
+ # The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
549
+ sig { returns(String) }
550
+ attr_reader :type
551
+ # Attribute for field visa_checkout
552
+ sig { returns(VisaCheckout) }
553
+ attr_reader :visa_checkout
554
+ end
555
+ # The authorized amount.
556
+ sig { returns(T.nilable(Integer)) }
557
+ attr_reader :amount_authorized
558
+ # Authorization code on the charge.
559
+ sig { returns(T.nilable(String)) }
560
+ attr_reader :authorization_code
561
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
562
+ sig { returns(T.nilable(String)) }
563
+ attr_reader :brand
564
+ # When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
565
+ sig { returns(Integer) }
566
+ attr_reader :capture_before
567
+ # Check results by Card networks on Card address and CVC at time of payment.
568
+ sig { returns(T.nilable(Checks)) }
569
+ attr_reader :checks
570
+ # 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.
571
+ sig { returns(T.nilable(String)) }
572
+ attr_reader :country
573
+ # 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.)
574
+ sig { returns(T.nilable(String)) }
575
+ attr_reader :description
576
+ # Two-digit number representing the card's expiration month.
577
+ sig { returns(Integer) }
578
+ attr_reader :exp_month
579
+ # Four-digit number representing the card's expiration year.
580
+ sig { returns(Integer) }
581
+ attr_reader :exp_year
582
+ # Attribute for field extended_authorization
583
+ sig { returns(ExtendedAuthorization) }
584
+ attr_reader :extended_authorization
585
+ # 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.
586
+ #
587
+ # *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.*
588
+ sig { returns(T.nilable(String)) }
589
+ attr_reader :fingerprint
590
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
591
+ sig { returns(T.nilable(String)) }
592
+ attr_reader :funding
593
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
594
+ sig { returns(T.nilable(String)) }
595
+ attr_reader :iin
596
+ # Attribute for field incremental_authorization
597
+ sig { returns(IncrementalAuthorization) }
598
+ attr_reader :incremental_authorization
599
+ # Installment details for this payment (Mexico only).
600
+ #
601
+ # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
602
+ sig { returns(T.nilable(Installments)) }
603
+ attr_reader :installments
604
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
605
+ sig { returns(T.nilable(String)) }
606
+ attr_reader :issuer
607
+ # The last four digits of the card.
608
+ sig { returns(T.nilable(String)) }
609
+ attr_reader :last4
610
+ # ID of the mandate used to make this payment or created by it.
611
+ sig { returns(T.nilable(String)) }
612
+ attr_reader :mandate
613
+ # True if this payment was marked as MOTO and out of scope for SCA.
614
+ sig { returns(T.nilable(T::Boolean)) }
615
+ attr_reader :moto
616
+ # Attribute for field multicapture
617
+ sig { returns(Multicapture) }
618
+ attr_reader :multicapture
619
+ # 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`.
620
+ sig { returns(T.nilable(String)) }
621
+ attr_reader :network
622
+ # If this card has network token credentials, this contains the details of the network token credentials.
623
+ sig { returns(T.nilable(NetworkToken)) }
624
+ attr_reader :network_token
625
+ # 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.
626
+ sig { returns(T.nilable(String)) }
627
+ attr_reader :network_transaction_id
628
+ # Attribute for field overcapture
629
+ sig { returns(Overcapture) }
630
+ attr_reader :overcapture
631
+ # Status of a card based on the card issuer.
632
+ sig { returns(T.nilable(String)) }
633
+ attr_reader :regulated_status
634
+ # Populated if this transaction used 3D Secure authentication.
635
+ sig { returns(T.nilable(ThreeDSecure)) }
636
+ attr_reader :three_d_secure
637
+ # If this Card is part of a card wallet, this contains the details of the card wallet.
638
+ sig { returns(T.nilable(Wallet)) }
639
+ attr_reader :wallet
640
+ end
641
+ class CardPresent < Stripe::StripeObject
642
+ class Offline < Stripe::StripeObject
643
+ # Time at which the payment was collected while offline
644
+ sig { returns(T.nilable(Integer)) }
645
+ attr_reader :stored_at
646
+ # The method used to process this payment method offline. Only deferred is allowed.
647
+ sig { returns(T.nilable(String)) }
648
+ attr_reader :type
649
+ end
650
+ class Receipt < Stripe::StripeObject
651
+ # The type of account being debited or credited
652
+ sig { returns(String) }
653
+ attr_reader :account_type
654
+ # EMV tag 9F26, cryptogram generated by the integrated circuit chip.
655
+ sig { returns(T.nilable(String)) }
656
+ attr_reader :application_cryptogram
657
+ # Mnenomic of the Application Identifier.
658
+ sig { returns(T.nilable(String)) }
659
+ attr_reader :application_preferred_name
660
+ # Identifier for this transaction.
661
+ sig { returns(T.nilable(String)) }
662
+ attr_reader :authorization_code
663
+ # EMV tag 8A. A code returned by the card issuer.
664
+ sig { returns(T.nilable(String)) }
665
+ attr_reader :authorization_response_code
666
+ # 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`.
667
+ sig { returns(T.nilable(String)) }
668
+ attr_reader :cardholder_verification_method
669
+ # EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
670
+ sig { returns(T.nilable(String)) }
671
+ attr_reader :dedicated_file_name
672
+ # The outcome of a series of EMV functions performed by the card reader.
673
+ sig { returns(T.nilable(String)) }
674
+ attr_reader :terminal_verification_results
675
+ # An indication of various EMV functions performed during the transaction.
676
+ sig { returns(T.nilable(String)) }
677
+ attr_reader :transaction_status_information
678
+ end
679
+ class Wallet < Stripe::StripeObject
680
+ # The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
681
+ sig { returns(String) }
682
+ attr_reader :type
683
+ end
684
+ # The authorized amount
685
+ sig { returns(T.nilable(Integer)) }
686
+ attr_reader :amount_authorized
687
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
688
+ sig { returns(T.nilable(String)) }
689
+ attr_reader :brand
690
+ # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
691
+ sig { returns(T.nilable(String)) }
692
+ attr_reader :brand_product
693
+ # When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
694
+ sig { returns(Integer) }
695
+ attr_reader :capture_before
696
+ # 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.
697
+ sig { returns(T.nilable(String)) }
698
+ attr_reader :cardholder_name
699
+ # 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.
700
+ sig { returns(T.nilable(String)) }
701
+ attr_reader :country
702
+ # 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.)
703
+ sig { returns(T.nilable(String)) }
704
+ attr_reader :description
705
+ # Authorization response cryptogram.
706
+ sig { returns(T.nilable(String)) }
707
+ attr_reader :emv_auth_data
708
+ # Two-digit number representing the card's expiration month.
709
+ sig { returns(Integer) }
710
+ attr_reader :exp_month
711
+ # Four-digit number representing the card's expiration year.
712
+ sig { returns(Integer) }
713
+ attr_reader :exp_year
714
+ # 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.
715
+ #
716
+ # *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.*
717
+ sig { returns(T.nilable(String)) }
718
+ attr_reader :fingerprint
719
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
720
+ sig { returns(T.nilable(String)) }
721
+ attr_reader :funding
722
+ # 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.
723
+ sig { returns(T.nilable(String)) }
724
+ attr_reader :generated_card
725
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
726
+ sig { returns(T.nilable(String)) }
727
+ attr_reader :iin
728
+ # 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).
729
+ sig { returns(T::Boolean) }
730
+ attr_reader :incremental_authorization_supported
731
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
732
+ sig { returns(T.nilable(String)) }
733
+ attr_reader :issuer
734
+ # The last four digits of the card.
735
+ sig { returns(T.nilable(String)) }
736
+ attr_reader :last4
737
+ # 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`.
738
+ sig { returns(T.nilable(String)) }
739
+ attr_reader :network
740
+ # 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.
741
+ sig { returns(T.nilable(String)) }
742
+ attr_reader :network_transaction_id
743
+ # Details about payments collected offline.
744
+ sig { returns(T.nilable(Offline)) }
745
+ attr_reader :offline
746
+ # Defines whether the authorized amount can be over-captured or not
747
+ sig { returns(T::Boolean) }
748
+ attr_reader :overcapture_supported
749
+ # EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
750
+ sig { returns(T.nilable(T::Array[String])) }
751
+ attr_reader :preferred_locales
752
+ # How card details were read in this transaction.
753
+ sig { returns(T.nilable(String)) }
754
+ attr_reader :read_method
755
+ # A collection of fields required to be displayed on receipts. Only required for EMV transactions.
756
+ sig { returns(T.nilable(Receipt)) }
757
+ attr_reader :receipt
758
+ # Attribute for field wallet
759
+ sig { returns(Wallet) }
760
+ attr_reader :wallet
761
+ end
762
+ class Cashapp < Stripe::StripeObject
763
+ # A unique and immutable identifier assigned by Cash App to every buyer.
764
+ sig { returns(T.nilable(String)) }
765
+ attr_reader :buyer_id
766
+ # A public identifier for buyers using Cash App.
767
+ sig { returns(T.nilable(String)) }
768
+ attr_reader :cashtag
769
+ end
770
+ class CustomerBalance < Stripe::StripeObject; end
771
+ class Eps < Stripe::StripeObject
772
+ # 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`.
773
+ sig { returns(T.nilable(String)) }
774
+ attr_reader :bank
775
+ # Owner's verified full name. Values are verified or provided by EPS directly
776
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
777
+ # EPS rarely provides this information so the attribute is usually empty.
778
+ sig { returns(T.nilable(String)) }
779
+ attr_reader :verified_name
780
+ end
781
+ class Fpx < Stripe::StripeObject
782
+ # Account holder type, if provided. Can be one of `individual` or `company`.
783
+ sig { returns(T.nilable(String)) }
784
+ attr_reader :account_holder_type
785
+ # 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`.
786
+ sig { returns(String) }
787
+ attr_reader :bank
788
+ # Unique transaction id generated by FPX for every request from the merchant
789
+ sig { returns(T.nilable(String)) }
790
+ attr_reader :transaction_id
791
+ end
792
+ class Giropay < Stripe::StripeObject
793
+ # Bank code of bank associated with the bank account.
794
+ sig { returns(T.nilable(String)) }
795
+ attr_reader :bank_code
796
+ # Name of the bank associated with the bank account.
797
+ sig { returns(T.nilable(String)) }
798
+ attr_reader :bank_name
799
+ # Bank Identifier Code of the bank associated with the bank account.
800
+ sig { returns(T.nilable(String)) }
801
+ attr_reader :bic
802
+ # Owner's verified full name. Values are verified or provided by Giropay directly
803
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
804
+ # Giropay rarely provides this information so the attribute is usually empty.
805
+ sig { returns(T.nilable(String)) }
806
+ attr_reader :verified_name
807
+ end
808
+ class Grabpay < Stripe::StripeObject
809
+ # Unique transaction id generated by GrabPay
810
+ sig { returns(T.nilable(String)) }
811
+ attr_reader :transaction_id
812
+ end
813
+ class Ideal < Stripe::StripeObject
814
+ # 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`.
815
+ sig { returns(T.nilable(String)) }
816
+ attr_reader :bank
817
+ # The Bank Identifier Code of the customer's bank.
818
+ sig { returns(T.nilable(String)) }
819
+ attr_reader :bic
820
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
821
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
822
+ attr_reader :generated_sepa_debit
823
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
824
+ sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
825
+ attr_reader :generated_sepa_debit_mandate
826
+ # Last four characters of the IBAN.
827
+ sig { returns(T.nilable(String)) }
828
+ attr_reader :iban_last4
829
+ # Owner's verified full name. Values are verified or provided by iDEAL directly
830
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
831
+ sig { returns(T.nilable(String)) }
832
+ attr_reader :verified_name
833
+ end
834
+ class InteracPresent < Stripe::StripeObject
835
+ class Receipt < Stripe::StripeObject
836
+ # The type of account being debited or credited
837
+ sig { returns(String) }
838
+ attr_reader :account_type
839
+ # EMV tag 9F26, cryptogram generated by the integrated circuit chip.
840
+ sig { returns(T.nilable(String)) }
841
+ attr_reader :application_cryptogram
842
+ # Mnenomic of the Application Identifier.
843
+ sig { returns(T.nilable(String)) }
844
+ attr_reader :application_preferred_name
845
+ # Identifier for this transaction.
846
+ sig { returns(T.nilable(String)) }
847
+ attr_reader :authorization_code
848
+ # EMV tag 8A. A code returned by the card issuer.
849
+ sig { returns(T.nilable(String)) }
850
+ attr_reader :authorization_response_code
851
+ # 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`.
852
+ sig { returns(T.nilable(String)) }
853
+ attr_reader :cardholder_verification_method
854
+ # EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
855
+ sig { returns(T.nilable(String)) }
856
+ attr_reader :dedicated_file_name
857
+ # The outcome of a series of EMV functions performed by the card reader.
858
+ sig { returns(T.nilable(String)) }
859
+ attr_reader :terminal_verification_results
860
+ # An indication of various EMV functions performed during the transaction.
861
+ sig { returns(T.nilable(String)) }
862
+ attr_reader :transaction_status_information
863
+ end
864
+ # Card brand. Can be `interac`, `mastercard` or `visa`.
865
+ sig { returns(T.nilable(String)) }
866
+ attr_reader :brand
867
+ # 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.
868
+ sig { returns(T.nilable(String)) }
869
+ attr_reader :cardholder_name
870
+ # 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.
871
+ sig { returns(T.nilable(String)) }
872
+ attr_reader :country
873
+ # 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.)
874
+ sig { returns(T.nilable(String)) }
875
+ attr_reader :description
876
+ # Authorization response cryptogram.
877
+ sig { returns(T.nilable(String)) }
878
+ attr_reader :emv_auth_data
879
+ # Two-digit number representing the card's expiration month.
880
+ sig { returns(Integer) }
881
+ attr_reader :exp_month
882
+ # Four-digit number representing the card's expiration year.
883
+ sig { returns(Integer) }
884
+ attr_reader :exp_year
885
+ # 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.
886
+ #
887
+ # *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.*
888
+ sig { returns(T.nilable(String)) }
889
+ attr_reader :fingerprint
890
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
891
+ sig { returns(T.nilable(String)) }
892
+ attr_reader :funding
893
+ # 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.
894
+ sig { returns(T.nilable(String)) }
895
+ attr_reader :generated_card
896
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
897
+ sig { returns(T.nilable(String)) }
898
+ attr_reader :iin
899
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
900
+ sig { returns(T.nilable(String)) }
901
+ attr_reader :issuer
902
+ # The last four digits of the card.
903
+ sig { returns(T.nilable(String)) }
904
+ attr_reader :last4
905
+ # 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`.
906
+ sig { returns(T.nilable(String)) }
907
+ attr_reader :network
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
+ sig { returns(T.nilable(String)) }
910
+ attr_reader :network_transaction_id
911
+ # EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
912
+ sig { returns(T.nilable(T::Array[String])) }
913
+ attr_reader :preferred_locales
914
+ # How card details were read in this transaction.
915
+ sig { returns(T.nilable(String)) }
916
+ attr_reader :read_method
917
+ # A collection of fields required to be displayed on receipts. Only required for EMV transactions.
918
+ sig { returns(T.nilable(Receipt)) }
919
+ attr_reader :receipt
920
+ end
921
+ class KakaoPay < Stripe::StripeObject
922
+ # A unique identifier for the buyer as determined by the local payment processor.
923
+ sig { returns(T.nilable(String)) }
924
+ attr_reader :buyer_id
925
+ end
926
+ class Klarna < Stripe::StripeObject
927
+ class PayerDetails < Stripe::StripeObject
928
+ class Address < Stripe::StripeObject
929
+ # The payer address country
930
+ sig { returns(T.nilable(String)) }
931
+ attr_reader :country
932
+ end
933
+ # The payer's address
934
+ sig { returns(T.nilable(Address)) }
935
+ attr_reader :address
936
+ end
937
+ # The payer details for this transaction.
938
+ sig { returns(T.nilable(PayerDetails)) }
939
+ attr_reader :payer_details
940
+ # The Klarna payment method used for this transaction.
941
+ # Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
942
+ sig { returns(T.nilable(String)) }
943
+ attr_reader :payment_method_category
944
+ # Preferred language of the Klarna authorization page that the customer is redirected to.
945
+ # 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`
946
+ sig { returns(T.nilable(String)) }
947
+ attr_reader :preferred_locale
948
+ end
949
+ class Konbini < Stripe::StripeObject
950
+ class Store < Stripe::StripeObject
951
+ # The name of the convenience store chain where the payment was completed.
952
+ sig { returns(T.nilable(String)) }
953
+ attr_reader :chain
954
+ end
955
+ # If the payment succeeded, this contains the details of the convenience store where the payment was completed.
956
+ sig { returns(T.nilable(Store)) }
957
+ attr_reader :store
958
+ end
959
+ class KrCard < Stripe::StripeObject
960
+ # The local credit or debit card brand.
961
+ sig { returns(T.nilable(String)) }
962
+ attr_reader :brand
963
+ # A unique identifier for the buyer as determined by the local payment processor.
964
+ sig { returns(T.nilable(String)) }
965
+ attr_reader :buyer_id
966
+ # The last four digits of the card. This may not be present for American Express cards.
967
+ sig { returns(T.nilable(String)) }
968
+ attr_reader :last4
969
+ end
970
+ class Link < Stripe::StripeObject
971
+ # Two-letter ISO code representing the funding source country beneath the Link payment.
972
+ # You could use this attribute to get a sense of international fees.
973
+ sig { returns(T.nilable(String)) }
974
+ attr_reader :country
975
+ end
976
+ class Mobilepay < Stripe::StripeObject
977
+ class Card < Stripe::StripeObject
978
+ # Brand of the card used in the transaction
979
+ sig { returns(T.nilable(String)) }
980
+ attr_reader :brand
981
+ # Two-letter ISO code representing the country of the card
982
+ sig { returns(T.nilable(String)) }
983
+ attr_reader :country
984
+ # Two digit number representing the card's expiration month
985
+ sig { returns(T.nilable(Integer)) }
986
+ attr_reader :exp_month
987
+ # Two digit number representing the card's expiration year
988
+ sig { returns(T.nilable(Integer)) }
989
+ attr_reader :exp_year
990
+ # The last 4 digits of the card
991
+ sig { returns(T.nilable(String)) }
992
+ attr_reader :last4
993
+ end
994
+ # Internal card details
995
+ sig { returns(T.nilable(Card)) }
996
+ attr_reader :card
997
+ end
998
+ class Multibanco < Stripe::StripeObject
999
+ # Entity number associated with this Multibanco payment.
1000
+ sig { returns(T.nilable(String)) }
1001
+ attr_reader :entity
1002
+ # Reference number associated with this Multibanco payment.
1003
+ sig { returns(T.nilable(String)) }
1004
+ attr_reader :reference
1005
+ end
1006
+ class NaverPay < Stripe::StripeObject
1007
+ # A unique identifier for the buyer as determined by the local payment processor.
1008
+ sig { returns(T.nilable(String)) }
1009
+ attr_reader :buyer_id
1010
+ end
1011
+ class NzBankAccount < Stripe::StripeObject
1012
+ # 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.
1013
+ sig { returns(T.nilable(String)) }
1014
+ attr_reader :account_holder_name
1015
+ # The numeric code for the bank account's bank.
1016
+ sig { returns(String) }
1017
+ attr_reader :bank_code
1018
+ # The name of the bank.
1019
+ sig { returns(String) }
1020
+ attr_reader :bank_name
1021
+ # The numeric code for the bank account's bank branch.
1022
+ sig { returns(String) }
1023
+ attr_reader :branch_code
1024
+ # Last four digits of the bank account number.
1025
+ sig { returns(String) }
1026
+ attr_reader :last4
1027
+ # The suffix of the bank account number.
1028
+ sig { returns(T.nilable(String)) }
1029
+ attr_reader :suffix
1030
+ end
1031
+ class Oxxo < Stripe::StripeObject
1032
+ # OXXO reference number
1033
+ sig { returns(T.nilable(String)) }
1034
+ attr_reader :number
1035
+ end
1036
+ class P24 < Stripe::StripeObject
1037
+ # 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`.
1038
+ sig { returns(T.nilable(String)) }
1039
+ attr_reader :bank
1040
+ # Unique reference for this Przelewy24 payment.
1041
+ sig { returns(T.nilable(String)) }
1042
+ attr_reader :reference
1043
+ # Owner's verified full name. Values are verified or provided by Przelewy24 directly
1044
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1045
+ # Przelewy24 rarely provides this information so the attribute is usually empty.
1046
+ sig { returns(T.nilable(String)) }
1047
+ attr_reader :verified_name
1048
+ end
1049
+ class PayByBank < Stripe::StripeObject; end
1050
+ class Payco < Stripe::StripeObject
1051
+ # A unique identifier for the buyer as determined by the local payment processor.
1052
+ sig { returns(T.nilable(String)) }
1053
+ attr_reader :buyer_id
1054
+ end
1055
+ class Paynow < Stripe::StripeObject
1056
+ # Reference number associated with this PayNow payment
1057
+ sig { returns(T.nilable(String)) }
1058
+ attr_reader :reference
1059
+ end
1060
+ class Paypal < Stripe::StripeObject
1061
+ class SellerProtection < Stripe::StripeObject
1062
+ # An array of conditions that are covered for the transaction, if applicable.
1063
+ sig { returns(T.nilable(T::Array[String])) }
1064
+ attr_reader :dispute_categories
1065
+ # Indicates whether the transaction is eligible for PayPal's seller protection.
1066
+ sig { returns(String) }
1067
+ attr_reader :status
1068
+ end
1069
+ # 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.
1070
+ sig { returns(T.nilable(String)) }
1071
+ attr_reader :country
1072
+ # Owner's email. Values are provided by PayPal directly
1073
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1074
+ sig { returns(T.nilable(String)) }
1075
+ attr_reader :payer_email
1076
+ # PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
1077
+ sig { returns(T.nilable(String)) }
1078
+ attr_reader :payer_id
1079
+ # Owner's full name. Values provided by PayPal directly
1080
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1081
+ sig { returns(T.nilable(String)) }
1082
+ attr_reader :payer_name
1083
+ # The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
1084
+ sig { returns(T.nilable(SellerProtection)) }
1085
+ attr_reader :seller_protection
1086
+ # A unique ID generated by PayPal for this transaction.
1087
+ sig { returns(T.nilable(String)) }
1088
+ attr_reader :transaction_id
1089
+ end
1090
+ class Pix < Stripe::StripeObject
1091
+ # Unique transaction id generated by BCB
1092
+ sig { returns(T.nilable(String)) }
1093
+ attr_reader :bank_transaction_id
1094
+ end
1095
+ class Promptpay < Stripe::StripeObject
1096
+ # Bill reference generated by PromptPay
1097
+ sig { returns(T.nilable(String)) }
1098
+ attr_reader :reference
1099
+ end
1100
+ class RevolutPay < Stripe::StripeObject
1101
+ class Funding < Stripe::StripeObject
1102
+ class Card < Stripe::StripeObject
1103
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
1104
+ sig { returns(T.nilable(String)) }
1105
+ attr_reader :brand
1106
+ # 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.
1107
+ sig { returns(T.nilable(String)) }
1108
+ attr_reader :country
1109
+ # Two-digit number representing the card's expiration month.
1110
+ sig { returns(T.nilable(Integer)) }
1111
+ attr_reader :exp_month
1112
+ # Four-digit number representing the card's expiration year.
1113
+ sig { returns(T.nilable(Integer)) }
1114
+ attr_reader :exp_year
1115
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
1116
+ sig { returns(T.nilable(String)) }
1117
+ attr_reader :funding
1118
+ # The last four digits of the card.
1119
+ sig { returns(T.nilable(String)) }
1120
+ attr_reader :last4
1121
+ end
1122
+ # Attribute for field card
1123
+ sig { returns(Card) }
1124
+ attr_reader :card
1125
+ # funding type of the underlying payment method.
1126
+ sig { returns(T.nilable(String)) }
1127
+ attr_reader :type
1128
+ end
1129
+ # Attribute for field funding
1130
+ sig { returns(Funding) }
1131
+ attr_reader :funding
1132
+ end
1133
+ class SamsungPay < Stripe::StripeObject
1134
+ # A unique identifier for the buyer as determined by the local payment processor.
1135
+ sig { returns(T.nilable(String)) }
1136
+ attr_reader :buyer_id
1137
+ end
1138
+ class Satispay < Stripe::StripeObject; end
1139
+ class SepaCreditTransfer < Stripe::StripeObject
1140
+ # Name of the bank associated with the bank account.
1141
+ sig { returns(T.nilable(String)) }
1142
+ attr_reader :bank_name
1143
+ # Bank Identifier Code of the bank associated with the bank account.
1144
+ sig { returns(T.nilable(String)) }
1145
+ attr_reader :bic
1146
+ # IBAN of the bank account to transfer funds to.
1147
+ sig { returns(T.nilable(String)) }
1148
+ attr_reader :iban
1149
+ end
1150
+ class SepaDebit < Stripe::StripeObject
1151
+ # Bank code of bank associated with the bank account.
1152
+ sig { returns(T.nilable(String)) }
1153
+ attr_reader :bank_code
1154
+ # Branch code of bank associated with the bank account.
1155
+ sig { returns(T.nilable(String)) }
1156
+ attr_reader :branch_code
1157
+ # Two-letter ISO code representing the country the bank account is located in.
1158
+ sig { returns(T.nilable(String)) }
1159
+ attr_reader :country
1160
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
1161
+ sig { returns(T.nilable(String)) }
1162
+ attr_reader :fingerprint
1163
+ # Last four characters of the IBAN.
1164
+ sig { returns(T.nilable(String)) }
1165
+ attr_reader :last4
1166
+ # 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).
1167
+ sig { returns(T.nilable(String)) }
1168
+ attr_reader :mandate
1169
+ end
1170
+ class Sofort < Stripe::StripeObject
1171
+ # Bank code of bank associated with the bank account.
1172
+ sig { returns(T.nilable(String)) }
1173
+ attr_reader :bank_code
1174
+ # Name of the bank associated with the bank account.
1175
+ sig { returns(T.nilable(String)) }
1176
+ attr_reader :bank_name
1177
+ # Bank Identifier Code of the bank associated with the bank account.
1178
+ sig { returns(T.nilable(String)) }
1179
+ attr_reader :bic
1180
+ # Two-letter ISO code representing the country the bank account is located in.
1181
+ sig { returns(T.nilable(String)) }
1182
+ attr_reader :country
1183
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
1184
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
1185
+ attr_reader :generated_sepa_debit
1186
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
1187
+ sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
1188
+ attr_reader :generated_sepa_debit_mandate
1189
+ # Last four characters of the IBAN.
1190
+ sig { returns(T.nilable(String)) }
1191
+ attr_reader :iban_last4
1192
+ # Preferred language of the SOFORT authorization page that the customer is redirected to.
1193
+ # Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
1194
+ sig { returns(T.nilable(String)) }
1195
+ attr_reader :preferred_language
1196
+ # Owner's verified full name. Values are verified or provided by SOFORT directly
1197
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
1198
+ sig { returns(T.nilable(String)) }
1199
+ attr_reader :verified_name
1200
+ end
1201
+ class StripeAccount < Stripe::StripeObject; end
1202
+ class Swish < Stripe::StripeObject
1203
+ # 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
1204
+ sig { returns(T.nilable(String)) }
1205
+ attr_reader :fingerprint
1206
+ # Payer bank reference number for the payment
1207
+ sig { returns(T.nilable(String)) }
1208
+ attr_reader :payment_reference
1209
+ # The last four digits of the Swish account phone number
1210
+ sig { returns(T.nilable(String)) }
1211
+ attr_reader :verified_phone_last4
1212
+ end
1213
+ class Twint < Stripe::StripeObject; end
1214
+ class UsBankAccount < Stripe::StripeObject
1215
+ # Account holder type: individual or company.
1216
+ sig { returns(T.nilable(String)) }
1217
+ attr_reader :account_holder_type
1218
+ # Account type: checkings or savings. Defaults to checking if omitted.
1219
+ sig { returns(T.nilable(String)) }
1220
+ attr_reader :account_type
1221
+ # Name of the bank associated with the bank account.
1222
+ sig { returns(T.nilable(String)) }
1223
+ attr_reader :bank_name
1224
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
1225
+ sig { returns(T.nilable(String)) }
1226
+ attr_reader :fingerprint
1227
+ # Last four digits of the bank account number.
1228
+ sig { returns(T.nilable(String)) }
1229
+ attr_reader :last4
1230
+ # ID of the mandate used to make this payment.
1231
+ sig { returns(T.any(String, Stripe::Mandate)) }
1232
+ attr_reader :mandate
1233
+ # Reference number to locate ACH payments with customer's bank.
1234
+ sig { returns(T.nilable(String)) }
1235
+ attr_reader :payment_reference
1236
+ # Routing number of the bank account.
1237
+ sig { returns(T.nilable(String)) }
1238
+ attr_reader :routing_number
1239
+ end
1240
+ class Wechat < Stripe::StripeObject; end
1241
+ class WechatPay < Stripe::StripeObject
1242
+ # Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
1243
+ sig { returns(T.nilable(String)) }
1244
+ attr_reader :fingerprint
1245
+ # ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
1246
+ sig { returns(String) }
1247
+ attr_reader :location
1248
+ # ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
1249
+ sig { returns(String) }
1250
+ attr_reader :reader
1251
+ # Transaction ID of this particular WeChat Pay transaction.
1252
+ sig { returns(T.nilable(String)) }
1253
+ attr_reader :transaction_id
1254
+ end
1255
+ class Zip < Stripe::StripeObject; end
1256
+ # Attribute for field ach_credit_transfer
1257
+ sig { returns(AchCreditTransfer) }
1258
+ attr_reader :ach_credit_transfer
1259
+ # Attribute for field ach_debit
1260
+ sig { returns(AchDebit) }
1261
+ attr_reader :ach_debit
1262
+ # Attribute for field acss_debit
1263
+ sig { returns(AcssDebit) }
1264
+ attr_reader :acss_debit
1265
+ # Attribute for field affirm
1266
+ sig { returns(Affirm) }
1267
+ attr_reader :affirm
1268
+ # Attribute for field afterpay_clearpay
1269
+ sig { returns(AfterpayClearpay) }
1270
+ attr_reader :afterpay_clearpay
1271
+ # Attribute for field alipay
1272
+ sig { returns(Alipay) }
1273
+ attr_reader :alipay
1274
+ # Attribute for field alma
1275
+ sig { returns(Alma) }
1276
+ attr_reader :alma
1277
+ # Attribute for field amazon_pay
1278
+ sig { returns(AmazonPay) }
1279
+ attr_reader :amazon_pay
1280
+ # Attribute for field au_becs_debit
1281
+ sig { returns(AuBecsDebit) }
1282
+ attr_reader :au_becs_debit
1283
+ # Attribute for field bacs_debit
1284
+ sig { returns(BacsDebit) }
1285
+ attr_reader :bacs_debit
1286
+ # Attribute for field bancontact
1287
+ sig { returns(Bancontact) }
1288
+ attr_reader :bancontact
1289
+ # Attribute for field billie
1290
+ sig { returns(Billie) }
1291
+ attr_reader :billie
1292
+ # Attribute for field blik
1293
+ sig { returns(Blik) }
1294
+ attr_reader :blik
1295
+ # Attribute for field boleto
1296
+ sig { returns(Boleto) }
1297
+ attr_reader :boleto
1298
+ # Attribute for field card
1299
+ sig { returns(Card) }
1300
+ attr_reader :card
1301
+ # Attribute for field card_present
1302
+ sig { returns(CardPresent) }
1303
+ attr_reader :card_present
1304
+ # Attribute for field cashapp
1305
+ sig { returns(Cashapp) }
1306
+ attr_reader :cashapp
1307
+ # Attribute for field customer_balance
1308
+ sig { returns(CustomerBalance) }
1309
+ attr_reader :customer_balance
1310
+ # Attribute for field eps
1311
+ sig { returns(Eps) }
1312
+ attr_reader :eps
1313
+ # Attribute for field fpx
1314
+ sig { returns(Fpx) }
1315
+ attr_reader :fpx
1316
+ # Attribute for field giropay
1317
+ sig { returns(Giropay) }
1318
+ attr_reader :giropay
1319
+ # Attribute for field grabpay
1320
+ sig { returns(Grabpay) }
1321
+ attr_reader :grabpay
1322
+ # Attribute for field ideal
1323
+ sig { returns(Ideal) }
1324
+ attr_reader :ideal
1325
+ # Attribute for field interac_present
1326
+ sig { returns(InteracPresent) }
1327
+ attr_reader :interac_present
1328
+ # Attribute for field kakao_pay
1329
+ sig { returns(KakaoPay) }
1330
+ attr_reader :kakao_pay
1331
+ # Attribute for field klarna
1332
+ sig { returns(Klarna) }
1333
+ attr_reader :klarna
1334
+ # Attribute for field konbini
1335
+ sig { returns(Konbini) }
1336
+ attr_reader :konbini
1337
+ # Attribute for field kr_card
1338
+ sig { returns(KrCard) }
1339
+ attr_reader :kr_card
1340
+ # Attribute for field link
1341
+ sig { returns(Link) }
1342
+ attr_reader :link
1343
+ # Attribute for field mobilepay
1344
+ sig { returns(Mobilepay) }
1345
+ attr_reader :mobilepay
1346
+ # Attribute for field multibanco
1347
+ sig { returns(Multibanco) }
1348
+ attr_reader :multibanco
1349
+ # Attribute for field naver_pay
1350
+ sig { returns(NaverPay) }
1351
+ attr_reader :naver_pay
1352
+ # Attribute for field nz_bank_account
1353
+ sig { returns(NzBankAccount) }
1354
+ attr_reader :nz_bank_account
1355
+ # Attribute for field oxxo
1356
+ sig { returns(Oxxo) }
1357
+ attr_reader :oxxo
1358
+ # Attribute for field p24
1359
+ sig { returns(P24) }
1360
+ attr_reader :p24
1361
+ # Attribute for field pay_by_bank
1362
+ sig { returns(PayByBank) }
1363
+ attr_reader :pay_by_bank
1364
+ # Attribute for field payco
1365
+ sig { returns(Payco) }
1366
+ attr_reader :payco
1367
+ # Attribute for field paynow
1368
+ sig { returns(Paynow) }
1369
+ attr_reader :paynow
1370
+ # Attribute for field paypal
1371
+ sig { returns(Paypal) }
1372
+ attr_reader :paypal
1373
+ # Attribute for field pix
1374
+ sig { returns(Pix) }
1375
+ attr_reader :pix
1376
+ # Attribute for field promptpay
1377
+ sig { returns(Promptpay) }
1378
+ attr_reader :promptpay
1379
+ # Attribute for field revolut_pay
1380
+ sig { returns(RevolutPay) }
1381
+ attr_reader :revolut_pay
1382
+ # Attribute for field samsung_pay
1383
+ sig { returns(SamsungPay) }
1384
+ attr_reader :samsung_pay
1385
+ # Attribute for field satispay
1386
+ sig { returns(Satispay) }
1387
+ attr_reader :satispay
1388
+ # Attribute for field sepa_credit_transfer
1389
+ sig { returns(SepaCreditTransfer) }
1390
+ attr_reader :sepa_credit_transfer
1391
+ # Attribute for field sepa_debit
1392
+ sig { returns(SepaDebit) }
1393
+ attr_reader :sepa_debit
1394
+ # Attribute for field sofort
1395
+ sig { returns(Sofort) }
1396
+ attr_reader :sofort
1397
+ # Attribute for field stripe_account
1398
+ sig { returns(StripeAccount) }
1399
+ attr_reader :stripe_account
1400
+ # Attribute for field swish
1401
+ sig { returns(Swish) }
1402
+ attr_reader :swish
1403
+ # Attribute for field twint
1404
+ sig { returns(Twint) }
1405
+ attr_reader :twint
1406
+ # 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.
1407
+ # An additional hash is included on `payment_method_details` with a name matching this value.
1408
+ # It contains information specific to the payment method.
1409
+ sig { returns(String) }
1410
+ attr_reader :type
1411
+ # Attribute for field us_bank_account
1412
+ sig { returns(UsBankAccount) }
1413
+ attr_reader :us_bank_account
1414
+ # Attribute for field wechat
1415
+ sig { returns(Wechat) }
1416
+ attr_reader :wechat
1417
+ # Attribute for field wechat_pay
1418
+ sig { returns(WechatPay) }
1419
+ attr_reader :wechat_pay
1420
+ # Attribute for field zip
1421
+ sig { returns(Zip) }
1422
+ attr_reader :zip
1423
+ end
1424
+ class PresentmentDetails < Stripe::StripeObject
1425
+ # Amount intended to be collected by this payment, denominated in presentment_currency.
1426
+ sig { returns(Integer) }
1427
+ attr_reader :presentment_amount
1428
+ # Currency presented to the customer during payment.
1429
+ sig { returns(String) }
1430
+ attr_reader :presentment_currency
1431
+ end
1432
+ class RadarOptions < Stripe::StripeObject
1433
+ # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
1434
+ sig { returns(String) }
1435
+ attr_reader :session
1436
+ end
1437
+ class Shipping < Stripe::StripeObject
1438
+ class Address < Stripe::StripeObject
1439
+ # City, district, suburb, town, or village.
1440
+ sig { returns(T.nilable(String)) }
1441
+ attr_reader :city
1442
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1443
+ sig { returns(T.nilable(String)) }
1444
+ attr_reader :country
1445
+ # Address line 1 (e.g., street, PO Box, or company name).
1446
+ sig { returns(T.nilable(String)) }
1447
+ attr_reader :line1
1448
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1449
+ sig { returns(T.nilable(String)) }
1450
+ attr_reader :line2
1451
+ # ZIP or postal code.
1452
+ sig { returns(T.nilable(String)) }
1453
+ attr_reader :postal_code
1454
+ # State, county, province, or region.
1455
+ sig { returns(T.nilable(String)) }
1456
+ attr_reader :state
1457
+ end
1458
+ # Attribute for field address
1459
+ sig { returns(Address) }
1460
+ attr_reader :address
1461
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1462
+ sig { returns(T.nilable(String)) }
1463
+ attr_reader :carrier
1464
+ # Recipient name.
1465
+ sig { returns(String) }
1466
+ attr_reader :name
1467
+ # Recipient phone (including extension).
1468
+ sig { returns(T.nilable(String)) }
1469
+ attr_reader :phone
1470
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
1471
+ sig { returns(T.nilable(String)) }
1472
+ attr_reader :tracking_number
1473
+ end
1474
+ class TransferData < Stripe::StripeObject
1475
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1476
+ sig { returns(T.nilable(Integer)) }
1477
+ attr_reader :amount
1478
+ # ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.
1479
+ sig { returns(T.any(String, Stripe::Account)) }
1480
+ attr_reader :destination
1481
+ end
1482
+ # Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
1483
+ sig { returns(Integer) }
1484
+ attr_reader :amount
1485
+ # Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
1486
+ sig { returns(Integer) }
1487
+ attr_reader :amount_captured
1488
+ # Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
1489
+ sig { returns(Integer) }
1490
+ attr_reader :amount_refunded
1491
+ # ID of the Connect application that created the charge.
1492
+ sig { returns(T.nilable(T.any(String, Stripe::Application))) }
1493
+ attr_reader :application
1494
+ # The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
1495
+ sig { returns(T.nilable(T.any(String, Stripe::ApplicationFee))) }
1496
+ attr_reader :application_fee
1497
+ # The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
1498
+ sig { returns(T.nilable(Integer)) }
1499
+ attr_reader :application_fee_amount
1500
+ # Authorization code on the charge.
1501
+ sig { returns(String) }
1502
+ attr_reader :authorization_code
1503
+ # ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
1504
+ sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
1505
+ attr_reader :balance_transaction
1506
+ # Attribute for field billing_details
1507
+ sig { returns(BillingDetails) }
1508
+ attr_reader :billing_details
1509
+ # The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.
1510
+ sig { returns(T.nilable(String)) }
1511
+ attr_reader :calculated_statement_descriptor
1512
+ # If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
1513
+ sig { returns(T::Boolean) }
1514
+ attr_reader :captured
1515
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
1516
+ sig { returns(Integer) }
1517
+ attr_reader :created
1518
+ # 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).
1519
+ sig { returns(String) }
1520
+ attr_reader :currency
1521
+ # ID of the customer this charge is for if one exists.
1522
+ sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
1523
+ attr_reader :customer
1524
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1525
+ sig { returns(T.nilable(String)) }
1526
+ attr_reader :description
1527
+ # Whether the charge has been disputed.
1528
+ sig { returns(T::Boolean) }
1529
+ attr_reader :disputed
1530
+ # ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
1531
+ sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
1532
+ attr_reader :failure_balance_transaction
1533
+ # Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).
1534
+ sig { returns(T.nilable(String)) }
1535
+ attr_reader :failure_code
1536
+ # Message to user further explaining reason for charge failure if available.
1537
+ sig { returns(T.nilable(String)) }
1538
+ attr_reader :failure_message
1539
+ # Information on fraud assessments for the charge.
1540
+ sig { returns(T.nilable(FraudDetails)) }
1541
+ attr_reader :fraud_details
1542
+ # Unique identifier for the object.
1543
+ sig { returns(String) }
1544
+ attr_reader :id
1545
+ # Attribute for field level3
1546
+ sig { returns(Level3) }
1547
+ attr_reader :level3
1548
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1549
+ sig { returns(T::Boolean) }
1550
+ attr_reader :livemode
1551
+ # 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.
1552
+ sig { returns(T::Hash[String, String]) }
1553
+ attr_reader :metadata
1554
+ # String representing the object's type. Objects of the same type share the same value.
1555
+ sig { returns(String) }
1556
+ attr_reader :object
1557
+ # The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
1558
+ sig { returns(T.nilable(T.any(String, Stripe::Account))) }
1559
+ attr_reader :on_behalf_of
1560
+ # Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
1561
+ sig { returns(T.nilable(Outcome)) }
1562
+ attr_reader :outcome
1563
+ # `true` if the charge succeeded, or was successfully authorized for later capture.
1564
+ sig { returns(T::Boolean) }
1565
+ attr_reader :paid
1566
+ # ID of the PaymentIntent associated with this charge, if one exists.
1567
+ sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
1568
+ attr_reader :payment_intent
1569
+ # ID of the payment method used in this charge.
1570
+ sig { returns(T.nilable(String)) }
1571
+ attr_reader :payment_method
1572
+ # Details about the payment method at the time of the transaction.
1573
+ sig { returns(T.nilable(PaymentMethodDetails)) }
1574
+ attr_reader :payment_method_details
1575
+ # Attribute for field presentment_details
1576
+ sig { returns(PresentmentDetails) }
1577
+ attr_reader :presentment_details
1578
+ # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1579
+ sig { returns(RadarOptions) }
1580
+ attr_reader :radar_options
1581
+ # This is the email address that the receipt for this charge was sent to.
1582
+ sig { returns(T.nilable(String)) }
1583
+ attr_reader :receipt_email
1584
+ # This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.
1585
+ sig { returns(T.nilable(String)) }
1586
+ attr_reader :receipt_number
1587
+ # This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
1588
+ sig { returns(T.nilable(String)) }
1589
+ attr_reader :receipt_url
1590
+ # Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
1591
+ sig { returns(T::Boolean) }
1592
+ attr_reader :refunded
1593
+ # A list of refunds that have been applied to the charge.
1594
+ sig { returns(T.nilable(Stripe::ListObject)) }
1595
+ attr_reader :refunds
1596
+ # ID of the review associated with this charge if one exists.
1597
+ sig { returns(T.nilable(T.any(String, Stripe::Review))) }
1598
+ attr_reader :review
1599
+ # Shipping information for the charge.
1600
+ sig { returns(T.nilable(Shipping)) }
1601
+ attr_reader :shipping
1602
+ # This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead.
1603
+ sig {
1604
+ returns(T.nilable(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)))
1605
+ }
1606
+ attr_reader :source
1607
+ # The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
1608
+ sig { returns(T.nilable(T.any(String, Stripe::Transfer))) }
1609
+ attr_reader :source_transfer
1610
+ # For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
1611
+ #
1612
+ # For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
1613
+ sig { returns(T.nilable(String)) }
1614
+ attr_reader :statement_descriptor
1615
+ # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
1616
+ sig { returns(T.nilable(String)) }
1617
+ attr_reader :statement_descriptor_suffix
1618
+ # The status of the payment is either `succeeded`, `pending`, or `failed`.
1619
+ sig { returns(String) }
1620
+ attr_reader :status
1621
+ # ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
1622
+ sig { returns(T.any(String, Stripe::Transfer)) }
1623
+ attr_reader :transfer
1624
+ # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
1625
+ sig { returns(T.nilable(TransferData)) }
1626
+ attr_reader :transfer_data
1627
+ # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
1628
+ sig { returns(T.nilable(String)) }
1629
+ attr_reader :transfer_group
1630
+ class ListParams < Stripe::RequestParams
1631
+ class Created < Stripe::RequestParams
1632
+ # Minimum value to filter by (exclusive)
1633
+ sig { returns(T.nilable(Integer)) }
1634
+ attr_accessor :gt
1635
+ # Minimum value to filter by (inclusive)
1636
+ sig { returns(T.nilable(Integer)) }
1637
+ attr_accessor :gte
1638
+ # Maximum value to filter by (exclusive)
1639
+ sig { returns(T.nilable(Integer)) }
1640
+ attr_accessor :lt
1641
+ # Maximum value to filter by (inclusive)
1642
+ sig { returns(T.nilable(Integer)) }
1643
+ attr_accessor :lte
1644
+ sig {
1645
+ params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
1646
+ }
1647
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
1648
+ end
1649
+ # Only return charges that were created during the given date interval.
1650
+ sig { returns(T.nilable(T.any(::Stripe::Charge::ListParams::Created, Integer))) }
1651
+ attr_accessor :created
1652
+ # Only return charges for the customer specified by this customer ID.
1653
+ sig { returns(T.nilable(String)) }
1654
+ attr_accessor :customer
1655
+ # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
1656
+ sig { returns(T.nilable(String)) }
1657
+ attr_accessor :ending_before
1658
+ # Specifies which fields in the response should be expanded.
1659
+ sig { returns(T.nilable(T::Array[String])) }
1660
+ attr_accessor :expand
1661
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1662
+ sig { returns(T.nilable(Integer)) }
1663
+ attr_accessor :limit
1664
+ # Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
1665
+ sig { returns(T.nilable(String)) }
1666
+ attr_accessor :payment_intent
1667
+ # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
1668
+ sig { returns(T.nilable(String)) }
1669
+ attr_accessor :starting_after
1670
+ # Only return charges for this transfer group, limited to 100.
1671
+ sig { returns(T.nilable(String)) }
1672
+ attr_accessor :transfer_group
1673
+ sig {
1674
+ params(created: T.nilable(T.any(::Stripe::Charge::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_intent: T.nilable(String), starting_after: T.nilable(String), transfer_group: T.nilable(String)).void
1675
+ }
1676
+ def initialize(
1677
+ created: nil,
1678
+ customer: nil,
1679
+ ending_before: nil,
1680
+ expand: nil,
1681
+ limit: nil,
1682
+ payment_intent: nil,
1683
+ starting_after: nil,
1684
+ transfer_group: nil
1685
+ ); end
1686
+ end
1687
+ class CreateParams < Stripe::RequestParams
1688
+ class Destination < Stripe::RequestParams
1689
+ # ID of an existing, connected Stripe account.
1690
+ sig { returns(String) }
1691
+ attr_accessor :account
1692
+ # The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount.
1693
+ sig { returns(T.nilable(Integer)) }
1694
+ attr_accessor :amount
1695
+ sig { params(account: String, amount: T.nilable(Integer)).void }
1696
+ def initialize(account: nil, amount: nil); end
1697
+ end
1698
+ class RadarOptions < Stripe::RequestParams
1699
+ # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
1700
+ sig { returns(T.nilable(String)) }
1701
+ attr_accessor :session
1702
+ sig { params(session: T.nilable(String)).void }
1703
+ def initialize(session: nil); end
1704
+ end
1705
+ class Shipping < Stripe::RequestParams
1706
+ class Address < Stripe::RequestParams
1707
+ # City, district, suburb, town, or village.
1708
+ sig { returns(T.nilable(String)) }
1709
+ attr_accessor :city
1710
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1711
+ sig { returns(T.nilable(String)) }
1712
+ attr_accessor :country
1713
+ # Address line 1 (e.g., street, PO Box, or company name).
1714
+ sig { returns(T.nilable(String)) }
1715
+ attr_accessor :line1
1716
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1717
+ sig { returns(T.nilable(String)) }
1718
+ attr_accessor :line2
1719
+ # ZIP or postal code.
1720
+ sig { returns(T.nilable(String)) }
1721
+ attr_accessor :postal_code
1722
+ # State, county, province, or region.
1723
+ sig { returns(T.nilable(String)) }
1724
+ attr_accessor :state
1725
+ sig {
1726
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
1727
+ }
1728
+ def initialize(
1729
+ city: nil,
1730
+ country: nil,
1731
+ line1: nil,
1732
+ line2: nil,
1733
+ postal_code: nil,
1734
+ state: nil
1735
+ ); end
1736
+ end
1737
+ # Shipping address.
1738
+ sig { returns(::Stripe::Charge::CreateParams::Shipping::Address) }
1739
+ attr_accessor :address
1740
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1741
+ sig { returns(T.nilable(String)) }
1742
+ attr_accessor :carrier
1743
+ # Recipient name.
1744
+ sig { returns(String) }
1745
+ attr_accessor :name
1746
+ # Recipient phone (including extension).
1747
+ sig { returns(T.nilable(String)) }
1748
+ attr_accessor :phone
1749
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
1750
+ sig { returns(T.nilable(String)) }
1751
+ attr_accessor :tracking_number
1752
+ sig {
1753
+ params(address: ::Stripe::Charge::CreateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
1754
+ }
1755
+ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
1756
+ end
1757
+ class TransferData < Stripe::RequestParams
1758
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1759
+ sig { returns(T.nilable(Integer)) }
1760
+ attr_accessor :amount
1761
+ # ID of an existing, connected Stripe account.
1762
+ sig { returns(String) }
1763
+ attr_accessor :destination
1764
+ sig { params(amount: T.nilable(Integer), destination: String).void }
1765
+ def initialize(amount: nil, destination: nil); end
1766
+ end
1767
+ # Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
1768
+ sig { returns(T.nilable(Integer)) }
1769
+ attr_accessor :amount
1770
+ # Attribute for param field application_fee
1771
+ sig { returns(T.nilable(Integer)) }
1772
+ attr_accessor :application_fee
1773
+ # A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).
1774
+ sig { returns(T.nilable(Integer)) }
1775
+ attr_accessor :application_fee_amount
1776
+ # Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
1777
+ sig { returns(T.nilable(T::Boolean)) }
1778
+ attr_accessor :capture
1779
+ # 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).
1780
+ sig { returns(T.nilable(String)) }
1781
+ attr_accessor :currency
1782
+ # The ID of an existing customer that will be charged in this request.
1783
+ sig { returns(T.nilable(String)) }
1784
+ attr_accessor :customer
1785
+ # An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
1786
+ sig { returns(T.nilable(String)) }
1787
+ attr_accessor :description
1788
+ # Attribute for param field destination
1789
+ sig { returns(T.nilable(::Stripe::Charge::CreateParams::Destination)) }
1790
+ attr_accessor :destination
1791
+ # Specifies which fields in the response should be expanded.
1792
+ sig { returns(T.nilable(T::Array[String])) }
1793
+ attr_accessor :expand
1794
+ # 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`.
1795
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1796
+ attr_accessor :metadata
1797
+ # The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).
1798
+ sig { returns(T.nilable(String)) }
1799
+ attr_accessor :on_behalf_of
1800
+ # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1801
+ sig { returns(T.nilable(::Stripe::Charge::CreateParams::RadarOptions)) }
1802
+ attr_accessor :radar_options
1803
+ # The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
1804
+ sig { returns(T.nilable(String)) }
1805
+ attr_accessor :receipt_email
1806
+ # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
1807
+ sig { returns(T.nilable(::Stripe::Charge::CreateParams::Shipping)) }
1808
+ attr_accessor :shipping
1809
+ # A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.
1810
+ sig { returns(T.nilable(String)) }
1811
+ attr_accessor :source
1812
+ # For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
1813
+ #
1814
+ # For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
1815
+ sig { returns(T.nilable(String)) }
1816
+ attr_accessor :statement_descriptor
1817
+ # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
1818
+ sig { returns(T.nilable(String)) }
1819
+ attr_accessor :statement_descriptor_suffix
1820
+ # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
1821
+ sig { returns(T.nilable(::Stripe::Charge::CreateParams::TransferData)) }
1822
+ attr_accessor :transfer_data
1823
+ # A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).
1824
+ sig { returns(T.nilable(String)) }
1825
+ attr_accessor :transfer_group
1826
+ sig {
1827
+ params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), capture: T.nilable(T::Boolean), currency: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), destination: T.nilable(::Stripe::Charge::CreateParams::Destination), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), on_behalf_of: T.nilable(String), radar_options: T.nilable(::Stripe::Charge::CreateParams::RadarOptions), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::Charge::CreateParams::Shipping), source: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Charge::CreateParams::TransferData), transfer_group: T.nilable(String)).void
1828
+ }
1829
+ def initialize(
1830
+ amount: nil,
1831
+ application_fee: nil,
1832
+ application_fee_amount: nil,
1833
+ capture: nil,
1834
+ currency: nil,
1835
+ customer: nil,
1836
+ description: nil,
1837
+ destination: nil,
1838
+ expand: nil,
1839
+ metadata: nil,
1840
+ on_behalf_of: nil,
1841
+ radar_options: nil,
1842
+ receipt_email: nil,
1843
+ shipping: nil,
1844
+ source: nil,
1845
+ statement_descriptor: nil,
1846
+ statement_descriptor_suffix: nil,
1847
+ transfer_data: nil,
1848
+ transfer_group: nil
1849
+ ); end
1850
+ end
1851
+ class UpdateParams < Stripe::RequestParams
1852
+ class FraudDetails < Stripe::RequestParams
1853
+ # Either `safe` or `fraudulent`.
1854
+ sig { returns(T.nilable(T.any(String, String))) }
1855
+ attr_accessor :user_report
1856
+ sig { params(user_report: T.nilable(T.any(String, String))).void }
1857
+ def initialize(user_report: nil); end
1858
+ end
1859
+ class Shipping < Stripe::RequestParams
1860
+ class Address < Stripe::RequestParams
1861
+ # City, district, suburb, town, or village.
1862
+ sig { returns(T.nilable(String)) }
1863
+ attr_accessor :city
1864
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1865
+ sig { returns(T.nilable(String)) }
1866
+ attr_accessor :country
1867
+ # Address line 1 (e.g., street, PO Box, or company name).
1868
+ sig { returns(T.nilable(String)) }
1869
+ attr_accessor :line1
1870
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1871
+ sig { returns(T.nilable(String)) }
1872
+ attr_accessor :line2
1873
+ # ZIP or postal code.
1874
+ sig { returns(T.nilable(String)) }
1875
+ attr_accessor :postal_code
1876
+ # State, county, province, or region.
1877
+ sig { returns(T.nilable(String)) }
1878
+ attr_accessor :state
1879
+ sig {
1880
+ params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
1881
+ }
1882
+ def initialize(
1883
+ city: nil,
1884
+ country: nil,
1885
+ line1: nil,
1886
+ line2: nil,
1887
+ postal_code: nil,
1888
+ state: nil
1889
+ ); end
1890
+ end
1891
+ # Shipping address.
1892
+ sig { returns(::Stripe::Charge::UpdateParams::Shipping::Address) }
1893
+ attr_accessor :address
1894
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1895
+ sig { returns(T.nilable(String)) }
1896
+ attr_accessor :carrier
1897
+ # Recipient name.
1898
+ sig { returns(String) }
1899
+ attr_accessor :name
1900
+ # Recipient phone (including extension).
1901
+ sig { returns(T.nilable(String)) }
1902
+ attr_accessor :phone
1903
+ # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
1904
+ sig { returns(T.nilable(String)) }
1905
+ attr_accessor :tracking_number
1906
+ sig {
1907
+ params(address: ::Stripe::Charge::UpdateParams::Shipping::Address, carrier: T.nilable(String), name: String, phone: T.nilable(String), tracking_number: T.nilable(String)).void
1908
+ }
1909
+ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil); end
1910
+ end
1911
+ # The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
1912
+ sig { returns(T.nilable(String)) }
1913
+ attr_accessor :customer
1914
+ # An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
1915
+ sig { returns(T.nilable(String)) }
1916
+ attr_accessor :description
1917
+ # Specifies which fields in the response should be expanded.
1918
+ sig { returns(T.nilable(T::Array[String])) }
1919
+ attr_accessor :expand
1920
+ # A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
1921
+ sig { returns(T.nilable(::Stripe::Charge::UpdateParams::FraudDetails)) }
1922
+ attr_accessor :fraud_details
1923
+ # 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`.
1924
+ sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
1925
+ attr_accessor :metadata
1926
+ # This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
1927
+ sig { returns(T.nilable(String)) }
1928
+ attr_accessor :receipt_email
1929
+ # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
1930
+ sig { returns(T.nilable(::Stripe::Charge::UpdateParams::Shipping)) }
1931
+ attr_accessor :shipping
1932
+ # A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
1933
+ sig { returns(T.nilable(String)) }
1934
+ attr_accessor :transfer_group
1935
+ sig {
1936
+ params(customer: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), fraud_details: T.nilable(::Stripe::Charge::UpdateParams::FraudDetails), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), receipt_email: T.nilable(String), shipping: T.nilable(::Stripe::Charge::UpdateParams::Shipping), transfer_group: T.nilable(String)).void
1937
+ }
1938
+ def initialize(
1939
+ customer: nil,
1940
+ description: nil,
1941
+ expand: nil,
1942
+ fraud_details: nil,
1943
+ metadata: nil,
1944
+ receipt_email: nil,
1945
+ shipping: nil,
1946
+ transfer_group: nil
1947
+ ); end
1948
+ end
1949
+ class SearchParams < Stripe::RequestParams
1950
+ # Specifies which fields in the response should be expanded.
1951
+ sig { returns(T.nilable(T::Array[String])) }
1952
+ attr_accessor :expand
1953
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1954
+ sig { returns(T.nilable(Integer)) }
1955
+ attr_accessor :limit
1956
+ # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
1957
+ sig { returns(T.nilable(String)) }
1958
+ attr_accessor :page
1959
+ # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).
1960
+ sig { returns(String) }
1961
+ attr_accessor :query
1962
+ sig {
1963
+ params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
1964
+ }
1965
+ def initialize(expand: nil, limit: nil, page: nil, query: nil); end
1966
+ end
1967
+ class CaptureParams < Stripe::RequestParams
1968
+ class TransferData < Stripe::RequestParams
1969
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1970
+ sig { returns(T.nilable(Integer)) }
1971
+ attr_accessor :amount
1972
+ sig { params(amount: T.nilable(Integer)).void }
1973
+ def initialize(amount: nil); end
1974
+ end
1975
+ # The amount to capture, which must be less than or equal to the original amount.
1976
+ sig { returns(T.nilable(Integer)) }
1977
+ attr_accessor :amount
1978
+ # An application fee to add on to this charge.
1979
+ sig { returns(T.nilable(Integer)) }
1980
+ attr_accessor :application_fee
1981
+ # An application fee amount to add on to this charge, which must be less than or equal to the original amount.
1982
+ sig { returns(T.nilable(Integer)) }
1983
+ attr_accessor :application_fee_amount
1984
+ # Specifies which fields in the response should be expanded.
1985
+ sig { returns(T.nilable(T::Array[String])) }
1986
+ attr_accessor :expand
1987
+ # The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
1988
+ sig { returns(T.nilable(String)) }
1989
+ attr_accessor :receipt_email
1990
+ # For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
1991
+ #
1992
+ # For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
1993
+ sig { returns(T.nilable(String)) }
1994
+ attr_accessor :statement_descriptor
1995
+ # Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
1996
+ sig { returns(T.nilable(String)) }
1997
+ attr_accessor :statement_descriptor_suffix
1998
+ # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
1999
+ sig { returns(T.nilable(::Stripe::Charge::CaptureParams::TransferData)) }
2000
+ attr_accessor :transfer_data
2001
+ # A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
2002
+ sig { returns(T.nilable(String)) }
2003
+ attr_accessor :transfer_group
2004
+ sig {
2005
+ params(amount: T.nilable(Integer), application_fee: T.nilable(Integer), application_fee_amount: T.nilable(Integer), expand: T.nilable(T::Array[String]), receipt_email: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(::Stripe::Charge::CaptureParams::TransferData), transfer_group: T.nilable(String)).void
2006
+ }
2007
+ def initialize(
2008
+ amount: nil,
2009
+ application_fee: nil,
2010
+ application_fee_amount: nil,
2011
+ expand: nil,
2012
+ receipt_email: nil,
2013
+ statement_descriptor: nil,
2014
+ statement_descriptor_suffix: nil,
2015
+ transfer_data: nil,
2016
+ transfer_group: nil
2017
+ ); end
2018
+ end
2019
+ # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
2020
+ #
2021
+ # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
2022
+ #
2023
+ # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
2024
+ sig {
2025
+ params(params: T.any(::Stripe::Charge::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
2026
+ }
2027
+ def capture(params = {}, opts = {}); end
2028
+
2029
+ # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
2030
+ #
2031
+ # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
2032
+ #
2033
+ # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
2034
+ sig {
2035
+ params(charge: String, params: T.any(::Stripe::Charge::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
2036
+ }
2037
+ def self.capture(charge, params = {}, opts = {}); end
2038
+
2039
+ # This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents)
2040
+ # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
2041
+ # object used to request payment.
2042
+ sig {
2043
+ params(params: T.any(::Stripe::Charge::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
2044
+ }
2045
+ def self.create(params = {}, opts = {}); end
2046
+
2047
+ # Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
2048
+ sig {
2049
+ params(params: T.any(::Stripe::Charge::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
2050
+ }
2051
+ def self.list(params = {}, opts = {}); end
2052
+
2053
+ sig {
2054
+ params(params: T.any(::Stripe::Charge::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
2055
+ }
2056
+ def self.search(params = {}, opts = {}); end
2057
+
2058
+ sig {
2059
+ params(params: T.any(::Stripe::Charge::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped, blk: T.untyped).returns(Stripe::SearchResultObject)
2060
+ }
2061
+ def self.search_auto_paging_each(params = {}, opts = {}, &blk); end
2062
+
2063
+ # Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
2064
+ sig {
2065
+ params(charge: String, params: T.any(::Stripe::Charge::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge)
2066
+ }
2067
+ def self.update(charge, params = {}, opts = {}); end
2068
+ end
2069
+ end