stripe 15.4.0 → 15.5.0.pre.beta.2

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