stripe 15.1.0.pre.beta.2 → 15.1.0

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