stripe 13.5.0 → 14.0.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 (641) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -3
  3. data/Gemfile +4 -0
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +29 -0
  6. data/VERSION +1 -1
  7. data/lib/stripe/api_operations/request.rb +1 -0
  8. data/lib/stripe/api_requestor.rb +3 -0
  9. data/lib/stripe/api_version.rb +1 -1
  10. data/lib/stripe/errors.rb +0 -7
  11. data/lib/stripe/object_types.rb +8 -2
  12. data/lib/stripe/request_params.rb +24 -0
  13. data/lib/stripe/resources/account.rb +4634 -0
  14. data/lib/stripe/resources/account_link.rb +54 -0
  15. data/lib/stripe/resources/account_session.rb +739 -0
  16. data/lib/stripe/resources/apple_pay_domain.rb +54 -0
  17. data/lib/stripe/resources/application.rb +20 -0
  18. data/lib/stripe/resources/application_fee.rb +87 -0
  19. data/lib/stripe/resources/application_fee_refund.rb +17 -0
  20. data/lib/stripe/resources/apps/secret.rb +141 -0
  21. data/lib/stripe/resources/balance.rb +122 -0
  22. data/lib/stripe/resources/balance_transaction.rb +103 -0
  23. data/lib/stripe/resources/bank_account.rb +84 -2
  24. data/lib/stripe/resources/billing/alert.rb +135 -0
  25. data/lib/stripe/resources/billing/alert_triggered.rb +26 -0
  26. data/lib/stripe/resources/billing/credit_balance_summary.rb +40 -0
  27. data/lib/stripe/resources/billing/credit_balance_transaction.rb +107 -0
  28. data/lib/stripe/resources/billing/credit_grant.rb +217 -0
  29. data/lib/stripe/resources/billing/meter.rb +169 -0
  30. data/lib/stripe/resources/billing/meter_event.rb +35 -0
  31. data/lib/stripe/resources/billing/meter_event_adjustment.rb +43 -0
  32. data/lib/stripe/resources/billing/meter_event_summary.rb +15 -0
  33. data/lib/stripe/resources/billing_portal/configuration.rb +553 -0
  34. data/lib/stripe/resources/billing_portal/session.rb +271 -0
  35. data/lib/stripe/resources/capability.rb +84 -0
  36. data/lib/stripe/resources/card.rb +77 -0
  37. data/lib/stripe/resources/cash_balance.rb +17 -0
  38. data/lib/stripe/resources/charge.rb +1612 -0
  39. data/lib/stripe/resources/checkout/session.rb +3530 -6
  40. data/lib/stripe/resources/climate/order.rb +167 -0
  41. data/lib/stripe/resources/climate/product.rb +47 -0
  42. data/lib/stripe/resources/climate/supplier.rb +45 -0
  43. data/lib/stripe/resources/confirmation_token.rb +1448 -0
  44. data/lib/stripe/resources/connect_collection_transfer.rb +24 -0
  45. data/lib/stripe/resources/country_spec.rb +54 -0
  46. data/lib/stripe/resources/coupon.rb +189 -0
  47. data/lib/stripe/resources/credit_note.rb +639 -0
  48. data/lib/stripe/resources/credit_note_line_item.rb +67 -0
  49. data/lib/stripe/resources/customer.rb +824 -0
  50. data/lib/stripe/resources/customer_balance_transaction.rb +29 -0
  51. data/lib/stripe/resources/customer_cash_balance_transaction.rb +109 -0
  52. data/lib/stripe/resources/customer_session.rb +159 -0
  53. data/lib/stripe/resources/discount.rb +29 -0
  54. data/lib/stripe/resources/dispute.rb +610 -0
  55. data/lib/stripe/resources/entitlements/active_entitlement.rb +37 -0
  56. data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +23 -0
  57. data/lib/stripe/resources/entitlements/feature.rb +81 -0
  58. data/lib/stripe/resources/ephemeral_key.rb +21 -0
  59. data/lib/stripe/resources/event.rb +90 -0
  60. data/lib/stripe/resources/exchange_rate.rb +24 -0
  61. data/lib/stripe/resources/file.rb +102 -0
  62. data/lib/stripe/resources/file_link.rb +103 -0
  63. data/lib/stripe/resources/financial_connections/account.rb +237 -0
  64. data/lib/stripe/resources/financial_connections/account_owner.rb +17 -0
  65. data/lib/stripe/resources/financial_connections/account_ownership.rb +9 -0
  66. data/lib/stripe/resources/financial_connections/session.rb +95 -0
  67. data/lib/stripe/resources/financial_connections/transaction.rb +92 -0
  68. data/lib/stripe/resources/forwarding/request.rb +156 -0
  69. data/lib/stripe/resources/funding_instructions.rb +308 -0
  70. data/lib/stripe/resources/identity/verification_report.rb +257 -0
  71. data/lib/stripe/resources/identity/verification_session.rb +352 -0
  72. data/lib/stripe/resources/invoice.rb +3204 -21
  73. data/lib/stripe/resources/invoice_item.rb +400 -0
  74. data/lib/stripe/resources/invoice_line_item.rb +350 -0
  75. data/lib/stripe/resources/invoice_payment.rb +105 -0
  76. data/lib/stripe/resources/invoice_rendering_template.rb +55 -0
  77. data/lib/stripe/resources/issuing/authorization.rb +1104 -0
  78. data/lib/stripe/resources/issuing/card.rb +657 -0
  79. data/lib/stripe/resources/issuing/cardholder.rb +648 -0
  80. data/lib/stripe/resources/issuing/dispute.rb +781 -0
  81. data/lib/stripe/resources/issuing/personalization_design.rb +276 -0
  82. data/lib/stripe/resources/issuing/physical_bundle.rb +54 -0
  83. data/lib/stripe/resources/issuing/token.rb +166 -0
  84. data/lib/stripe/resources/issuing/transaction.rb +912 -0
  85. data/lib/stripe/resources/line_item.rb +47 -0
  86. data/lib/stripe/resources/login_link.rb +7 -0
  87. data/lib/stripe/resources/mandate.rb +142 -0
  88. data/lib/stripe/resources/payment_intent.rb +8650 -0
  89. data/lib/stripe/resources/payment_link.rb +1632 -0
  90. data/lib/stripe/resources/payment_method.rb +1542 -0
  91. data/lib/stripe/resources/payment_method_configuration.rb +2776 -0
  92. data/lib/stripe/resources/payment_method_domain.rb +150 -6
  93. data/lib/stripe/resources/payout.rb +209 -0
  94. data/lib/stripe/resources/person.rb +264 -1
  95. data/lib/stripe/resources/plan.rb +302 -0
  96. data/lib/stripe/resources/price.rb +605 -1
  97. data/lib/stripe/resources/product.rb +472 -0
  98. data/lib/stripe/resources/product_feature.rb +12 -0
  99. data/lib/stripe/resources/promotion_code.rb +212 -0
  100. data/lib/stripe/resources/quote.rb +917 -0
  101. data/lib/stripe/resources/radar/early_fraud_warning.rb +68 -0
  102. data/lib/stripe/resources/radar/value_list.rb +116 -0
  103. data/lib/stripe/resources/radar/value_list_item.rb +86 -0
  104. data/lib/stripe/resources/refund.rb +392 -0
  105. data/lib/stripe/resources/reporting/report_run.rb +141 -0
  106. data/lib/stripe/resources/reporting/report_type.rb +27 -0
  107. data/lib/stripe/resources/reserve_transaction.rb +22 -0
  108. data/lib/stripe/resources/reversal.rb +21 -0
  109. data/lib/stripe/resources/review.rb +99 -0
  110. data/lib/stripe/resources/setup_attempt.rb +368 -0
  111. data/lib/stripe/resources/setup_intent.rb +3473 -0
  112. data/lib/stripe/resources/shipping_rate.rb +250 -0
  113. data/lib/stripe/resources/sigma/scheduled_query_run.rb +45 -0
  114. data/lib/stripe/resources/source.rb +1198 -0
  115. data/lib/stripe/resources/source_mandate_notification.rb +66 -0
  116. data/lib/stripe/resources/source_transaction.rb +85 -0
  117. data/lib/stripe/resources/subscription.rb +1686 -0
  118. data/lib/stripe/resources/subscription_item.rb +313 -5
  119. data/lib/stripe/resources/subscription_schedule.rb +1281 -0
  120. data/lib/stripe/resources/tax/calculation.rb +378 -0
  121. data/lib/stripe/resources/tax/calculation_line_item.rb +56 -0
  122. data/lib/stripe/resources/tax/registration.rb +2373 -0
  123. data/lib/stripe/resources/tax/settings.rb +117 -0
  124. data/lib/stripe/resources/tax/transaction.rb +258 -0
  125. data/lib/stripe/resources/tax/transaction_line_item.rb +31 -0
  126. data/lib/stripe/resources/tax_code.rb +26 -0
  127. data/lib/stripe/resources/tax_deducted_at_source.rb +22 -0
  128. data/lib/stripe/resources/tax_id.rb +112 -0
  129. data/lib/stripe/resources/tax_rate.rb +191 -0
  130. data/lib/stripe/resources/terminal/configuration.rb +1260 -0
  131. data/lib/stripe/resources/terminal/connection_token.rb +18 -0
  132. data/lib/stripe/resources/terminal/location.rb +166 -0
  133. data/lib/stripe/resources/terminal/reader.rb +427 -0
  134. data/lib/stripe/resources/test_helpers/test_clock.rb +77 -0
  135. data/lib/stripe/resources/token.rb +1159 -0
  136. data/lib/stripe/resources/topup.rb +165 -0
  137. data/lib/stripe/resources/transfer.rb +144 -0
  138. data/lib/stripe/resources/treasury/credit_reversal.rb +83 -0
  139. data/lib/stripe/resources/treasury/debit_reversal.rb +94 -0
  140. data/lib/stripe/resources/treasury/financial_account.rb +725 -1
  141. data/lib/stripe/resources/treasury/financial_account_features.rb +189 -0
  142. data/lib/stripe/resources/treasury/inbound_transfer.rb +226 -0
  143. data/lib/stripe/resources/treasury/outbound_payment.rb +486 -0
  144. data/lib/stripe/resources/treasury/outbound_transfer.rb +341 -0
  145. data/lib/stripe/resources/treasury/received_credit.rb +237 -0
  146. data/lib/stripe/resources/treasury/received_debit.rb +196 -0
  147. data/lib/stripe/resources/treasury/transaction.rb +167 -0
  148. data/lib/stripe/resources/treasury/transaction_entry.rb +148 -0
  149. data/lib/stripe/resources/v2/amount.rb +9 -0
  150. data/lib/stripe/resources/v2/billing/meter_event.rb +18 -0
  151. data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +21 -0
  152. data/lib/stripe/resources/v2/billing/meter_event_session.rb +14 -0
  153. data/lib/stripe/resources/v2/event.rb +28 -0
  154. data/lib/stripe/resources/v2/event_destination.rb +60 -0
  155. data/lib/stripe/resources/webhook_endpoint.rb +113 -0
  156. data/lib/stripe/resources.rb +8 -2
  157. data/lib/stripe/services/account_capability_service.rb +32 -0
  158. data/lib/stripe/services/account_external_account_service.rb +250 -0
  159. data/lib/stripe/services/account_link_service.rb +46 -0
  160. data/lib/stripe/services/account_login_link_service.rb +9 -0
  161. data/lib/stripe/services/account_person_service.rb +875 -0
  162. data/lib/stripe/services/account_service.rb +4000 -0
  163. data/lib/stripe/services/account_session_service.rb +484 -0
  164. data/lib/stripe/services/apple_pay_domain_service.rb +51 -0
  165. data/lib/stripe/services/application_fee_refund_service.rb +54 -0
  166. data/lib/stripe/services/application_fee_service.rb +57 -0
  167. data/lib/stripe/services/apps/secret_service.rb +116 -0
  168. data/lib/stripe/services/balance_service.rb +9 -0
  169. data/lib/stripe/services/balance_transaction_service.rb +69 -0
  170. data/lib/stripe/services/billing/alert_service.rb +113 -0
  171. data/lib/stripe/services/billing/credit_balance_summary_service.rb +48 -0
  172. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +40 -0
  173. data/lib/stripe/services/billing/credit_grant_service.rb +166 -0
  174. data/lib/stripe/services/billing/meter_event_adjustment_service.rb +26 -0
  175. data/lib/stripe/services/billing/meter_event_service.rb +21 -0
  176. data/lib/stripe/services/billing/meter_event_summary_service.rb +39 -0
  177. data/lib/stripe/services/billing/meter_service.rb +130 -0
  178. data/lib/stripe/services/billing_portal/configuration_service.rb +444 -0
  179. data/lib/stripe/services/billing_portal/session_service.rb +173 -0
  180. data/lib/stripe/services/charge_service.rb +402 -0
  181. data/lib/stripe/services/checkout/session_line_item_service.rb +18 -0
  182. data/lib/stripe/services/checkout/session_service.rb +2399 -5
  183. data/lib/stripe/services/climate/order_service.rb +102 -0
  184. data/lib/stripe/services/climate/product_service.rb +27 -0
  185. data/lib/stripe/services/climate/supplier_service.rb +27 -0
  186. data/lib/stripe/services/confirmation_token_service.rb +9 -0
  187. data/lib/stripe/services/country_spec_service.rb +27 -0
  188. data/lib/stripe/services/coupon_service.rb +152 -0
  189. data/lib/stripe/services/credit_note_line_item_service.rb +18 -0
  190. data/lib/stripe/services/credit_note_preview_lines_service.rb +152 -0
  191. data/lib/stripe/services/credit_note_service.rb +365 -0
  192. data/lib/stripe/services/customer_balance_transaction_service.rb +63 -0
  193. data/lib/stripe/services/customer_cash_balance_service.rb +29 -0
  194. data/lib/stripe/services/customer_cash_balance_transaction_service.rb +27 -0
  195. data/lib/stripe/services/customer_funding_instructions_service.rb +42 -0
  196. data/lib/stripe/services/customer_payment_method_service.rb +40 -0
  197. data/lib/stripe/services/customer_payment_source_service.rb +179 -0
  198. data/lib/stripe/services/customer_service.rb +577 -0
  199. data/lib/stripe/services/customer_session_service.rb +96 -0
  200. data/lib/stripe/services/customer_tax_id_service.rb +45 -0
  201. data/lib/stripe/services/dispute_service.rb +374 -0
  202. data/lib/stripe/services/entitlements/active_entitlement_service.rb +36 -0
  203. data/lib/stripe/services/entitlements/feature_service.rb +76 -0
  204. data/lib/stripe/services/ephemeral_key_service.rb +36 -0
  205. data/lib/stripe/services/event_service.rb +65 -0
  206. data/lib/stripe/services/exchange_rate_service.rb +27 -0
  207. data/lib/stripe/services/file_link_service.rb +94 -0
  208. data/lib/stripe/services/file_service.rb +89 -0
  209. data/lib/stripe/services/financial_connections/account_owner_service.rb +27 -0
  210. data/lib/stripe/services/financial_connections/account_service.rb +96 -0
  211. data/lib/stripe/services/financial_connections/session_service.rb +68 -0
  212. data/lib/stripe/services/financial_connections/transaction_service.rb +70 -0
  213. data/lib/stripe/services/forwarding/request_service.rb +106 -0
  214. data/lib/stripe/services/identity/verification_report_service.rb +65 -0
  215. data/lib/stripe/services/identity/verification_session_service.rb +231 -0
  216. data/lib/stripe/services/invoice_item_service.rb +334 -0
  217. data/lib/stripe/services/invoice_line_item_service.rb +221 -0
  218. data/lib/stripe/services/invoice_payment_service.rb +83 -0
  219. data/lib/stripe/services/invoice_rendering_template_service.rb +51 -0
  220. data/lib/stripe/services/invoice_service.rb +2648 -19
  221. data/lib/stripe/services/issuing/authorization_service.rb +104 -0
  222. data/lib/stripe/services/issuing/card_service.rb +455 -0
  223. data/lib/stripe/services/issuing/cardholder_service.rb +525 -0
  224. data/lib/stripe/services/issuing/dispute_service.rb +633 -0
  225. data/lib/stripe/services/issuing/personalization_design_service.rb +193 -0
  226. data/lib/stripe/services/issuing/physical_bundle_service.rb +40 -0
  227. data/lib/stripe/services/issuing/token_service.rb +73 -0
  228. data/lib/stripe/services/issuing/transaction_service.rb +77 -0
  229. data/lib/stripe/services/mandate_service.rb +9 -0
  230. data/lib/stripe/services/payment_intent_service.rb +7054 -0
  231. data/lib/stripe/services/payment_link_line_item_service.rb +18 -0
  232. data/lib/stripe/services/payment_link_service.rb +1276 -0
  233. data/lib/stripe/services/payment_method_configuration_service.rb +2004 -0
  234. data/lib/stripe/services/payment_method_domain_service.rb +79 -3
  235. data/lib/stripe/services/payment_method_service.rb +808 -0
  236. data/lib/stripe/services/payout_service.rb +159 -0
  237. data/lib/stripe/services/plan_service.rb +249 -0
  238. data/lib/stripe/services/price_service.rb +494 -1
  239. data/lib/stripe/services/product_feature_service.rb +42 -0
  240. data/lib/stripe/services/product_service.rb +425 -0
  241. data/lib/stripe/services/promotion_code_service.rb +178 -0
  242. data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +18 -0
  243. data/lib/stripe/services/quote_line_item_service.rb +18 -0
  244. data/lib/stripe/services/quote_service.rb +611 -0
  245. data/lib/stripe/services/radar/early_fraud_warning_service.rb +61 -0
  246. data/lib/stripe/services/radar/value_list_item_service.rb +79 -0
  247. data/lib/stripe/services/radar/value_list_service.rb +103 -0
  248. data/lib/stripe/services/refund_service.rb +137 -0
  249. data/lib/stripe/services/reporting/report_run_service.rb +106 -0
  250. data/lib/stripe/services/reporting/report_type_service.rb +18 -0
  251. data/lib/stripe/services/review_service.rb +56 -0
  252. data/lib/stripe/services/setup_attempt_service.rb +51 -0
  253. data/lib/stripe/services/setup_intent_service.rb +3163 -0
  254. data/lib/stripe/services/shipping_rate_service.rb +200 -0
  255. data/lib/stripe/services/sigma/scheduled_query_run_service.rb +27 -0
  256. data/lib/stripe/services/source_service.rb +601 -0
  257. data/lib/stripe/services/source_transaction_service.rb +18 -0
  258. data/lib/stripe/services/subscription_item_service.rb +282 -5
  259. data/lib/stripe/services/subscription_schedule_service.rb +1062 -0
  260. data/lib/stripe/services/subscription_service.rb +1412 -0
  261. data/lib/stripe/services/tax/calculation_line_item_service.rb +18 -0
  262. data/lib/stripe/services/tax/calculation_service.rb +205 -0
  263. data/lib/stripe/services/tax/registration_service.rb +1564 -0
  264. data/lib/stripe/services/tax/settings_service.rb +74 -0
  265. data/lib/stripe/services/tax/transaction_line_item_service.rb +18 -0
  266. data/lib/stripe/services/tax/transaction_service.rb +111 -0
  267. data/lib/stripe/services/tax_code_service.rb +27 -0
  268. data/lib/stripe/services/tax_id_service.rb +79 -0
  269. data/lib/stripe/services/tax_rate_service.rb +155 -0
  270. data/lib/stripe/services/terminal/configuration_service.rb +997 -0
  271. data/lib/stripe/services/terminal/connection_token_service.rb +12 -0
  272. data/lib/stripe/services/terminal/location_service.rb +144 -0
  273. data/lib/stripe/services/terminal/reader_service.rb +266 -0
  274. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +642 -0
  275. data/lib/stripe/services/test_helpers/customer_service.rb +18 -0
  276. data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +745 -0
  277. data/lib/stripe/services/test_helpers/issuing/card_service.rb +45 -0
  278. data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +41 -0
  279. data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +632 -0
  280. data/lib/stripe/services/test_helpers/refund_service.rb +9 -0
  281. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +44 -0
  282. data/lib/stripe/services/test_helpers/test_clock_service.rb +57 -0
  283. data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +38 -0
  284. data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +87 -0
  285. data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +87 -0
  286. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +60 -0
  287. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +60 -0
  288. data/lib/stripe/services/token_service.rb +1140 -0
  289. data/lib/stripe/services/topup_service.rb +142 -0
  290. data/lib/stripe/services/transfer_reversal_service.rb +66 -0
  291. data/lib/stripe/services/transfer_service.rb +119 -0
  292. data/lib/stripe/services/treasury/credit_reversal_service.rb +59 -0
  293. data/lib/stripe/services/treasury/debit_reversal_service.rb +63 -0
  294. data/lib/stripe/services/treasury/financial_account_features_service.rb +166 -0
  295. data/lib/stripe/services/treasury/financial_account_service.rb +485 -1
  296. data/lib/stripe/services/treasury/inbound_transfer_service.rb +88 -0
  297. data/lib/stripe/services/treasury/outbound_payment_service.rb +258 -0
  298. data/lib/stripe/services/treasury/outbound_transfer_service.rb +124 -0
  299. data/lib/stripe/services/treasury/received_credit_service.rb +52 -0
  300. data/lib/stripe/services/treasury/received_debit_service.rb +40 -0
  301. data/lib/stripe/services/treasury/transaction_entry_service.rb +87 -0
  302. data/lib/stripe/services/treasury/transaction_service.rb +95 -0
  303. data/lib/stripe/services/v1_services.rb +2 -1
  304. data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +23 -0
  305. data/lib/stripe/services/v2/billing/meter_event_service.rb +25 -0
  306. data/lib/stripe/services/v2/billing/meter_event_session_service.rb +3 -0
  307. data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +33 -0
  308. data/lib/stripe/services/v2/core/event_destination_service.rb +143 -0
  309. data/lib/stripe/services/v2/core/event_service.rb +15 -0
  310. data/lib/stripe/services/webhook_endpoint_service.rb +96 -0
  311. data/lib/stripe/services.rb +1 -3
  312. data/lib/stripe/stripe_client.rb +2 -1
  313. data/lib/stripe/stripe_object.rb +5 -0
  314. data/lib/stripe/version.rb +1 -1
  315. data/lib/stripe.rb +1 -0
  316. data/rbi/stripe/resources/account.rbi +4840 -0
  317. data/rbi/stripe/resources/account_link.rbi +74 -0
  318. data/rbi/stripe/resources/account_session.rbi +894 -0
  319. data/rbi/stripe/resources/apple_pay_domain.rbi +90 -0
  320. data/rbi/stripe/resources/application.rbi +20 -0
  321. data/rbi/stripe/resources/application_fee.rbi +118 -0
  322. data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
  323. data/rbi/stripe/resources/apps/secret.rbi +195 -0
  324. data/rbi/stripe/resources/balance.rbi +180 -0
  325. data/rbi/stripe/resources/balance_transaction.rbi +144 -0
  326. data/rbi/stripe/resources/bank_account.rbi +127 -0
  327. data/rbi/stripe/resources/billing/alert.rbi +201 -0
  328. data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
  329. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
  330. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
  331. data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
  332. data/rbi/stripe/resources/billing/meter.rbi +226 -0
  333. data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
  334. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
  335. data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
  336. data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
  337. data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
  338. data/rbi/stripe/resources/capability.rbi +125 -0
  339. data/rbi/stripe/resources/card.rbi +125 -0
  340. data/rbi/stripe/resources/cash_balance.rbi +32 -0
  341. data/rbi/stripe/resources/charge.rbi +2054 -0
  342. data/rbi/stripe/resources/checkout/session.rbi +3951 -0
  343. data/rbi/stripe/resources/climate/order.rbi +245 -0
  344. data/rbi/stripe/resources/climate/product.rbi +75 -0
  345. data/rbi/stripe/resources/climate/supplier.rbi +72 -0
  346. data/rbi/stripe/resources/confirmation_token.rbi +1793 -0
  347. data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
  348. data/rbi/stripe/resources/country_spec.rbi +85 -0
  349. data/rbi/stripe/resources/coupon.rbi +252 -0
  350. data/rbi/stripe/resources/credit_note.rbi +747 -0
  351. data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
  352. data/rbi/stripe/resources/customer.rbi +1009 -0
  353. data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
  354. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
  355. data/rbi/stripe/resources/customer_session.rbi +200 -0
  356. data/rbi/stripe/resources/discount.rbi +53 -0
  357. data/rbi/stripe/resources/dispute.rbi +761 -0
  358. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
  359. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
  360. data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
  361. data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
  362. data/rbi/stripe/resources/event.rbi +146 -0
  363. data/rbi/stripe/resources/exchange_rate.rbi +66 -0
  364. data/rbi/stripe/resources/file.rbi +143 -0
  365. data/rbi/stripe/resources/file_link.rbi +141 -0
  366. data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
  367. data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
  368. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
  369. data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
  370. data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
  371. data/rbi/stripe/resources/forwarding/request.rbi +216 -0
  372. data/rbi/stripe/resources/funding_instructions.rbi +437 -0
  373. data/rbi/stripe/resources/identity/verification_report.rbi +351 -0
  374. data/rbi/stripe/resources/identity/verification_session.rbi +517 -0
  375. data/rbi/stripe/resources/invoice.rbi +3733 -0
  376. data/rbi/stripe/resources/invoice_item.rbi +475 -0
  377. data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
  378. data/rbi/stripe/resources/invoice_payment.rbi +114 -0
  379. data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
  380. data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
  381. data/rbi/stripe/resources/issuing/card.rbi +741 -0
  382. data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
  383. data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
  384. data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
  385. data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
  386. data/rbi/stripe/resources/issuing/token.rbi +226 -0
  387. data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
  388. data/rbi/stripe/resources/line_item.rbi +72 -0
  389. data/rbi/stripe/resources/login_link.rbi +18 -0
  390. data/rbi/stripe/resources/mandate.rbi +187 -0
  391. data/rbi/stripe/resources/payment_intent.rbi +9731 -0
  392. data/rbi/stripe/resources/payment_link.rbi +1801 -0
  393. data/rbi/stripe/resources/payment_method.rbi +1822 -0
  394. data/rbi/stripe/resources/payment_method_configuration.rbi +3154 -0
  395. data/rbi/stripe/resources/payment_method_domain.rbi +212 -0
  396. data/rbi/stripe/resources/payout.rbi +300 -0
  397. data/rbi/stripe/resources/person.rbi +371 -0
  398. data/rbi/stripe/resources/plan.rbi +373 -0
  399. data/rbi/stripe/resources/price.rbi +694 -0
  400. data/rbi/stripe/resources/product.rbi +557 -0
  401. data/rbi/stripe/resources/product_feature.rbi +26 -0
  402. data/rbi/stripe/resources/promotion_code.rbi +261 -0
  403. data/rbi/stripe/resources/quote.rbi +1123 -0
  404. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
  405. data/rbi/stripe/resources/radar/value_list.rbi +170 -0
  406. data/rbi/stripe/resources/radar/value_list_item.rbi +131 -0
  407. data/rbi/stripe/resources/refund.rbi +516 -0
  408. data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
  409. data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
  410. data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
  411. data/rbi/stripe/resources/reversal.rbi +51 -0
  412. data/rbi/stripe/resources/review.rbi +154 -0
  413. data/rbi/stripe/resources/setup_attempt.rbi +477 -0
  414. data/rbi/stripe/resources/setup_intent.rbi +3860 -0
  415. data/rbi/stripe/resources/shipping_rate.rbi +305 -0
  416. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
  417. data/rbi/stripe/resources/source.rbi +1496 -0
  418. data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
  419. data/rbi/stripe/resources/source_transaction.rbi +127 -0
  420. data/rbi/stripe/resources/subscription.rbi +1964 -0
  421. data/rbi/stripe/resources/subscription_item.rbi +370 -0
  422. data/rbi/stripe/resources/subscription_schedule.rbi +1495 -0
  423. data/rbi/stripe/resources/tax/calculation.rbi +474 -0
  424. data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
  425. data/rbi/stripe/resources/tax/registration.rbi +2485 -0
  426. data/rbi/stripe/resources/tax/settings.rbi +141 -0
  427. data/rbi/stripe/resources/tax/transaction.rbi +351 -0
  428. data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
  429. data/rbi/stripe/resources/tax_code.rbi +44 -0
  430. data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
  431. data/rbi/stripe/resources/tax_id.rbi +167 -0
  432. data/rbi/stripe/resources/tax_rate.rbi +239 -0
  433. data/rbi/stripe/resources/terminal/configuration.rbi +1388 -0
  434. data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
  435. data/rbi/stripe/resources/terminal/location.rbi +224 -0
  436. data/rbi/stripe/resources/terminal/reader.rbi +587 -0
  437. data/rbi/stripe/resources/test_helpers/test_clock.rbi +134 -0
  438. data/rbi/stripe/resources/token.rbi +1217 -0
  439. data/rbi/stripe/resources/topup.rbi +222 -0
  440. data/rbi/stripe/resources/transfer.rbi +199 -0
  441. data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
  442. data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
  443. data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
  444. data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
  445. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
  446. data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
  447. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
  448. data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
  449. data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
  450. data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
  451. data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
  452. data/rbi/stripe/resources/v2/amount.rbi +14 -0
  453. data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
  454. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
  455. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
  456. data/rbi/stripe/resources/v2/event.rbi +48 -0
  457. data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
  458. data/rbi/stripe/resources/webhook_endpoint.rbi +170 -0
  459. data/rbi/stripe/services/account_capability_service.rbi +51 -0
  460. data/rbi/stripe/services/account_external_account_service.rbi +306 -0
  461. data/rbi/stripe/services/account_link_service.rbi +58 -0
  462. data/rbi/stripe/services/account_login_link_service.rbi +22 -0
  463. data/rbi/stripe/services/account_person_service.rbi +923 -0
  464. data/rbi/stripe/services/account_service.rbi +4143 -0
  465. data/rbi/stripe/services/account_session_service.rbi +572 -0
  466. data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
  467. data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
  468. data/rbi/stripe/services/application_fee_service.rbi +78 -0
  469. data/rbi/stripe/services/apps/secret_service.rbi +151 -0
  470. data/rbi/stripe/services/apps_service.rbi +9 -0
  471. data/rbi/stripe/services/balance_service.rbi +21 -0
  472. data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
  473. data/rbi/stripe/services/billing/alert_service.rbi +152 -0
  474. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
  475. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
  476. data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
  477. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
  478. data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
  479. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
  480. data/rbi/stripe/services/billing/meter_service.rbi +163 -0
  481. data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
  482. data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
  483. data/rbi/stripe/services/billing_portal_service.rbi +10 -0
  484. data/rbi/stripe/services/billing_service.rbi +15 -0
  485. data/rbi/stripe/services/charge_service.rbi +448 -0
  486. data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
  487. data/rbi/stripe/services/checkout/session_service.rbi +2585 -0
  488. data/rbi/stripe/services/checkout_service.rbi +9 -0
  489. data/rbi/stripe/services/climate/order_service.rbi +142 -0
  490. data/rbi/stripe/services/climate/product_service.rbi +46 -0
  491. data/rbi/stripe/services/climate/supplier_service.rbi +46 -0
  492. data/rbi/stripe/services/climate_service.rbi +11 -0
  493. data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
  494. data/rbi/stripe/services/country_spec_service.rbi +44 -0
  495. data/rbi/stripe/services/coupon_service.rbi +196 -0
  496. data/rbi/stripe/services/credit_note_line_item_service.rbi +31 -0
  497. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
  498. data/rbi/stripe/services/credit_note_service.rbi +416 -0
  499. data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
  500. data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
  501. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
  502. data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
  503. data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
  504. data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
  505. data/rbi/stripe/services/customer_service.rbi +651 -0
  506. data/rbi/stripe/services/customer_session_service.rbi +116 -0
  507. data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
  508. data/rbi/stripe/services/dispute_service.rbi +424 -0
  509. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
  510. data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
  511. data/rbi/stripe/services/entitlements_service.rbi +10 -0
  512. data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
  513. data/rbi/stripe/services/event_service.rbi +83 -0
  514. data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
  515. data/rbi/stripe/services/file_link_service.rbi +124 -0
  516. data/rbi/stripe/services/file_service.rbi +116 -0
  517. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
  518. data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
  519. data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
  520. data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
  521. data/rbi/stripe/services/financial_connections_service.rbi +11 -0
  522. data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
  523. data/rbi/stripe/services/forwarding_service.rbi +9 -0
  524. data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
  525. data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
  526. data/rbi/stripe/services/identity_service.rbi +10 -0
  527. data/rbi/stripe/services/invoice_item_service.rbi +368 -0
  528. data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
  529. data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
  530. data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
  531. data/rbi/stripe/services/invoice_service.rbi +2920 -0
  532. data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
  533. data/rbi/stripe/services/issuing/card_service.rbi +495 -0
  534. data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
  535. data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
  536. data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
  537. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
  538. data/rbi/stripe/services/issuing/token_service.rbi +99 -0
  539. data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
  540. data/rbi/stripe/services/issuing_service.rbi +16 -0
  541. data/rbi/stripe/services/mandate_service.rbi +20 -0
  542. data/rbi/stripe/services/payment_intent_service.rbi +7759 -0
  543. data/rbi/stripe/services/payment_link_line_item_service.rbi +31 -0
  544. data/rbi/stripe/services/payment_link_service.rbi +1352 -0
  545. data/rbi/stripe/services/payment_method_configuration_service.rbi +2211 -0
  546. data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
  547. data/rbi/stripe/services/payment_method_service.rbi +840 -0
  548. data/rbi/stripe/services/payout_service.rbi +205 -0
  549. data/rbi/stripe/services/plan_service.rbi +284 -0
  550. data/rbi/stripe/services/price_service.rbi +546 -0
  551. data/rbi/stripe/services/product_feature_service.rbi +69 -0
  552. data/rbi/stripe/services/product_service.rbi +479 -0
  553. data/rbi/stripe/services/promotion_code_service.rbi +214 -0
  554. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
  555. data/rbi/stripe/services/quote_line_item_service.rbi +31 -0
  556. data/rbi/stripe/services/quote_service.rbi +686 -0
  557. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
  558. data/rbi/stripe/services/radar/value_list_item_service.rbi +111 -0
  559. data/rbi/stripe/services/radar/value_list_service.rbi +143 -0
  560. data/rbi/stripe/services/radar_service.rbi +11 -0
  561. data/rbi/stripe/services/refund_service.rbi +185 -0
  562. data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
  563. data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
  564. data/rbi/stripe/services/reporting_service.rbi +10 -0
  565. data/rbi/stripe/services/review_service.rbi +84 -0
  566. data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
  567. data/rbi/stripe/services/setup_intent_service.rbi +3596 -0
  568. data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
  569. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
  570. data/rbi/stripe/services/sigma_service.rbi +9 -0
  571. data/rbi/stripe/services/source_service.rbi +663 -0
  572. data/rbi/stripe/services/source_transaction_service.rbi +31 -0
  573. data/rbi/stripe/services/subscription_item_service.rbi +324 -0
  574. data/rbi/stripe/services/subscription_schedule_service.rbi +1192 -0
  575. data/rbi/stripe/services/subscription_service.rbi +1596 -0
  576. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
  577. data/rbi/stripe/services/tax/calculation_service.rbi +230 -0
  578. data/rbi/stripe/services/tax/registration_service.rbi +1689 -0
  579. data/rbi/stripe/services/tax/settings_service.rbi +93 -0
  580. data/rbi/stripe/services/tax/transaction_line_item_service.rbi +33 -0
  581. data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
  582. data/rbi/stripe/services/tax_code_service.rbi +44 -0
  583. data/rbi/stripe/services/tax_id_service.rbi +112 -0
  584. data/rbi/stripe/services/tax_rate_service.rbi +185 -0
  585. data/rbi/stripe/services/tax_service.rbi +12 -0
  586. data/rbi/stripe/services/terminal/configuration_service.rbi +1120 -0
  587. data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
  588. data/rbi/stripe/services/terminal/location_service.rbi +184 -0
  589. data/rbi/stripe/services/terminal/reader_service.rbi +344 -0
  590. data/rbi/stripe/services/terminal_service.rbi +12 -0
  591. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +746 -0
  592. data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
  593. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
  594. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
  595. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
  596. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
  597. data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
  598. data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
  599. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +62 -0
  600. data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
  601. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +92 -0
  602. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
  603. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
  604. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
  605. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
  606. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
  607. data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
  608. data/rbi/stripe/services/test_helpers_service.rbi +15 -0
  609. data/rbi/stripe/services/token_service.rbi +1189 -0
  610. data/rbi/stripe/services/topup_service.rbi +176 -0
  611. data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
  612. data/rbi/stripe/services/transfer_service.rbi +152 -0
  613. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
  614. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
  615. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
  616. data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
  617. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
  618. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
  619. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
  620. data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
  621. data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
  622. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
  623. data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
  624. data/rbi/stripe/services/treasury_service.rbi +18 -0
  625. data/rbi/stripe/services/v1_services.rbi +77 -0
  626. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
  627. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
  628. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -0
  629. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
  630. data/rbi/stripe/services/v2/billing_service.rbi +14 -0
  631. data/rbi/stripe/services/v2/core/event_destination_service.rbi +200 -0
  632. data/rbi/stripe/services/v2/core/event_service.rbi +36 -0
  633. data/rbi/stripe/services/v2/core_service.rbi +12 -0
  634. data/rbi/stripe/services/v2_services.rbi +10 -0
  635. data/rbi/stripe/services/webhook_endpoint_service.rbi +131 -0
  636. metadata +333 -7
  637. data/lib/stripe/resources/usage_record.rb +0 -17
  638. data/lib/stripe/resources/usage_record_summary.rb +0 -12
  639. data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -17
  640. data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -23
  641. data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -19
@@ -20,6 +20,1618 @@ module Stripe
20
20
 
21
21
  nested_resource_class_methods :refund, operations: %i[retrieve list]
22
22
 
23
+ class BillingDetails < Stripe::StripeObject
24
+ class Address < Stripe::StripeObject
25
+ # City, district, suburb, town, or village.
26
+ attr_reader :city
27
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
28
+ attr_reader :country
29
+ # Address line 1 (e.g., street, PO Box, or company name).
30
+ attr_reader :line1
31
+ # Address line 2 (e.g., apartment, suite, unit, or building).
32
+ attr_reader :line2
33
+ # ZIP or postal code.
34
+ attr_reader :postal_code
35
+ # State, county, province, or region.
36
+ attr_reader :state
37
+ end
38
+ # Billing address.
39
+ attr_reader :address
40
+ # Email address.
41
+ attr_reader :email
42
+ # Full name.
43
+ attr_reader :name
44
+ # Billing phone number (including extension).
45
+ attr_reader :phone
46
+ end
47
+
48
+ class FraudDetails < Stripe::StripeObject
49
+ # Assessments from Stripe. If set, the value is `fraudulent`.
50
+ attr_reader :stripe_report
51
+ # Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.
52
+ attr_reader :user_report
53
+ end
54
+
55
+ class Level3 < Stripe::StripeObject
56
+ class LineItem < Stripe::StripeObject
57
+ # Attribute for field discount_amount
58
+ attr_reader :discount_amount
59
+ # Attribute for field product_code
60
+ attr_reader :product_code
61
+ # Attribute for field product_description
62
+ attr_reader :product_description
63
+ # Attribute for field quantity
64
+ attr_reader :quantity
65
+ # Attribute for field tax_amount
66
+ attr_reader :tax_amount
67
+ # Attribute for field unit_cost
68
+ attr_reader :unit_cost
69
+ end
70
+ # Attribute for field customer_reference
71
+ attr_reader :customer_reference
72
+ # Attribute for field line_items
73
+ attr_reader :line_items
74
+ # Attribute for field merchant_reference
75
+ attr_reader :merchant_reference
76
+ # Attribute for field shipping_address_zip
77
+ attr_reader :shipping_address_zip
78
+ # Attribute for field shipping_amount
79
+ attr_reader :shipping_amount
80
+ # Attribute for field shipping_from_zip
81
+ attr_reader :shipping_from_zip
82
+ end
83
+
84
+ class Outcome < Stripe::StripeObject
85
+ class Rule < Stripe::StripeObject
86
+ # The action taken on the payment.
87
+ attr_reader :action
88
+ # Unique identifier for the object.
89
+ attr_reader :id
90
+ # The predicate to evaluate the payment against.
91
+ attr_reader :predicate
92
+ end
93
+ # An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).
94
+ attr_reader :advice_code
95
+ # 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.
96
+ attr_reader :network_advice_code
97
+ # For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
98
+ attr_reader :network_decline_code
99
+ # 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.
100
+ attr_reader :network_status
101
+ # 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.
102
+ attr_reader :reason
103
+ # 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.
104
+ attr_reader :risk_level
105
+ # 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.
106
+ attr_reader :risk_score
107
+ # The ID of the Radar rule that matched the payment, if applicable.
108
+ attr_reader :rule
109
+ # A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
110
+ attr_reader :seller_message
111
+ # 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.
112
+ attr_reader :type
113
+ end
114
+
115
+ class PaymentMethodDetails < Stripe::StripeObject
116
+ class AchCreditTransfer < Stripe::StripeObject
117
+ # Account number to transfer funds to.
118
+ attr_reader :account_number
119
+ # Name of the bank associated with the routing number.
120
+ attr_reader :bank_name
121
+ # Routing transit number for the bank account to transfer funds to.
122
+ attr_reader :routing_number
123
+ # SWIFT code of the bank associated with the routing number.
124
+ attr_reader :swift_code
125
+ end
126
+
127
+ class AchDebit < Stripe::StripeObject
128
+ # Type of entity that holds the account. This can be either `individual` or `company`.
129
+ attr_reader :account_holder_type
130
+ # Name of the bank associated with the bank account.
131
+ attr_reader :bank_name
132
+ # Two-letter ISO code representing the country the bank account is located in.
133
+ attr_reader :country
134
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
135
+ attr_reader :fingerprint
136
+ # Last four digits of the bank account number.
137
+ attr_reader :last4
138
+ # Routing transit number of the bank account.
139
+ attr_reader :routing_number
140
+ end
141
+
142
+ class AcssDebit < Stripe::StripeObject
143
+ # Name of the bank associated with the bank account.
144
+ attr_reader :bank_name
145
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
146
+ attr_reader :fingerprint
147
+ # Institution number of the bank account
148
+ attr_reader :institution_number
149
+ # Last four digits of the bank account number.
150
+ attr_reader :last4
151
+ # ID of the mandate used to make this payment.
152
+ attr_reader :mandate
153
+ # Transit number of the bank account.
154
+ attr_reader :transit_number
155
+ end
156
+
157
+ class Affirm < Stripe::StripeObject
158
+ # The Affirm transaction ID associated with this payment.
159
+ attr_reader :transaction_id
160
+ end
161
+
162
+ class AfterpayClearpay < Stripe::StripeObject
163
+ # The Afterpay order ID associated with this payment intent.
164
+ attr_reader :order_id
165
+ # Order identifier shown to the merchant in Afterpay’s online portal.
166
+ attr_reader :reference
167
+ end
168
+
169
+ class Alipay < Stripe::StripeObject
170
+ # Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
171
+ attr_reader :buyer_id
172
+ # Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
173
+ attr_reader :fingerprint
174
+ # Transaction ID of this particular Alipay transaction.
175
+ attr_reader :transaction_id
176
+ end
177
+
178
+ class Alma < Stripe::StripeObject; end
179
+
180
+ class AmazonPay < Stripe::StripeObject
181
+ class Funding < Stripe::StripeObject
182
+ class Card < Stripe::StripeObject
183
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
184
+ attr_reader :brand
185
+ # 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.
186
+ attr_reader :country
187
+ # Two-digit number representing the card's expiration month.
188
+ attr_reader :exp_month
189
+ # Four-digit number representing the card's expiration year.
190
+ attr_reader :exp_year
191
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
192
+ attr_reader :funding
193
+ # The last four digits of the card.
194
+ attr_reader :last4
195
+ end
196
+ # Attribute for field card
197
+ attr_reader :card
198
+ # funding type of the underlying payment method.
199
+ attr_reader :type
200
+ end
201
+ # Attribute for field funding
202
+ attr_reader :funding
203
+ end
204
+
205
+ class AuBecsDebit < Stripe::StripeObject
206
+ # Bank-State-Branch number of the bank account.
207
+ attr_reader :bsb_number
208
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
209
+ attr_reader :fingerprint
210
+ # Last four digits of the bank account number.
211
+ attr_reader :last4
212
+ # ID of the mandate used to make this payment.
213
+ attr_reader :mandate
214
+ end
215
+
216
+ class BacsDebit < Stripe::StripeObject
217
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
218
+ attr_reader :fingerprint
219
+ # Last four digits of the bank account number.
220
+ attr_reader :last4
221
+ # ID of the mandate used to make this payment.
222
+ attr_reader :mandate
223
+ # Sort code of the bank account. (e.g., `10-20-30`)
224
+ attr_reader :sort_code
225
+ end
226
+
227
+ class Bancontact < Stripe::StripeObject
228
+ # Bank code of bank associated with the bank account.
229
+ attr_reader :bank_code
230
+ # Name of the bank associated with the bank account.
231
+ attr_reader :bank_name
232
+ # Bank Identifier Code of the bank associated with the bank account.
233
+ attr_reader :bic
234
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
235
+ attr_reader :generated_sepa_debit
236
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
237
+ attr_reader :generated_sepa_debit_mandate
238
+ # Last four characters of the IBAN.
239
+ attr_reader :iban_last4
240
+ # Preferred language of the Bancontact authorization page that the customer is redirected to.
241
+ # Can be one of `en`, `de`, `fr`, or `nl`
242
+ attr_reader :preferred_language
243
+ # Owner's verified full name. Values are verified or provided by Bancontact directly
244
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
245
+ attr_reader :verified_name
246
+ end
247
+
248
+ class Billie < Stripe::StripeObject; end
249
+
250
+ class Blik < Stripe::StripeObject
251
+ # A unique and immutable identifier assigned by BLIK to every buyer.
252
+ attr_reader :buyer_id
253
+ end
254
+
255
+ class Boleto < Stripe::StripeObject
256
+ # The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
257
+ attr_reader :tax_id
258
+ end
259
+
260
+ class Card < Stripe::StripeObject
261
+ class Checks < Stripe::StripeObject
262
+ # If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
263
+ attr_reader :address_line1_check
264
+ # If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
265
+ attr_reader :address_postal_code_check
266
+ # If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
267
+ attr_reader :cvc_check
268
+ end
269
+
270
+ class ExtendedAuthorization < Stripe::StripeObject
271
+ # Indicates whether or not the capture window is extended beyond the standard authorization.
272
+ attr_reader :status
273
+ end
274
+
275
+ class IncrementalAuthorization < Stripe::StripeObject
276
+ # Indicates whether or not the incremental authorization feature is supported.
277
+ attr_reader :status
278
+ end
279
+
280
+ class Installments < Stripe::StripeObject
281
+ class Plan < Stripe::StripeObject
282
+ # For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
283
+ attr_reader :count
284
+ # For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
285
+ # One of `month`.
286
+ attr_reader :interval
287
+ # Type of installment plan, one of `fixed_count`.
288
+ attr_reader :type
289
+ end
290
+ # Installment plan selected for the payment.
291
+ attr_reader :plan
292
+ end
293
+
294
+ class Multicapture < Stripe::StripeObject
295
+ # Indicates whether or not multiple captures are supported.
296
+ attr_reader :status
297
+ end
298
+
299
+ class NetworkToken < Stripe::StripeObject
300
+ # Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
301
+ attr_reader :used
302
+ end
303
+
304
+ class Overcapture < Stripe::StripeObject
305
+ # The maximum amount that can be captured.
306
+ attr_reader :maximum_amount_capturable
307
+ # Indicates whether or not the authorized amount can be over-captured.
308
+ attr_reader :status
309
+ end
310
+
311
+ class ThreeDSecure < Stripe::StripeObject
312
+ # For authenticated transactions: how the customer was authenticated by
313
+ # the issuing bank.
314
+ attr_reader :authentication_flow
315
+ # The Electronic Commerce Indicator (ECI). A protocol-level field
316
+ # indicating what degree of authentication was performed.
317
+ attr_reader :electronic_commerce_indicator
318
+ # The exemption requested via 3DS and accepted by the issuer at authentication time.
319
+ attr_reader :exemption_indicator
320
+ # Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on
321
+ # the outcome of Stripe's internal risk assessment.
322
+ attr_reader :exemption_indicator_applied
323
+ # Indicates the outcome of 3D Secure authentication.
324
+ attr_reader :result
325
+ # Additional information about why 3D Secure succeeded or failed based
326
+ # on the `result`.
327
+ attr_reader :result_reason
328
+ # The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
329
+ # (dsTransId) for this payment.
330
+ attr_reader :transaction_id
331
+ # The version of 3D Secure that was used.
332
+ attr_reader :version
333
+ end
334
+
335
+ class Wallet < Stripe::StripeObject
336
+ class AmexExpressCheckout < Stripe::StripeObject; end
337
+ class ApplePay < Stripe::StripeObject; end
338
+ class GooglePay < Stripe::StripeObject; end
339
+ class Link < Stripe::StripeObject; end
340
+
341
+ class Masterpass < Stripe::StripeObject
342
+ class BillingAddress < Stripe::StripeObject
343
+ # City, district, suburb, town, or village.
344
+ attr_reader :city
345
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
346
+ attr_reader :country
347
+ # Address line 1 (e.g., street, PO Box, or company name).
348
+ attr_reader :line1
349
+ # Address line 2 (e.g., apartment, suite, unit, or building).
350
+ attr_reader :line2
351
+ # ZIP or postal code.
352
+ attr_reader :postal_code
353
+ # State, county, province, or region.
354
+ attr_reader :state
355
+ end
356
+
357
+ class ShippingAddress < Stripe::StripeObject
358
+ # City, district, suburb, town, or village.
359
+ attr_reader :city
360
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
361
+ attr_reader :country
362
+ # Address line 1 (e.g., street, PO Box, or company name).
363
+ attr_reader :line1
364
+ # Address line 2 (e.g., apartment, suite, unit, or building).
365
+ attr_reader :line2
366
+ # ZIP or postal code.
367
+ attr_reader :postal_code
368
+ # State, county, province, or region.
369
+ attr_reader :state
370
+ end
371
+ # 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.
372
+ attr_reader :billing_address
373
+ # 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.
374
+ attr_reader :email
375
+ # 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.
376
+ attr_reader :name
377
+ # 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.
378
+ attr_reader :shipping_address
379
+ end
380
+
381
+ class SamsungPay < Stripe::StripeObject; end
382
+
383
+ class VisaCheckout < Stripe::StripeObject
384
+ class BillingAddress < Stripe::StripeObject
385
+ # City, district, suburb, town, or village.
386
+ attr_reader :city
387
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
388
+ attr_reader :country
389
+ # Address line 1 (e.g., street, PO Box, or company name).
390
+ attr_reader :line1
391
+ # Address line 2 (e.g., apartment, suite, unit, or building).
392
+ attr_reader :line2
393
+ # ZIP or postal code.
394
+ attr_reader :postal_code
395
+ # State, county, province, or region.
396
+ attr_reader :state
397
+ end
398
+
399
+ class ShippingAddress < Stripe::StripeObject
400
+ # City, district, suburb, town, or village.
401
+ attr_reader :city
402
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
403
+ attr_reader :country
404
+ # Address line 1 (e.g., street, PO Box, or company name).
405
+ attr_reader :line1
406
+ # Address line 2 (e.g., apartment, suite, unit, or building).
407
+ attr_reader :line2
408
+ # ZIP or postal code.
409
+ attr_reader :postal_code
410
+ # State, county, province, or region.
411
+ attr_reader :state
412
+ end
413
+ # 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.
414
+ attr_reader :billing_address
415
+ # 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.
416
+ attr_reader :email
417
+ # 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.
418
+ attr_reader :name
419
+ # 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.
420
+ attr_reader :shipping_address
421
+ end
422
+ # Attribute for field amex_express_checkout
423
+ attr_reader :amex_express_checkout
424
+ # Attribute for field apple_pay
425
+ attr_reader :apple_pay
426
+ # (For tokenized numbers only.) The last four digits of the device account number.
427
+ attr_reader :dynamic_last4
428
+ # Attribute for field google_pay
429
+ attr_reader :google_pay
430
+ # Attribute for field link
431
+ attr_reader :link
432
+ # Attribute for field masterpass
433
+ attr_reader :masterpass
434
+ # Attribute for field samsung_pay
435
+ attr_reader :samsung_pay
436
+ # 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.
437
+ attr_reader :type
438
+ # Attribute for field visa_checkout
439
+ attr_reader :visa_checkout
440
+ end
441
+ # The authorized amount.
442
+ attr_reader :amount_authorized
443
+ # Authorization code on the charge.
444
+ attr_reader :authorization_code
445
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
446
+ attr_reader :brand
447
+ # When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
448
+ attr_reader :capture_before
449
+ # Check results by Card networks on Card address and CVC at time of payment.
450
+ attr_reader :checks
451
+ # 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.
452
+ attr_reader :country
453
+ # 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.)
454
+ attr_reader :description
455
+ # Two-digit number representing the card's expiration month.
456
+ attr_reader :exp_month
457
+ # Four-digit number representing the card's expiration year.
458
+ attr_reader :exp_year
459
+ # Attribute for field extended_authorization
460
+ attr_reader :extended_authorization
461
+ # 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.
462
+ #
463
+ # *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.*
464
+ attr_reader :fingerprint
465
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
466
+ attr_reader :funding
467
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
468
+ attr_reader :iin
469
+ # Attribute for field incremental_authorization
470
+ attr_reader :incremental_authorization
471
+ # Installment details for this payment (Mexico only).
472
+ #
473
+ # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
474
+ attr_reader :installments
475
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
476
+ attr_reader :issuer
477
+ # The last four digits of the card.
478
+ attr_reader :last4
479
+ # ID of the mandate used to make this payment or created by it.
480
+ attr_reader :mandate
481
+ # True if this payment was marked as MOTO and out of scope for SCA.
482
+ attr_reader :moto
483
+ # Attribute for field multicapture
484
+ attr_reader :multicapture
485
+ # 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`.
486
+ attr_reader :network
487
+ # If this card has network token credentials, this contains the details of the network token credentials.
488
+ attr_reader :network_token
489
+ # 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.
490
+ attr_reader :network_transaction_id
491
+ # Attribute for field overcapture
492
+ attr_reader :overcapture
493
+ # Status of a card based on the card issuer.
494
+ attr_reader :regulated_status
495
+ # Populated if this transaction used 3D Secure authentication.
496
+ attr_reader :three_d_secure
497
+ # If this Card is part of a card wallet, this contains the details of the card wallet.
498
+ attr_reader :wallet
499
+ end
500
+
501
+ class CardPresent < Stripe::StripeObject
502
+ class Offline < Stripe::StripeObject
503
+ # Time at which the payment was collected while offline
504
+ attr_reader :stored_at
505
+ # The method used to process this payment method offline. Only deferred is allowed.
506
+ attr_reader :type
507
+ end
508
+
509
+ class Receipt < Stripe::StripeObject
510
+ # The type of account being debited or credited
511
+ attr_reader :account_type
512
+ # EMV tag 9F26, cryptogram generated by the integrated circuit chip.
513
+ attr_reader :application_cryptogram
514
+ # Mnenomic of the Application Identifier.
515
+ attr_reader :application_preferred_name
516
+ # Identifier for this transaction.
517
+ attr_reader :authorization_code
518
+ # EMV tag 8A. A code returned by the card issuer.
519
+ attr_reader :authorization_response_code
520
+ # 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`.
521
+ attr_reader :cardholder_verification_method
522
+ # EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
523
+ attr_reader :dedicated_file_name
524
+ # The outcome of a series of EMV functions performed by the card reader.
525
+ attr_reader :terminal_verification_results
526
+ # An indication of various EMV functions performed during the transaction.
527
+ attr_reader :transaction_status_information
528
+ end
529
+
530
+ class Wallet < Stripe::StripeObject
531
+ # The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.
532
+ attr_reader :type
533
+ end
534
+ # The authorized amount
535
+ attr_reader :amount_authorized
536
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
537
+ attr_reader :brand
538
+ # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.
539
+ attr_reader :brand_product
540
+ # When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.
541
+ attr_reader :capture_before
542
+ # 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.
543
+ attr_reader :cardholder_name
544
+ # 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.
545
+ attr_reader :country
546
+ # 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.)
547
+ attr_reader :description
548
+ # Authorization response cryptogram.
549
+ attr_reader :emv_auth_data
550
+ # Two-digit number representing the card's expiration month.
551
+ attr_reader :exp_month
552
+ # Four-digit number representing the card's expiration year.
553
+ attr_reader :exp_year
554
+ # 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.
555
+ #
556
+ # *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.*
557
+ attr_reader :fingerprint
558
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
559
+ attr_reader :funding
560
+ # 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.
561
+ attr_reader :generated_card
562
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
563
+ attr_reader :iin
564
+ # 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).
565
+ attr_reader :incremental_authorization_supported
566
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
567
+ attr_reader :issuer
568
+ # The last four digits of the card.
569
+ attr_reader :last4
570
+ # 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`.
571
+ attr_reader :network
572
+ # 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.
573
+ attr_reader :network_transaction_id
574
+ # Details about payments collected offline.
575
+ attr_reader :offline
576
+ # Defines whether the authorized amount can be over-captured or not
577
+ attr_reader :overcapture_supported
578
+ # EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
579
+ attr_reader :preferred_locales
580
+ # How card details were read in this transaction.
581
+ attr_reader :read_method
582
+ # A collection of fields required to be displayed on receipts. Only required for EMV transactions.
583
+ attr_reader :receipt
584
+ # Attribute for field wallet
585
+ attr_reader :wallet
586
+ end
587
+
588
+ class Cashapp < Stripe::StripeObject
589
+ # A unique and immutable identifier assigned by Cash App to every buyer.
590
+ attr_reader :buyer_id
591
+ # A public identifier for buyers using Cash App.
592
+ attr_reader :cashtag
593
+ end
594
+
595
+ class CustomerBalance < Stripe::StripeObject; end
596
+
597
+ class Eps < Stripe::StripeObject
598
+ # 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`.
599
+ attr_reader :bank
600
+ # Owner's verified full name. Values are verified or provided by EPS directly
601
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
602
+ # EPS rarely provides this information so the attribute is usually empty.
603
+ attr_reader :verified_name
604
+ end
605
+
606
+ class Fpx < Stripe::StripeObject
607
+ # Account holder type, if provided. Can be one of `individual` or `company`.
608
+ attr_reader :account_holder_type
609
+ # 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`.
610
+ attr_reader :bank
611
+ # Unique transaction id generated by FPX for every request from the merchant
612
+ attr_reader :transaction_id
613
+ end
614
+
615
+ class Giropay < Stripe::StripeObject
616
+ # Bank code of bank associated with the bank account.
617
+ attr_reader :bank_code
618
+ # Name of the bank associated with the bank account.
619
+ attr_reader :bank_name
620
+ # Bank Identifier Code of the bank associated with the bank account.
621
+ attr_reader :bic
622
+ # Owner's verified full name. Values are verified or provided by Giropay directly
623
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
624
+ # Giropay rarely provides this information so the attribute is usually empty.
625
+ attr_reader :verified_name
626
+ end
627
+
628
+ class Grabpay < Stripe::StripeObject
629
+ # Unique transaction id generated by GrabPay
630
+ attr_reader :transaction_id
631
+ end
632
+
633
+ class Ideal < Stripe::StripeObject
634
+ # 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`.
635
+ attr_reader :bank
636
+ # The Bank Identifier Code of the customer's bank.
637
+ attr_reader :bic
638
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
639
+ attr_reader :generated_sepa_debit
640
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
641
+ attr_reader :generated_sepa_debit_mandate
642
+ # Last four characters of the IBAN.
643
+ attr_reader :iban_last4
644
+ # Owner's verified full name. Values are verified or provided by iDEAL directly
645
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
646
+ attr_reader :verified_name
647
+ end
648
+
649
+ class InteracPresent < Stripe::StripeObject
650
+ class Receipt < Stripe::StripeObject
651
+ # The type of account being debited or credited
652
+ attr_reader :account_type
653
+ # EMV tag 9F26, cryptogram generated by the integrated circuit chip.
654
+ attr_reader :application_cryptogram
655
+ # Mnenomic of the Application Identifier.
656
+ attr_reader :application_preferred_name
657
+ # Identifier for this transaction.
658
+ attr_reader :authorization_code
659
+ # EMV tag 8A. A code returned by the card issuer.
660
+ attr_reader :authorization_response_code
661
+ # 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`.
662
+ attr_reader :cardholder_verification_method
663
+ # EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.
664
+ attr_reader :dedicated_file_name
665
+ # The outcome of a series of EMV functions performed by the card reader.
666
+ attr_reader :terminal_verification_results
667
+ # An indication of various EMV functions performed during the transaction.
668
+ attr_reader :transaction_status_information
669
+ end
670
+ # Card brand. Can be `interac`, `mastercard` or `visa`.
671
+ attr_reader :brand
672
+ # 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.
673
+ attr_reader :cardholder_name
674
+ # 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.
675
+ attr_reader :country
676
+ # 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.)
677
+ attr_reader :description
678
+ # Authorization response cryptogram.
679
+ attr_reader :emv_auth_data
680
+ # Two-digit number representing the card's expiration month.
681
+ attr_reader :exp_month
682
+ # Four-digit number representing the card's expiration year.
683
+ attr_reader :exp_year
684
+ # 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.
685
+ #
686
+ # *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.*
687
+ attr_reader :fingerprint
688
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
689
+ attr_reader :funding
690
+ # 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.
691
+ attr_reader :generated_card
692
+ # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
693
+ attr_reader :iin
694
+ # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
695
+ attr_reader :issuer
696
+ # The last four digits of the card.
697
+ attr_reader :last4
698
+ # 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`.
699
+ attr_reader :network
700
+ # 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.
701
+ attr_reader :network_transaction_id
702
+ # EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.
703
+ attr_reader :preferred_locales
704
+ # How card details were read in this transaction.
705
+ attr_reader :read_method
706
+ # A collection of fields required to be displayed on receipts. Only required for EMV transactions.
707
+ attr_reader :receipt
708
+ end
709
+
710
+ class KakaoPay < Stripe::StripeObject
711
+ # A unique identifier for the buyer as determined by the local payment processor.
712
+ attr_reader :buyer_id
713
+ end
714
+
715
+ class Klarna < Stripe::StripeObject
716
+ class PayerDetails < Stripe::StripeObject
717
+ class Address < Stripe::StripeObject
718
+ # The payer address country
719
+ attr_reader :country
720
+ end
721
+ # The payer's address
722
+ attr_reader :address
723
+ end
724
+ # The payer details for this transaction.
725
+ attr_reader :payer_details
726
+ # The Klarna payment method used for this transaction.
727
+ # Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`
728
+ attr_reader :payment_method_category
729
+ # Preferred language of the Klarna authorization page that the customer is redirected to.
730
+ # 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`
731
+ attr_reader :preferred_locale
732
+ end
733
+
734
+ class Konbini < Stripe::StripeObject
735
+ class Store < Stripe::StripeObject
736
+ # The name of the convenience store chain where the payment was completed.
737
+ attr_reader :chain
738
+ end
739
+ # If the payment succeeded, this contains the details of the convenience store where the payment was completed.
740
+ attr_reader :store
741
+ end
742
+
743
+ class KrCard < Stripe::StripeObject
744
+ # The local credit or debit card brand.
745
+ attr_reader :brand
746
+ # A unique identifier for the buyer as determined by the local payment processor.
747
+ attr_reader :buyer_id
748
+ # The last four digits of the card. This may not be present for American Express cards.
749
+ attr_reader :last4
750
+ end
751
+
752
+ class Link < Stripe::StripeObject
753
+ # Two-letter ISO code representing the funding source country beneath the Link payment.
754
+ # You could use this attribute to get a sense of international fees.
755
+ attr_reader :country
756
+ end
757
+
758
+ class Mobilepay < Stripe::StripeObject
759
+ class Card < Stripe::StripeObject
760
+ # Brand of the card used in the transaction
761
+ attr_reader :brand
762
+ # Two-letter ISO code representing the country of the card
763
+ attr_reader :country
764
+ # Two digit number representing the card's expiration month
765
+ attr_reader :exp_month
766
+ # Two digit number representing the card's expiration year
767
+ attr_reader :exp_year
768
+ # The last 4 digits of the card
769
+ attr_reader :last4
770
+ end
771
+ # Internal card details
772
+ attr_reader :card
773
+ end
774
+
775
+ class Multibanco < Stripe::StripeObject
776
+ # Entity number associated with this Multibanco payment.
777
+ attr_reader :entity
778
+ # Reference number associated with this Multibanco payment.
779
+ attr_reader :reference
780
+ end
781
+
782
+ class NaverPay < Stripe::StripeObject
783
+ # A unique identifier for the buyer as determined by the local payment processor.
784
+ attr_reader :buyer_id
785
+ end
786
+
787
+ class NzBankAccount < Stripe::StripeObject
788
+ # 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.
789
+ attr_reader :account_holder_name
790
+ # The numeric code for the bank account's bank.
791
+ attr_reader :bank_code
792
+ # The name of the bank.
793
+ attr_reader :bank_name
794
+ # The numeric code for the bank account's bank branch.
795
+ attr_reader :branch_code
796
+ # Last four digits of the bank account number.
797
+ attr_reader :last4
798
+ # The suffix of the bank account number.
799
+ attr_reader :suffix
800
+ end
801
+
802
+ class Oxxo < Stripe::StripeObject
803
+ # OXXO reference number
804
+ attr_reader :number
805
+ end
806
+
807
+ class P24 < Stripe::StripeObject
808
+ # 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`.
809
+ attr_reader :bank
810
+ # Unique reference for this Przelewy24 payment.
811
+ attr_reader :reference
812
+ # Owner's verified full name. Values are verified or provided by Przelewy24 directly
813
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
814
+ # Przelewy24 rarely provides this information so the attribute is usually empty.
815
+ attr_reader :verified_name
816
+ end
817
+
818
+ class PayByBank < Stripe::StripeObject; end
819
+
820
+ class Payco < Stripe::StripeObject
821
+ # A unique identifier for the buyer as determined by the local payment processor.
822
+ attr_reader :buyer_id
823
+ end
824
+
825
+ class Paynow < Stripe::StripeObject
826
+ # Reference number associated with this PayNow payment
827
+ attr_reader :reference
828
+ end
829
+
830
+ class Paypal < Stripe::StripeObject
831
+ class SellerProtection < Stripe::StripeObject
832
+ # An array of conditions that are covered for the transaction, if applicable.
833
+ attr_reader :dispute_categories
834
+ # Indicates whether the transaction is eligible for PayPal's seller protection.
835
+ attr_reader :status
836
+ end
837
+ # 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.
838
+ attr_reader :country
839
+ # Owner's email. Values are provided by PayPal directly
840
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
841
+ attr_reader :payer_email
842
+ # PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
843
+ attr_reader :payer_id
844
+ # Owner's full name. Values provided by PayPal directly
845
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
846
+ attr_reader :payer_name
847
+ # The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
848
+ attr_reader :seller_protection
849
+ # A unique ID generated by PayPal for this transaction.
850
+ attr_reader :transaction_id
851
+ end
852
+
853
+ class Pix < Stripe::StripeObject
854
+ # Unique transaction id generated by BCB
855
+ attr_reader :bank_transaction_id
856
+ end
857
+
858
+ class Promptpay < Stripe::StripeObject
859
+ # Bill reference generated by PromptPay
860
+ attr_reader :reference
861
+ end
862
+
863
+ class RevolutPay < Stripe::StripeObject
864
+ class Funding < Stripe::StripeObject
865
+ class Card < Stripe::StripeObject
866
+ # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
867
+ attr_reader :brand
868
+ # 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.
869
+ attr_reader :country
870
+ # Two-digit number representing the card's expiration month.
871
+ attr_reader :exp_month
872
+ # Four-digit number representing the card's expiration year.
873
+ attr_reader :exp_year
874
+ # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
875
+ attr_reader :funding
876
+ # The last four digits of the card.
877
+ attr_reader :last4
878
+ end
879
+ # Attribute for field card
880
+ attr_reader :card
881
+ # funding type of the underlying payment method.
882
+ attr_reader :type
883
+ end
884
+ # Attribute for field funding
885
+ attr_reader :funding
886
+ end
887
+
888
+ class SamsungPay < Stripe::StripeObject
889
+ # A unique identifier for the buyer as determined by the local payment processor.
890
+ attr_reader :buyer_id
891
+ end
892
+
893
+ class Satispay < Stripe::StripeObject; end
894
+
895
+ class SepaCreditTransfer < Stripe::StripeObject
896
+ # Name of the bank associated with the bank account.
897
+ attr_reader :bank_name
898
+ # Bank Identifier Code of the bank associated with the bank account.
899
+ attr_reader :bic
900
+ # IBAN of the bank account to transfer funds to.
901
+ attr_reader :iban
902
+ end
903
+
904
+ class SepaDebit < Stripe::StripeObject
905
+ # Bank code of bank associated with the bank account.
906
+ attr_reader :bank_code
907
+ # Branch code of bank associated with the bank account.
908
+ attr_reader :branch_code
909
+ # Two-letter ISO code representing the country the bank account is located in.
910
+ attr_reader :country
911
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
912
+ attr_reader :fingerprint
913
+ # Last four characters of the IBAN.
914
+ attr_reader :last4
915
+ # 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).
916
+ attr_reader :mandate
917
+ end
918
+
919
+ class Sofort < Stripe::StripeObject
920
+ # Bank code of bank associated with the bank account.
921
+ attr_reader :bank_code
922
+ # Name of the bank associated with the bank account.
923
+ attr_reader :bank_name
924
+ # Bank Identifier Code of the bank associated with the bank account.
925
+ attr_reader :bic
926
+ # Two-letter ISO code representing the country the bank account is located in.
927
+ attr_reader :country
928
+ # The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.
929
+ attr_reader :generated_sepa_debit
930
+ # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.
931
+ attr_reader :generated_sepa_debit_mandate
932
+ # Last four characters of the IBAN.
933
+ attr_reader :iban_last4
934
+ # Preferred language of the SOFORT authorization page that the customer is redirected to.
935
+ # Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`
936
+ attr_reader :preferred_language
937
+ # Owner's verified full name. Values are verified or provided by SOFORT directly
938
+ # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
939
+ attr_reader :verified_name
940
+ end
941
+
942
+ class StripeAccount < Stripe::StripeObject; end
943
+
944
+ class Swish < Stripe::StripeObject
945
+ # 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
946
+ attr_reader :fingerprint
947
+ # Payer bank reference number for the payment
948
+ attr_reader :payment_reference
949
+ # The last four digits of the Swish account phone number
950
+ attr_reader :verified_phone_last4
951
+ end
952
+
953
+ class Twint < Stripe::StripeObject; end
954
+
955
+ class UsBankAccount < Stripe::StripeObject
956
+ # Account holder type: individual or company.
957
+ attr_reader :account_holder_type
958
+ # Account type: checkings or savings. Defaults to checking if omitted.
959
+ attr_reader :account_type
960
+ # Name of the bank associated with the bank account.
961
+ attr_reader :bank_name
962
+ # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
963
+ attr_reader :fingerprint
964
+ # Last four digits of the bank account number.
965
+ attr_reader :last4
966
+ # ID of the mandate used to make this payment.
967
+ attr_reader :mandate
968
+ # Reference number to locate ACH payments with customer's bank.
969
+ attr_reader :payment_reference
970
+ # Routing number of the bank account.
971
+ attr_reader :routing_number
972
+ end
973
+
974
+ class Wechat < Stripe::StripeObject; end
975
+
976
+ class WechatPay < Stripe::StripeObject
977
+ # Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
978
+ attr_reader :fingerprint
979
+ # Transaction ID of this particular WeChat Pay transaction.
980
+ attr_reader :transaction_id
981
+ end
982
+
983
+ class Zip < Stripe::StripeObject; end
984
+ # Attribute for field ach_credit_transfer
985
+ attr_reader :ach_credit_transfer
986
+ # Attribute for field ach_debit
987
+ attr_reader :ach_debit
988
+ # Attribute for field acss_debit
989
+ attr_reader :acss_debit
990
+ # Attribute for field affirm
991
+ attr_reader :affirm
992
+ # Attribute for field afterpay_clearpay
993
+ attr_reader :afterpay_clearpay
994
+ # Attribute for field alipay
995
+ attr_reader :alipay
996
+ # Attribute for field alma
997
+ attr_reader :alma
998
+ # Attribute for field amazon_pay
999
+ attr_reader :amazon_pay
1000
+ # Attribute for field au_becs_debit
1001
+ attr_reader :au_becs_debit
1002
+ # Attribute for field bacs_debit
1003
+ attr_reader :bacs_debit
1004
+ # Attribute for field bancontact
1005
+ attr_reader :bancontact
1006
+ # Attribute for field billie
1007
+ attr_reader :billie
1008
+ # Attribute for field blik
1009
+ attr_reader :blik
1010
+ # Attribute for field boleto
1011
+ attr_reader :boleto
1012
+ # Attribute for field card
1013
+ attr_reader :card
1014
+ # Attribute for field card_present
1015
+ attr_reader :card_present
1016
+ # Attribute for field cashapp
1017
+ attr_reader :cashapp
1018
+ # Attribute for field customer_balance
1019
+ attr_reader :customer_balance
1020
+ # Attribute for field eps
1021
+ attr_reader :eps
1022
+ # Attribute for field fpx
1023
+ attr_reader :fpx
1024
+ # Attribute for field giropay
1025
+ attr_reader :giropay
1026
+ # Attribute for field grabpay
1027
+ attr_reader :grabpay
1028
+ # Attribute for field ideal
1029
+ attr_reader :ideal
1030
+ # Attribute for field interac_present
1031
+ attr_reader :interac_present
1032
+ # Attribute for field kakao_pay
1033
+ attr_reader :kakao_pay
1034
+ # Attribute for field klarna
1035
+ attr_reader :klarna
1036
+ # Attribute for field konbini
1037
+ attr_reader :konbini
1038
+ # Attribute for field kr_card
1039
+ attr_reader :kr_card
1040
+ # Attribute for field link
1041
+ attr_reader :link
1042
+ # Attribute for field mobilepay
1043
+ attr_reader :mobilepay
1044
+ # Attribute for field multibanco
1045
+ attr_reader :multibanco
1046
+ # Attribute for field naver_pay
1047
+ attr_reader :naver_pay
1048
+ # Attribute for field nz_bank_account
1049
+ attr_reader :nz_bank_account
1050
+ # Attribute for field oxxo
1051
+ attr_reader :oxxo
1052
+ # Attribute for field p24
1053
+ attr_reader :p24
1054
+ # Attribute for field pay_by_bank
1055
+ attr_reader :pay_by_bank
1056
+ # Attribute for field payco
1057
+ attr_reader :payco
1058
+ # Attribute for field paynow
1059
+ attr_reader :paynow
1060
+ # Attribute for field paypal
1061
+ attr_reader :paypal
1062
+ # Attribute for field pix
1063
+ attr_reader :pix
1064
+ # Attribute for field promptpay
1065
+ attr_reader :promptpay
1066
+ # Attribute for field revolut_pay
1067
+ attr_reader :revolut_pay
1068
+ # Attribute for field samsung_pay
1069
+ attr_reader :samsung_pay
1070
+ # Attribute for field satispay
1071
+ attr_reader :satispay
1072
+ # Attribute for field sepa_credit_transfer
1073
+ attr_reader :sepa_credit_transfer
1074
+ # Attribute for field sepa_debit
1075
+ attr_reader :sepa_debit
1076
+ # Attribute for field sofort
1077
+ attr_reader :sofort
1078
+ # Attribute for field stripe_account
1079
+ attr_reader :stripe_account
1080
+ # Attribute for field swish
1081
+ attr_reader :swish
1082
+ # Attribute for field twint
1083
+ attr_reader :twint
1084
+ # 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.
1085
+ # An additional hash is included on `payment_method_details` with a name matching this value.
1086
+ # It contains information specific to the payment method.
1087
+ attr_reader :type
1088
+ # Attribute for field us_bank_account
1089
+ attr_reader :us_bank_account
1090
+ # Attribute for field wechat
1091
+ attr_reader :wechat
1092
+ # Attribute for field wechat_pay
1093
+ attr_reader :wechat_pay
1094
+ # Attribute for field zip
1095
+ attr_reader :zip
1096
+ end
1097
+
1098
+ class PresentmentDetails < Stripe::StripeObject
1099
+ # Amount intended to be collected by this payment, denominated in presentment_currency.
1100
+ attr_reader :presentment_amount
1101
+ # Currency presented to the customer during payment.
1102
+ attr_reader :presentment_currency
1103
+ end
1104
+
1105
+ class RadarOptions < Stripe::StripeObject
1106
+ # 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.
1107
+ attr_reader :session
1108
+ end
1109
+
1110
+ class Shipping < Stripe::StripeObject
1111
+ class Address < Stripe::StripeObject
1112
+ # City, district, suburb, town, or village.
1113
+ attr_reader :city
1114
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1115
+ attr_reader :country
1116
+ # Address line 1 (e.g., street, PO Box, or company name).
1117
+ attr_reader :line1
1118
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1119
+ attr_reader :line2
1120
+ # ZIP or postal code.
1121
+ attr_reader :postal_code
1122
+ # State, county, province, or region.
1123
+ attr_reader :state
1124
+ end
1125
+ # Attribute for field address
1126
+ attr_reader :address
1127
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1128
+ attr_reader :carrier
1129
+ # Recipient name.
1130
+ attr_reader :name
1131
+ # Recipient phone (including extension).
1132
+ attr_reader :phone
1133
+ # 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.
1134
+ attr_reader :tracking_number
1135
+ end
1136
+
1137
+ class TransferData < Stripe::StripeObject
1138
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1139
+ attr_reader :amount
1140
+ # ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.
1141
+ attr_reader :destination
1142
+ end
1143
+
1144
+ class ListParams < Stripe::RequestParams
1145
+ class Created < Stripe::RequestParams
1146
+ # Minimum value to filter by (exclusive)
1147
+ attr_accessor :gt
1148
+ # Minimum value to filter by (inclusive)
1149
+ attr_accessor :gte
1150
+ # Maximum value to filter by (exclusive)
1151
+ attr_accessor :lt
1152
+ # Maximum value to filter by (inclusive)
1153
+ attr_accessor :lte
1154
+
1155
+ def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
1156
+ @gt = gt
1157
+ @gte = gte
1158
+ @lt = lt
1159
+ @lte = lte
1160
+ end
1161
+ end
1162
+ # Only return charges that were created during the given date interval.
1163
+ attr_accessor :created
1164
+ # Only return charges for the customer specified by this customer ID.
1165
+ attr_accessor :customer
1166
+ # 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.
1167
+ attr_accessor :ending_before
1168
+ # Specifies which fields in the response should be expanded.
1169
+ attr_accessor :expand
1170
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1171
+ attr_accessor :limit
1172
+ # Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
1173
+ attr_accessor :payment_intent
1174
+ # 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.
1175
+ attr_accessor :starting_after
1176
+ # Only return charges for this transfer group, limited to 100.
1177
+ attr_accessor :transfer_group
1178
+
1179
+ def initialize(
1180
+ created: nil,
1181
+ customer: nil,
1182
+ ending_before: nil,
1183
+ expand: nil,
1184
+ limit: nil,
1185
+ payment_intent: nil,
1186
+ starting_after: nil,
1187
+ transfer_group: nil
1188
+ )
1189
+ @created = created
1190
+ @customer = customer
1191
+ @ending_before = ending_before
1192
+ @expand = expand
1193
+ @limit = limit
1194
+ @payment_intent = payment_intent
1195
+ @starting_after = starting_after
1196
+ @transfer_group = transfer_group
1197
+ end
1198
+ end
1199
+
1200
+ class CreateParams < Stripe::RequestParams
1201
+ class Destination < Stripe::RequestParams
1202
+ # ID of an existing, connected Stripe account.
1203
+ attr_accessor :account
1204
+ # 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.
1205
+ attr_accessor :amount
1206
+
1207
+ def initialize(account: nil, amount: nil)
1208
+ @account = account
1209
+ @amount = amount
1210
+ end
1211
+ end
1212
+
1213
+ class RadarOptions < Stripe::RequestParams
1214
+ # 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.
1215
+ attr_accessor :session
1216
+
1217
+ def initialize(session: nil)
1218
+ @session = session
1219
+ end
1220
+ end
1221
+
1222
+ class Shipping < Stripe::RequestParams
1223
+ class Address < Stripe::RequestParams
1224
+ # City, district, suburb, town, or village.
1225
+ attr_accessor :city
1226
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1227
+ attr_accessor :country
1228
+ # Address line 1 (e.g., street, PO Box, or company name).
1229
+ attr_accessor :line1
1230
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1231
+ attr_accessor :line2
1232
+ # ZIP or postal code.
1233
+ attr_accessor :postal_code
1234
+ # State, county, province, or region.
1235
+ attr_accessor :state
1236
+
1237
+ def initialize(
1238
+ city: nil,
1239
+ country: nil,
1240
+ line1: nil,
1241
+ line2: nil,
1242
+ postal_code: nil,
1243
+ state: nil
1244
+ )
1245
+ @city = city
1246
+ @country = country
1247
+ @line1 = line1
1248
+ @line2 = line2
1249
+ @postal_code = postal_code
1250
+ @state = state
1251
+ end
1252
+ end
1253
+ # Shipping address.
1254
+ attr_accessor :address
1255
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1256
+ attr_accessor :carrier
1257
+ # Recipient name.
1258
+ attr_accessor :name
1259
+ # Recipient phone (including extension).
1260
+ attr_accessor :phone
1261
+ # 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.
1262
+ attr_accessor :tracking_number
1263
+
1264
+ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil)
1265
+ @address = address
1266
+ @carrier = carrier
1267
+ @name = name
1268
+ @phone = phone
1269
+ @tracking_number = tracking_number
1270
+ end
1271
+ end
1272
+
1273
+ class TransferData < Stripe::RequestParams
1274
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1275
+ attr_accessor :amount
1276
+ # ID of an existing, connected Stripe account.
1277
+ attr_accessor :destination
1278
+
1279
+ def initialize(amount: nil, destination: nil)
1280
+ @amount = amount
1281
+ @destination = destination
1282
+ end
1283
+ end
1284
+ # 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).
1285
+ attr_accessor :amount
1286
+ # Attribute for param field application_fee
1287
+ attr_accessor :application_fee
1288
+ # 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).
1289
+ attr_accessor :application_fee_amount
1290
+ # 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.
1291
+ attr_accessor :capture
1292
+ # 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).
1293
+ attr_accessor :currency
1294
+ # The ID of an existing customer that will be charged in this request.
1295
+ attr_accessor :customer
1296
+ # 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.
1297
+ attr_accessor :description
1298
+ # Attribute for param field destination
1299
+ attr_accessor :destination
1300
+ # Specifies which fields in the response should be expanded.
1301
+ attr_accessor :expand
1302
+ # 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`.
1303
+ attr_accessor :metadata
1304
+ # 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).
1305
+ attr_accessor :on_behalf_of
1306
+ # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1307
+ attr_accessor :radar_options
1308
+ # 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).
1309
+ attr_accessor :receipt_email
1310
+ # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
1311
+ attr_accessor :shipping
1312
+ # 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.
1313
+ attr_accessor :source
1314
+ # 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).
1315
+ #
1316
+ # 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.
1317
+ attr_accessor :statement_descriptor
1318
+ # 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.
1319
+ attr_accessor :statement_descriptor_suffix
1320
+ # 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.
1321
+ attr_accessor :transfer_data
1322
+ # 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).
1323
+ attr_accessor :transfer_group
1324
+
1325
+ def initialize(
1326
+ amount: nil,
1327
+ application_fee: nil,
1328
+ application_fee_amount: nil,
1329
+ capture: nil,
1330
+ currency: nil,
1331
+ customer: nil,
1332
+ description: nil,
1333
+ destination: nil,
1334
+ expand: nil,
1335
+ metadata: nil,
1336
+ on_behalf_of: nil,
1337
+ radar_options: nil,
1338
+ receipt_email: nil,
1339
+ shipping: nil,
1340
+ source: nil,
1341
+ statement_descriptor: nil,
1342
+ statement_descriptor_suffix: nil,
1343
+ transfer_data: nil,
1344
+ transfer_group: nil
1345
+ )
1346
+ @amount = amount
1347
+ @application_fee = application_fee
1348
+ @application_fee_amount = application_fee_amount
1349
+ @capture = capture
1350
+ @currency = currency
1351
+ @customer = customer
1352
+ @description = description
1353
+ @destination = destination
1354
+ @expand = expand
1355
+ @metadata = metadata
1356
+ @on_behalf_of = on_behalf_of
1357
+ @radar_options = radar_options
1358
+ @receipt_email = receipt_email
1359
+ @shipping = shipping
1360
+ @source = source
1361
+ @statement_descriptor = statement_descriptor
1362
+ @statement_descriptor_suffix = statement_descriptor_suffix
1363
+ @transfer_data = transfer_data
1364
+ @transfer_group = transfer_group
1365
+ end
1366
+ end
1367
+
1368
+ class UpdateParams < Stripe::RequestParams
1369
+ class FraudDetails < Stripe::RequestParams
1370
+ # Either `safe` or `fraudulent`.
1371
+ attr_accessor :user_report
1372
+
1373
+ def initialize(user_report: nil)
1374
+ @user_report = user_report
1375
+ end
1376
+ end
1377
+
1378
+ class Shipping < Stripe::RequestParams
1379
+ class Address < Stripe::RequestParams
1380
+ # City, district, suburb, town, or village.
1381
+ attr_accessor :city
1382
+ # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1383
+ attr_accessor :country
1384
+ # Address line 1 (e.g., street, PO Box, or company name).
1385
+ attr_accessor :line1
1386
+ # Address line 2 (e.g., apartment, suite, unit, or building).
1387
+ attr_accessor :line2
1388
+ # ZIP or postal code.
1389
+ attr_accessor :postal_code
1390
+ # State, county, province, or region.
1391
+ attr_accessor :state
1392
+
1393
+ def initialize(
1394
+ city: nil,
1395
+ country: nil,
1396
+ line1: nil,
1397
+ line2: nil,
1398
+ postal_code: nil,
1399
+ state: nil
1400
+ )
1401
+ @city = city
1402
+ @country = country
1403
+ @line1 = line1
1404
+ @line2 = line2
1405
+ @postal_code = postal_code
1406
+ @state = state
1407
+ end
1408
+ end
1409
+ # Shipping address.
1410
+ attr_accessor :address
1411
+ # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
1412
+ attr_accessor :carrier
1413
+ # Recipient name.
1414
+ attr_accessor :name
1415
+ # Recipient phone (including extension).
1416
+ attr_accessor :phone
1417
+ # 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.
1418
+ attr_accessor :tracking_number
1419
+
1420
+ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_number: nil)
1421
+ @address = address
1422
+ @carrier = carrier
1423
+ @name = name
1424
+ @phone = phone
1425
+ @tracking_number = tracking_number
1426
+ end
1427
+ end
1428
+ # 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.
1429
+ attr_accessor :customer
1430
+ # 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.
1431
+ attr_accessor :description
1432
+ # Specifies which fields in the response should be expanded.
1433
+ attr_accessor :expand
1434
+ # 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.
1435
+ attr_accessor :fraud_details
1436
+ # 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`.
1437
+ attr_accessor :metadata
1438
+ # 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.
1439
+ attr_accessor :receipt_email
1440
+ # Shipping information for the charge. Helps prevent fraud on charges for physical goods.
1441
+ attr_accessor :shipping
1442
+ # 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.
1443
+ attr_accessor :transfer_group
1444
+
1445
+ def initialize(
1446
+ customer: nil,
1447
+ description: nil,
1448
+ expand: nil,
1449
+ fraud_details: nil,
1450
+ metadata: nil,
1451
+ receipt_email: nil,
1452
+ shipping: nil,
1453
+ transfer_group: nil
1454
+ )
1455
+ @customer = customer
1456
+ @description = description
1457
+ @expand = expand
1458
+ @fraud_details = fraud_details
1459
+ @metadata = metadata
1460
+ @receipt_email = receipt_email
1461
+ @shipping = shipping
1462
+ @transfer_group = transfer_group
1463
+ end
1464
+ end
1465
+
1466
+ class SearchParams < Stripe::RequestParams
1467
+ # Specifies which fields in the response should be expanded.
1468
+ attr_accessor :expand
1469
+ # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1470
+ attr_accessor :limit
1471
+ # 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.
1472
+ attr_accessor :page
1473
+ # 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).
1474
+ attr_accessor :query
1475
+
1476
+ def initialize(expand: nil, limit: nil, page: nil, query: nil)
1477
+ @expand = expand
1478
+ @limit = limit
1479
+ @page = page
1480
+ @query = query
1481
+ end
1482
+ end
1483
+
1484
+ class CaptureParams < Stripe::RequestParams
1485
+ class TransferData < Stripe::RequestParams
1486
+ # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
1487
+ attr_accessor :amount
1488
+
1489
+ def initialize(amount: nil)
1490
+ @amount = amount
1491
+ end
1492
+ end
1493
+ # The amount to capture, which must be less than or equal to the original amount.
1494
+ attr_accessor :amount
1495
+ # An application fee to add on to this charge.
1496
+ attr_accessor :application_fee
1497
+ # An application fee amount to add on to this charge, which must be less than or equal to the original amount.
1498
+ attr_accessor :application_fee_amount
1499
+ # Specifies which fields in the response should be expanded.
1500
+ attr_accessor :expand
1501
+ # 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.
1502
+ attr_accessor :receipt_email
1503
+ # 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).
1504
+ #
1505
+ # 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.
1506
+ attr_accessor :statement_descriptor
1507
+ # 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.
1508
+ attr_accessor :statement_descriptor_suffix
1509
+ # 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.
1510
+ attr_accessor :transfer_data
1511
+ # 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.
1512
+ attr_accessor :transfer_group
1513
+
1514
+ def initialize(
1515
+ amount: nil,
1516
+ application_fee: nil,
1517
+ application_fee_amount: nil,
1518
+ expand: nil,
1519
+ receipt_email: nil,
1520
+ statement_descriptor: nil,
1521
+ statement_descriptor_suffix: nil,
1522
+ transfer_data: nil,
1523
+ transfer_group: nil
1524
+ )
1525
+ @amount = amount
1526
+ @application_fee = application_fee
1527
+ @application_fee_amount = application_fee_amount
1528
+ @expand = expand
1529
+ @receipt_email = receipt_email
1530
+ @statement_descriptor = statement_descriptor
1531
+ @statement_descriptor_suffix = statement_descriptor_suffix
1532
+ @transfer_data = transfer_data
1533
+ @transfer_group = transfer_group
1534
+ end
1535
+ end
1536
+ # 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).
1537
+ attr_reader :amount
1538
+ # Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
1539
+ attr_reader :amount_captured
1540
+ # Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
1541
+ attr_reader :amount_refunded
1542
+ # ID of the Connect application that created the charge.
1543
+ attr_reader :application
1544
+ # The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
1545
+ attr_reader :application_fee
1546
+ # 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.
1547
+ attr_reader :application_fee_amount
1548
+ # Authorization code on the charge.
1549
+ attr_reader :authorization_code
1550
+ # ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
1551
+ attr_reader :balance_transaction
1552
+ # Attribute for field billing_details
1553
+ attr_reader :billing_details
1554
+ # 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.
1555
+ attr_reader :calculated_statement_descriptor
1556
+ # If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
1557
+ attr_reader :captured
1558
+ # Time at which the object was created. Measured in seconds since the Unix epoch.
1559
+ attr_reader :created
1560
+ # 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).
1561
+ attr_reader :currency
1562
+ # ID of the customer this charge is for if one exists.
1563
+ attr_reader :customer
1564
+ # An arbitrary string attached to the object. Often useful for displaying to users.
1565
+ attr_reader :description
1566
+ # Whether the charge has been disputed.
1567
+ attr_reader :disputed
1568
+ # ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
1569
+ attr_reader :failure_balance_transaction
1570
+ # Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).
1571
+ attr_reader :failure_code
1572
+ # Message to user further explaining reason for charge failure if available.
1573
+ attr_reader :failure_message
1574
+ # Information on fraud assessments for the charge.
1575
+ attr_reader :fraud_details
1576
+ # Unique identifier for the object.
1577
+ attr_reader :id
1578
+ # Attribute for field level3
1579
+ attr_reader :level3
1580
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
1581
+ attr_reader :livemode
1582
+ # 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.
1583
+ attr_reader :metadata
1584
+ # String representing the object's type. Objects of the same type share the same value.
1585
+ attr_reader :object
1586
+ # 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.
1587
+ attr_reader :on_behalf_of
1588
+ # Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
1589
+ attr_reader :outcome
1590
+ # `true` if the charge succeeded, or was successfully authorized for later capture.
1591
+ attr_reader :paid
1592
+ # ID of the PaymentIntent associated with this charge, if one exists.
1593
+ attr_reader :payment_intent
1594
+ # ID of the payment method used in this charge.
1595
+ attr_reader :payment_method
1596
+ # Details about the payment method at the time of the transaction.
1597
+ attr_reader :payment_method_details
1598
+ # Attribute for field presentment_details
1599
+ attr_reader :presentment_details
1600
+ # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1601
+ attr_reader :radar_options
1602
+ # This is the email address that the receipt for this charge was sent to.
1603
+ attr_reader :receipt_email
1604
+ # 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.
1605
+ attr_reader :receipt_number
1606
+ # 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.
1607
+ attr_reader :receipt_url
1608
+ # Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
1609
+ attr_reader :refunded
1610
+ # A list of refunds that have been applied to the charge.
1611
+ attr_reader :refunds
1612
+ # ID of the review associated with this charge if one exists.
1613
+ attr_reader :review
1614
+ # Shipping information for the charge.
1615
+ attr_reader :shipping
1616
+ # 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.
1617
+ attr_reader :source
1618
+ # 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.
1619
+ attr_reader :source_transfer
1620
+ # 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).
1621
+ #
1622
+ # 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.
1623
+ attr_reader :statement_descriptor
1624
+ # 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.
1625
+ attr_reader :statement_descriptor_suffix
1626
+ # The status of the payment is either `succeeded`, `pending`, or `failed`.
1627
+ attr_reader :status
1628
+ # ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
1629
+ attr_reader :transfer
1630
+ # 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.
1631
+ attr_reader :transfer_data
1632
+ # 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.
1633
+ attr_reader :transfer_group
1634
+
23
1635
  # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
24
1636
  #
25
1637
  # 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.