stripe 15.5.0 → 15.6.0.pre.alpha.2

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