stripe 15.0.0 → 15.1.0.pre.beta.1

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 (576) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1537 -676
  3. data/OPENAPI_VERSION +1 -1
  4. data/VERSION +1 -1
  5. data/lib/stripe/api_requestor.rb +28 -0
  6. data/lib/stripe/api_version.rb +1 -1
  7. data/lib/stripe/errors.rb +54 -0
  8. data/lib/stripe/event_types.rb +75 -0
  9. data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +23 -0
  10. data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +21 -0
  11. data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +23 -0
  12. data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +21 -0
  13. data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +23 -0
  14. data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +21 -0
  15. data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +21 -0
  16. data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_core_account_link_completed_event.rb +13 -0
  18. data/lib/stripe/events/v2_core_account_person_created_event.rb +23 -0
  19. data/lib/stripe/events/v2_core_account_person_deleted_event.rb +23 -0
  20. data/lib/stripe/events/v2_core_account_person_updated_event.rb +23 -0
  21. data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +21 -0
  22. data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +21 -0
  23. data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +21 -0
  24. data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +23 -0
  25. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +21 -0
  26. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +21 -0
  27. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +21 -0
  28. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +21 -0
  29. data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +21 -0
  30. data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +21 -0
  31. data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +21 -0
  32. data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +21 -0
  33. data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +21 -0
  34. data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +21 -0
  35. data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +21 -0
  36. data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +21 -0
  37. data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +21 -0
  38. data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +21 -0
  39. data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +21 -0
  40. data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +23 -0
  41. data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +21 -0
  42. data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +21 -0
  43. data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +21 -0
  44. data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +21 -0
  45. data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +21 -0
  46. data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +21 -0
  47. data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +21 -0
  48. data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +21 -0
  49. data/lib/stripe/object_types.rb +51 -0
  50. data/lib/stripe/request_signing_authenticator.rb +79 -0
  51. data/lib/stripe/resources/account.rb +663 -1
  52. data/lib/stripe/resources/account_notice.rb +123 -0
  53. data/lib/stripe/resources/account_session.rb +299 -1
  54. data/lib/stripe/resources/balance_settings.rb +101 -0
  55. data/lib/stripe/resources/billing/credit_balance_summary.rb +2 -0
  56. data/lib/stripe/resources/billing/credit_balance_transaction.rb +4 -0
  57. data/lib/stripe/resources/billing/credit_grant.rb +10 -0
  58. data/lib/stripe/resources/billing/meter_error_report.rb +59 -0
  59. data/lib/stripe/resources/billing_portal/session.rb +6 -0
  60. data/lib/stripe/resources/capital/financing_offer.rb +179 -0
  61. data/lib/stripe/resources/capital/financing_summary.rb +55 -0
  62. data/lib/stripe/resources/capital/financing_transaction.rb +114 -0
  63. data/lib/stripe/resources/card.rb +2 -0
  64. data/lib/stripe/resources/cash_balance.rb +2 -0
  65. data/lib/stripe/resources/charge.rb +1454 -0
  66. data/lib/stripe/resources/checkout/session.rb +295 -7
  67. data/lib/stripe/resources/confirmation_token.rb +237 -3
  68. data/lib/stripe/resources/coupon.rb +1 -1
  69. data/lib/stripe/resources/credit_note.rb +10 -0
  70. data/lib/stripe/resources/credit_note_line_item.rb +9 -0
  71. data/lib/stripe/resources/customer.rb +2 -0
  72. data/lib/stripe/resources/customer_balance_transaction.rb +2 -0
  73. data/lib/stripe/resources/customer_cash_balance_transaction.rb +2 -0
  74. data/lib/stripe/resources/customer_session.rb +6 -1
  75. data/lib/stripe/resources/discount.rb +2 -0
  76. data/lib/stripe/resources/event.rb +33 -0
  77. data/lib/stripe/resources/financial_connections/account.rb +20 -1
  78. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +27 -0
  79. data/lib/stripe/resources/financial_connections/institution.rb +90 -0
  80. data/lib/stripe/resources/financial_connections/session.rb +62 -2
  81. data/lib/stripe/resources/gift_cards/card.rb +208 -0
  82. data/lib/stripe/resources/gift_cards/transaction.rb +272 -0
  83. data/lib/stripe/resources/identity/verification_session.rb +10 -0
  84. data/lib/stripe/resources/invoice.rb +1176 -16
  85. data/lib/stripe/resources/invoice_item.rb +78 -2
  86. data/lib/stripe/resources/invoice_line_item.rb +55 -1
  87. data/lib/stripe/resources/invoice_payment.rb +2 -53
  88. data/lib/stripe/resources/issuing/cardholder.rb +2 -1
  89. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +602 -0
  90. data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +82 -0
  91. data/lib/stripe/resources/issuing/fraud_liability_debit.rb +86 -0
  92. data/lib/stripe/resources/issuing/settlement.rb +53 -0
  93. data/lib/stripe/resources/issuing/transaction.rb +6 -0
  94. data/lib/stripe/resources/line_item.rb +37 -0
  95. data/lib/stripe/resources/login_link.rb +2 -1
  96. data/lib/stripe/resources/mandate.rb +24 -0
  97. data/lib/stripe/resources/margin.rb +115 -0
  98. data/lib/stripe/resources/order.rb +2859 -0
  99. data/lib/stripe/resources/payment_attempt_record.rb +1078 -0
  100. data/lib/stripe/resources/payment_intent.rb +5242 -440
  101. data/lib/stripe/resources/payment_method.rb +199 -4
  102. data/lib/stripe/resources/payment_method_configuration.rb +295 -0
  103. data/lib/stripe/resources/payment_method_domain.rb +13 -0
  104. data/lib/stripe/resources/payment_record.rb +1607 -0
  105. data/lib/stripe/resources/payout.rb +6 -0
  106. data/lib/stripe/resources/price.rb +30 -0
  107. data/lib/stripe/resources/privacy/redaction_job.rb +251 -0
  108. data/lib/stripe/resources/privacy/redaction_job_root_objects.rb +35 -0
  109. data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +54 -0
  110. data/lib/stripe/resources/product.rb +59 -0
  111. data/lib/stripe/resources/promotion_code.rb +10 -0
  112. data/lib/stripe/resources/quote.rb +2042 -6
  113. data/lib/stripe/resources/quote_line.rb +274 -0
  114. data/lib/stripe/resources/quote_preview_invoice.rb +663 -0
  115. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +337 -0
  116. data/lib/stripe/resources/refund.rb +9 -0
  117. data/lib/stripe/resources/setup_attempt.rb +21 -0
  118. data/lib/stripe/resources/setup_intent.rb +605 -18
  119. data/lib/stripe/resources/source.rb +30 -1
  120. data/lib/stripe/resources/subscription.rb +292 -9
  121. data/lib/stripe/resources/subscription_item.rb +84 -3
  122. data/lib/stripe/resources/subscription_schedule.rb +1007 -10
  123. data/lib/stripe/resources/tax/association.rb +89 -0
  124. data/lib/stripe/resources/tax/form.rb +211 -0
  125. data/lib/stripe/resources/tax/registration.rb +20 -0
  126. data/lib/stripe/resources/tax_id.rb +12 -2
  127. data/lib/stripe/resources/terminal/reader.rb +406 -0
  128. data/lib/stripe/resources/terminal/reader_collected_data.rb +31 -0
  129. data/lib/stripe/resources/treasury/financial_account.rb +22 -3
  130. data/lib/stripe/resources/treasury/financial_account_features.rb +2 -0
  131. data/lib/stripe/resources/treasury/outbound_transfer.rb +37 -0
  132. data/lib/stripe/resources/treasury/received_credit.rb +38 -1
  133. data/lib/stripe/resources/treasury/received_debit.rb +40 -1
  134. data/lib/stripe/resources/v2/core/account.rb +1715 -0
  135. data/lib/stripe/resources/v2/core/account_link.rb +54 -0
  136. data/lib/stripe/resources/v2/core/person.rb +272 -0
  137. data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +72 -0
  138. data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +37 -0
  139. data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +18 -0
  140. data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +20 -0
  141. data/lib/stripe/resources/v2/money_management/adjustment.rb +49 -0
  142. data/lib/stripe/resources/v2/money_management/financial_account.rb +56 -0
  143. data/lib/stripe/resources/v2/money_management/financial_address.rb +66 -0
  144. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +92 -0
  145. data/lib/stripe/resources/v2/money_management/outbound_payment.rb +127 -0
  146. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +74 -0
  147. data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +43 -0
  148. data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +115 -0
  149. data/lib/stripe/resources/v2/money_management/payout_method.rb +73 -0
  150. data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +47 -0
  151. data/lib/stripe/resources/v2/money_management/received_credit.rb +134 -0
  152. data/lib/stripe/resources/v2/money_management/received_debit.rb +106 -0
  153. data/lib/stripe/resources/v2/money_management/transaction.rb +76 -0
  154. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +66 -0
  155. data/lib/stripe/resources.rb +88 -0
  156. data/lib/stripe/services/account_notice_service.rb +101 -0
  157. data/lib/stripe/services/account_service.rb +570 -1
  158. data/lib/stripe/services/account_session_service.rb +269 -1
  159. data/lib/stripe/services/balance_settings_service.rb +96 -0
  160. data/lib/stripe/services/billing/credit_balance_summary_service.rb +4 -1
  161. data/lib/stripe/services/billing/credit_balance_transaction_service.rb +4 -0
  162. data/lib/stripe/services/billing/credit_grant_service.rb +8 -0
  163. data/lib/stripe/services/billing_portal/session_service.rb +4 -0
  164. data/lib/stripe/services/capital/financing_offer_service.rb +112 -0
  165. data/lib/stripe/services/capital/financing_summary_service.rb +28 -0
  166. data/lib/stripe/services/capital/financing_transaction_service.rb +79 -0
  167. data/lib/stripe/services/capital_service.rb +15 -0
  168. data/lib/stripe/services/charge_service.rb +1334 -0
  169. data/lib/stripe/services/checkout/session_service.rb +195 -4
  170. data/lib/stripe/services/credit_note_service.rb +4 -0
  171. data/lib/stripe/services/customer_session_service.rb +4 -1
  172. data/{rbi/stripe/services/account_external_account_service.rbi → lib/stripe/services/external_account_service.rb} +135 -123
  173. data/{rbi/stripe/services/tax/transaction_line_item_service.rbi → lib/stripe/services/financial_connections/account_inferred_balance_service.rb} +21 -17
  174. data/lib/stripe/services/financial_connections/account_service.rb +7 -2
  175. data/{rbi/stripe/services/climate/supplier_service.rbi → lib/stripe/services/financial_connections/institution_service.rb} +36 -25
  176. data/lib/stripe/services/financial_connections/session_service.rb +34 -2
  177. data/lib/stripe/services/financial_connections_service.rb +2 -1
  178. data/lib/stripe/services/gift_cards/card_service.rb +170 -0
  179. data/lib/stripe/services/gift_cards/transaction_service.rb +209 -0
  180. data/lib/stripe/services/gift_cards_service.rb +14 -0
  181. data/lib/stripe/services/identity/verification_session_service.rb +8 -0
  182. data/lib/stripe/services/invoice_item_service.rb +74 -2
  183. data/lib/stripe/services/invoice_line_item_service.rb +33 -1
  184. data/lib/stripe/services/invoice_payment_service.rb +5 -33
  185. data/lib/stripe/services/invoice_service.rb +1088 -17
  186. data/lib/stripe/services/issuing/cardholder_service.rb +2 -1
  187. data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +504 -0
  188. data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +66 -0
  189. data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +83 -0
  190. data/lib/stripe/services/issuing/transaction_service.rb +4 -0
  191. data/lib/stripe/services/issuing_service.rb +5 -1
  192. data/lib/stripe/services/margin_service.rb +119 -0
  193. data/{rbi/stripe/services/source_transaction_service.rbi → lib/stripe/services/order_line_item_service.rb} +20 -16
  194. data/lib/stripe/services/order_service.rb +2268 -0
  195. data/lib/stripe/services/payment_attempt_record_service.rb +49 -0
  196. data/lib/stripe/services/payment_intent_service.rb +4634 -261
  197. data/lib/stripe/services/payment_method_configuration_service.rb +210 -0
  198. data/lib/stripe/services/payment_method_service.rb +129 -4
  199. data/lib/stripe/services/payment_record_service.rb +542 -0
  200. data/lib/stripe/services/payout_service.rb +4 -0
  201. data/lib/stripe/services/price_service.rb +19 -0
  202. data/lib/stripe/services/privacy/redaction_job_service.rb +231 -0
  203. data/{rbi/stripe/services/climate/product_service.rbi → lib/stripe/services/privacy/redaction_job_validation_error_service.rb} +36 -25
  204. data/lib/stripe/services/privacy_service.rb +13 -0
  205. data/lib/stripe/services/product_service.rb +38 -0
  206. data/lib/stripe/services/promotion_code_service.rb +8 -0
  207. data/{rbi/stripe/services/quote_line_item_service.rbi → lib/stripe/services/quote_line_service.rb} +20 -16
  208. data/{rbi/stripe/services/credit_note_line_item_service.rbi → lib/stripe/services/quote_preview_invoice_service.rb} +20 -16
  209. data/{rbi/stripe/services/payment_link_line_item_service.rbi → lib/stripe/services/quote_preview_subscription_schedule_service.rb} +20 -16
  210. data/lib/stripe/services/quote_service.rb +1726 -7
  211. data/lib/stripe/services/setup_intent_service.rb +565 -18
  212. data/lib/stripe/services/subscription_item_service.rb +75 -3
  213. data/lib/stripe/services/subscription_schedule_service.rb +911 -10
  214. data/lib/stripe/services/subscription_service.rb +253 -9
  215. data/lib/stripe/services/tax/association_service.rb +31 -0
  216. data/lib/stripe/services/tax/form_service.rb +100 -0
  217. data/lib/stripe/services/tax/registration_service.rb +13 -0
  218. data/lib/stripe/services/tax_id_service.rb +8 -2
  219. data/lib/stripe/services/tax_service.rb +3 -1
  220. data/lib/stripe/services/terminal/reader_collected_data_service.rb +28 -0
  221. data/lib/stripe/services/terminal/reader_service.rb +180 -0
  222. data/lib/stripe/services/terminal_service.rb +2 -1
  223. data/lib/stripe/services/test_helpers/confirmation_token_service.rb +151 -3
  224. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
  225. data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +25 -1
  226. data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +25 -1
  227. data/lib/stripe/services/treasury/financial_account_features_service.rb +4 -1
  228. data/lib/stripe/services/treasury/financial_account_service.rb +16 -2
  229. data/lib/stripe/services/treasury/outbound_transfer_service.rb +24 -0
  230. data/lib/stripe/services/v1_services.rb +11 -2
  231. data/lib/stripe/services/v2/core/account_link_service.rb +76 -0
  232. data/lib/stripe/services/v2/core/account_service.rb +4130 -0
  233. data/lib/stripe/services/v2/core/accounts/person_service.rb +1040 -0
  234. data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +135 -0
  235. data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +109 -0
  236. data/lib/stripe/services/v2/core/vault_service.rb +18 -0
  237. data/lib/stripe/services/v2/core_service.rb +4 -1
  238. data/lib/stripe/services/v2/money_management/adjustment_service.rb +75 -0
  239. data/lib/stripe/services/v2/money_management/financial_account_service.rb +44 -0
  240. data/lib/stripe/services/v2/money_management/financial_address_service.rb +81 -0
  241. data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +126 -0
  242. data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +80 -0
  243. data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +202 -0
  244. data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +237 -0
  245. data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +174 -0
  246. data/lib/stripe/services/v2/money_management/payout_method_service.rb +95 -0
  247. data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +32 -0
  248. data/lib/stripe/services/v2/money_management/received_credit_service.rb +71 -0
  249. data/lib/stripe/services/v2/money_management/received_debit_service.rb +44 -0
  250. data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +70 -0
  251. data/lib/stripe/services/v2/money_management/transaction_service.rb +74 -0
  252. data/lib/stripe/services/v2/money_management_service.rb +31 -0
  253. data/lib/stripe/services/v2/test_helper_service.rb +15 -0
  254. data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +50 -0
  255. data/lib/stripe/services/v2_services.rb +4 -2
  256. data/lib/stripe/services.rb +52 -0
  257. data/lib/stripe/stripe_configuration.rb +3 -1
  258. data/lib/stripe/stripe_object.rb +1 -1
  259. data/lib/stripe/util.rb +7 -1
  260. data/lib/stripe/version.rb +1 -1
  261. data/lib/stripe.rb +55 -0
  262. data/rbi/stripe.rbi +190156 -0
  263. data/stripe.gemspec +4 -1
  264. metadata +146 -324
  265. data/rbi/stripe/resources/account.rbi +0 -4840
  266. data/rbi/stripe/resources/account_link.rbi +0 -74
  267. data/rbi/stripe/resources/account_session.rbi +0 -894
  268. data/rbi/stripe/resources/apple_pay_domain.rbi +0 -90
  269. data/rbi/stripe/resources/application.rbi +0 -20
  270. data/rbi/stripe/resources/application_fee.rbi +0 -118
  271. data/rbi/stripe/resources/application_fee_refund.rbi +0 -37
  272. data/rbi/stripe/resources/apps/secret.rbi +0 -195
  273. data/rbi/stripe/resources/balance.rbi +0 -180
  274. data/rbi/stripe/resources/balance_transaction.rbi +0 -144
  275. data/rbi/stripe/resources/bank_account.rbi +0 -127
  276. data/rbi/stripe/resources/billing/alert.rbi +0 -201
  277. data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -28
  278. data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -63
  279. data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -147
  280. data/rbi/stripe/resources/billing/credit_grant.rbi +0 -291
  281. data/rbi/stripe/resources/billing/meter.rbi +0 -226
  282. data/rbi/stripe/resources/billing/meter_event.rbi +0 -64
  283. data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -64
  284. data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -35
  285. data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -645
  286. data/rbi/stripe/resources/billing_portal/session.rbi +0 -345
  287. data/rbi/stripe/resources/capability.rbi +0 -125
  288. data/rbi/stripe/resources/card.rbi +0 -125
  289. data/rbi/stripe/resources/cash_balance.rbi +0 -32
  290. data/rbi/stripe/resources/charge.rbi +0 -2054
  291. data/rbi/stripe/resources/checkout/session.rbi +0 -3951
  292. data/rbi/stripe/resources/climate/order.rbi +0 -245
  293. data/rbi/stripe/resources/climate/product.rbi +0 -75
  294. data/rbi/stripe/resources/climate/supplier.rbi +0 -72
  295. data/rbi/stripe/resources/confirmation_token.rbi +0 -1793
  296. data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -26
  297. data/rbi/stripe/resources/country_spec.rbi +0 -85
  298. data/rbi/stripe/resources/coupon.rbi +0 -252
  299. data/rbi/stripe/resources/credit_note.rbi +0 -747
  300. data/rbi/stripe/resources/credit_note_line_item.rbi +0 -101
  301. data/rbi/stripe/resources/customer.rbi +0 -1009
  302. data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -56
  303. data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -151
  304. data/rbi/stripe/resources/customer_session.rbi +0 -200
  305. data/rbi/stripe/resources/discount.rbi +0 -53
  306. data/rbi/stripe/resources/dispute.rbi +0 -761
  307. data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -58
  308. data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -23
  309. data/rbi/stripe/resources/entitlements/feature.rbi +0 -117
  310. data/rbi/stripe/resources/ephemeral_key.rbi +0 -44
  311. data/rbi/stripe/resources/event.rbi +0 -146
  312. data/rbi/stripe/resources/exchange_rate.rbi +0 -66
  313. data/rbi/stripe/resources/file.rbi +0 -143
  314. data/rbi/stripe/resources/file_link.rbi +0 -141
  315. data/rbi/stripe/resources/financial_connections/account.rbi +0 -339
  316. data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -35
  317. data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -23
  318. data/rbi/stripe/resources/financial_connections/session.rbi +0 -123
  319. data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -124
  320. data/rbi/stripe/resources/forwarding/request.rbi +0 -216
  321. data/rbi/stripe/resources/funding_instructions.rbi +0 -437
  322. data/rbi/stripe/resources/identity/verification_report.rbi +0 -351
  323. data/rbi/stripe/resources/identity/verification_session.rbi +0 -517
  324. data/rbi/stripe/resources/invoice.rbi +0 -3733
  325. data/rbi/stripe/resources/invoice_item.rbi +0 -475
  326. data/rbi/stripe/resources/invoice_line_item.rbi +0 -432
  327. data/rbi/stripe/resources/invoice_payment.rbi +0 -114
  328. data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -104
  329. data/rbi/stripe/resources/issuing/authorization.rbi +0 -1283
  330. data/rbi/stripe/resources/issuing/card.rbi +0 -741
  331. data/rbi/stripe/resources/issuing/cardholder.rbi +0 -744
  332. data/rbi/stripe/resources/issuing/dispute.rbi +0 -913
  333. data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -338
  334. data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -79
  335. data/rbi/stripe/resources/issuing/token.rbi +0 -226
  336. data/rbi/stripe/resources/issuing/transaction.rbi +0 -1061
  337. data/rbi/stripe/resources/line_item.rbi +0 -72
  338. data/rbi/stripe/resources/login_link.rbi +0 -18
  339. data/rbi/stripe/resources/mandate.rbi +0 -187
  340. data/rbi/stripe/resources/payment_intent.rbi +0 -9731
  341. data/rbi/stripe/resources/payment_link.rbi +0 -1801
  342. data/rbi/stripe/resources/payment_method.rbi +0 -1822
  343. data/rbi/stripe/resources/payment_method_configuration.rbi +0 -3154
  344. data/rbi/stripe/resources/payment_method_domain.rbi +0 -212
  345. data/rbi/stripe/resources/payout.rbi +0 -300
  346. data/rbi/stripe/resources/person.rbi +0 -371
  347. data/rbi/stripe/resources/plan.rbi +0 -373
  348. data/rbi/stripe/resources/price.rbi +0 -694
  349. data/rbi/stripe/resources/product.rbi +0 -557
  350. data/rbi/stripe/resources/product_feature.rbi +0 -26
  351. data/rbi/stripe/resources/promotion_code.rbi +0 -261
  352. data/rbi/stripe/resources/quote.rbi +0 -1123
  353. data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -98
  354. data/rbi/stripe/resources/radar/value_list.rbi +0 -170
  355. data/rbi/stripe/resources/radar/value_list_item.rbi +0 -131
  356. data/rbi/stripe/resources/refund.rbi +0 -516
  357. data/rbi/stripe/resources/reporting/report_run.rbi +0 -191
  358. data/rbi/stripe/resources/reporting/report_type.rbi +0 -57
  359. data/rbi/stripe/resources/reserve_transaction.rbi +0 -23
  360. data/rbi/stripe/resources/reversal.rbi +0 -51
  361. data/rbi/stripe/resources/review.rbi +0 -154
  362. data/rbi/stripe/resources/setup_attempt.rbi +0 -477
  363. data/rbi/stripe/resources/setup_intent.rbi +0 -3860
  364. data/rbi/stripe/resources/shipping_rate.rbi +0 -305
  365. data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -75
  366. data/rbi/stripe/resources/source.rbi +0 -1496
  367. data/rbi/stripe/resources/source_mandate_notification.rbi +0 -77
  368. data/rbi/stripe/resources/source_transaction.rbi +0 -127
  369. data/rbi/stripe/resources/subscription.rbi +0 -1964
  370. data/rbi/stripe/resources/subscription_item.rbi +0 -370
  371. data/rbi/stripe/resources/subscription_schedule.rbi +0 -1495
  372. data/rbi/stripe/resources/tax/calculation.rbi +0 -474
  373. data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -88
  374. data/rbi/stripe/resources/tax/registration.rbi +0 -2485
  375. data/rbi/stripe/resources/tax/settings.rbi +0 -141
  376. data/rbi/stripe/resources/tax/transaction.rbi +0 -351
  377. data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -54
  378. data/rbi/stripe/resources/tax_code.rbi +0 -44
  379. data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -23
  380. data/rbi/stripe/resources/tax_id.rbi +0 -167
  381. data/rbi/stripe/resources/tax_rate.rbi +0 -239
  382. data/rbi/stripe/resources/terminal/configuration.rbi +0 -1388
  383. data/rbi/stripe/resources/terminal/connection_token.rbi +0 -37
  384. data/rbi/stripe/resources/terminal/location.rbi +0 -224
  385. data/rbi/stripe/resources/terminal/reader.rbi +0 -587
  386. data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -134
  387. data/rbi/stripe/resources/token.rbi +0 -1217
  388. data/rbi/stripe/resources/topup.rbi +0 -222
  389. data/rbi/stripe/resources/transfer.rbi +0 -199
  390. data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -119
  391. data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -131
  392. data/rbi/stripe/resources/treasury/financial_account.rbi +0 -865
  393. data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -260
  394. data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -295
  395. data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -592
  396. data/rbi/stripe/resources/treasury/outbound_transfer.rbi +0 -431
  397. data/rbi/stripe/resources/treasury/received_credit.rbi +0 -302
  398. data/rbi/stripe/resources/treasury/received_debit.rbi +0 -256
  399. data/rbi/stripe/resources/treasury/transaction.rbi +0 -215
  400. data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -192
  401. data/rbi/stripe/resources/v2/amount.rbi +0 -14
  402. data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -37
  403. data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -41
  404. data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -31
  405. data/rbi/stripe/resources/v2/event.rbi +0 -48
  406. data/rbi/stripe/resources/v2/event_destination.rbi +0 -91
  407. data/rbi/stripe/resources/webhook_endpoint.rbi +0 -170
  408. data/rbi/stripe/services/account_capability_service.rbi +0 -51
  409. data/rbi/stripe/services/account_link_service.rbi +0 -58
  410. data/rbi/stripe/services/account_login_link_service.rbi +0 -22
  411. data/rbi/stripe/services/account_person_service.rbi +0 -923
  412. data/rbi/stripe/services/account_service.rbi +0 -4143
  413. data/rbi/stripe/services/account_session_service.rbi +0 -572
  414. data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -78
  415. data/rbi/stripe/services/application_fee_refund_service.rbi +0 -93
  416. data/rbi/stripe/services/application_fee_service.rbi +0 -78
  417. data/rbi/stripe/services/apps/secret_service.rbi +0 -151
  418. data/rbi/stripe/services/apps_service.rbi +0 -9
  419. data/rbi/stripe/services/balance_service.rbi +0 -21
  420. data/rbi/stripe/services/balance_transaction_service.rbi +0 -93
  421. data/rbi/stripe/services/billing/alert_service.rbi +0 -152
  422. data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -68
  423. data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -59
  424. data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -211
  425. data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -42
  426. data/rbi/stripe/services/billing/meter_event_service.rbi +0 -42
  427. data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -54
  428. data/rbi/stripe/services/billing/meter_service.rbi +0 -163
  429. data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -511
  430. data/rbi/stripe/services/billing_portal/session_service.rbi +0 -204
  431. data/rbi/stripe/services/billing_portal_service.rbi +0 -10
  432. data/rbi/stripe/services/billing_service.rbi +0 -15
  433. data/rbi/stripe/services/charge_service.rbi +0 -448
  434. data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -33
  435. data/rbi/stripe/services/checkout/session_service.rbi +0 -2585
  436. data/rbi/stripe/services/checkout_service.rbi +0 -9
  437. data/rbi/stripe/services/climate/order_service.rbi +0 -142
  438. data/rbi/stripe/services/climate_service.rbi +0 -11
  439. data/rbi/stripe/services/confirmation_token_service.rbi +0 -20
  440. data/rbi/stripe/services/country_spec_service.rbi +0 -44
  441. data/rbi/stripe/services/coupon_service.rbi +0 -196
  442. data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -167
  443. data/rbi/stripe/services/credit_note_service.rbi +0 -416
  444. data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -92
  445. data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -45
  446. data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -44
  447. data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -59
  448. data/rbi/stripe/services/customer_payment_method_service.rbi +0 -57
  449. data/rbi/stripe/services/customer_payment_source_service.rbi +0 -232
  450. data/rbi/stripe/services/customer_service.rbi +0 -651
  451. data/rbi/stripe/services/customer_session_service.rbi +0 -116
  452. data/rbi/stripe/services/customer_tax_id_service.rbi +0 -72
  453. data/rbi/stripe/services/dispute_service.rbi +0 -424
  454. data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -55
  455. data/rbi/stripe/services/entitlements/feature_service.rbi +0 -107
  456. data/rbi/stripe/services/entitlements_service.rbi +0 -10
  457. data/rbi/stripe/services/ephemeral_key_service.rbi +0 -53
  458. data/rbi/stripe/services/event_service.rbi +0 -83
  459. data/rbi/stripe/services/exchange_rate_service.rbi +0 -44
  460. data/rbi/stripe/services/file_link_service.rbi +0 -124
  461. data/rbi/stripe/services/file_service.rbi +0 -116
  462. data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -42
  463. data/rbi/stripe/services/financial_connections/account_service.rbi +0 -133
  464. data/rbi/stripe/services/financial_connections/session_service.rbi +0 -88
  465. data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -92
  466. data/rbi/stripe/services/financial_connections_service.rbi +0 -11
  467. data/rbi/stripe/services/forwarding/request_service.rbi +0 -134
  468. data/rbi/stripe/services/forwarding_service.rbi +0 -9
  469. data/rbi/stripe/services/identity/verification_report_service.rbi +0 -87
  470. data/rbi/stripe/services/identity/verification_session_service.rbi +0 -323
  471. data/rbi/stripe/services/identity_service.rbi +0 -10
  472. data/rbi/stripe/services/invoice_item_service.rbi +0 -368
  473. data/rbi/stripe/services/invoice_line_item_service.rbi +0 -259
  474. data/rbi/stripe/services/invoice_payment_service.rbi +0 -71
  475. data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -82
  476. data/rbi/stripe/services/invoice_service.rbi +0 -2920
  477. data/rbi/stripe/services/issuing/authorization_service.rbi +0 -146
  478. data/rbi/stripe/services/issuing/card_service.rbi +0 -495
  479. data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -587
  480. data/rbi/stripe/services/issuing/dispute_service.rbi +0 -707
  481. data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -243
  482. data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -59
  483. data/rbi/stripe/services/issuing/token_service.rbi +0 -99
  484. data/rbi/stripe/services/issuing/transaction_service.rbi +0 -105
  485. data/rbi/stripe/services/issuing_service.rbi +0 -16
  486. data/rbi/stripe/services/mandate_service.rbi +0 -20
  487. data/rbi/stripe/services/payment_intent_service.rbi +0 -7759
  488. data/rbi/stripe/services/payment_link_service.rbi +0 -1352
  489. data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -2211
  490. data/rbi/stripe/services/payment_method_domain_service.rbi +0 -112
  491. data/rbi/stripe/services/payment_method_service.rbi +0 -840
  492. data/rbi/stripe/services/payout_service.rbi +0 -205
  493. data/rbi/stripe/services/plan_service.rbi +0 -284
  494. data/rbi/stripe/services/price_service.rbi +0 -546
  495. data/rbi/stripe/services/product_feature_service.rbi +0 -69
  496. data/rbi/stripe/services/product_service.rbi +0 -479
  497. data/rbi/stripe/services/promotion_code_service.rbi +0 -214
  498. data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -31
  499. data/rbi/stripe/services/quote_service.rbi +0 -686
  500. data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -85
  501. data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -111
  502. data/rbi/stripe/services/radar/value_list_service.rbi +0 -143
  503. data/rbi/stripe/services/radar_service.rbi +0 -11
  504. data/rbi/stripe/services/refund_service.rbi +0 -185
  505. data/rbi/stripe/services/reporting/report_run_service.rbi +0 -135
  506. data/rbi/stripe/services/reporting/report_type_service.rbi +0 -35
  507. data/rbi/stripe/services/reporting_service.rbi +0 -10
  508. data/rbi/stripe/services/review_service.rbi +0 -84
  509. data/rbi/stripe/services/setup_attempt_service.rbi +0 -65
  510. data/rbi/stripe/services/setup_intent_service.rbi +0 -3596
  511. data/rbi/stripe/services/shipping_rate_service.rbi +0 -241
  512. data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -46
  513. data/rbi/stripe/services/sigma_service.rbi +0 -9
  514. data/rbi/stripe/services/source_service.rbi +0 -663
  515. data/rbi/stripe/services/subscription_item_service.rbi +0 -324
  516. data/rbi/stripe/services/subscription_schedule_service.rbi +0 -1192
  517. data/rbi/stripe/services/subscription_service.rbi +0 -1596
  518. data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -33
  519. data/rbi/stripe/services/tax/calculation_service.rbi +0 -230
  520. data/rbi/stripe/services/tax/registration_service.rbi +0 -1689
  521. data/rbi/stripe/services/tax/settings_service.rbi +0 -93
  522. data/rbi/stripe/services/tax/transaction_service.rbi +0 -146
  523. data/rbi/stripe/services/tax_code_service.rbi +0 -44
  524. data/rbi/stripe/services/tax_id_service.rbi +0 -112
  525. data/rbi/stripe/services/tax_rate_service.rbi +0 -185
  526. data/rbi/stripe/services/tax_service.rbi +0 -12
  527. data/rbi/stripe/services/terminal/configuration_service.rbi +0 -1120
  528. data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -25
  529. data/rbi/stripe/services/terminal/location_service.rbi +0 -184
  530. data/rbi/stripe/services/terminal/reader_service.rbi +0 -344
  531. data/rbi/stripe/services/terminal_service.rbi +0 -12
  532. data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -746
  533. data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -33
  534. data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -848
  535. data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -76
  536. data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -69
  537. data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -711
  538. data/rbi/stripe/services/test_helpers/issuing_service.rbi +0 -14
  539. data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -22
  540. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -62
  541. data/rbi/stripe/services/test_helpers/terminal_service.rbi +0 -11
  542. data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -92
  543. data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -64
  544. data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -125
  545. data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -125
  546. data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -87
  547. data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -87
  548. data/rbi/stripe/services/test_helpers/treasury_service.rbi +0 -15
  549. data/rbi/stripe/services/test_helpers_service.rbi +0 -15
  550. data/rbi/stripe/services/token_service.rbi +0 -1189
  551. data/rbi/stripe/services/topup_service.rbi +0 -176
  552. data/rbi/stripe/services/transfer_reversal_service.rbi +0 -101
  553. data/rbi/stripe/services/transfer_service.rbi +0 -152
  554. data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -84
  555. data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -88
  556. data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -198
  557. data/rbi/stripe/services/treasury/financial_account_service.rbi +0 -562
  558. data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -117
  559. data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -304
  560. data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +0 -157
  561. data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -72
  562. data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -59
  563. data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -111
  564. data/rbi/stripe/services/treasury/transaction_service.rbi +0 -122
  565. data/rbi/stripe/services/treasury_service.rbi +0 -18
  566. data/rbi/stripe/services/v1_services.rbi +0 -77
  567. data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -39
  568. data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -42
  569. data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +0 -20
  570. data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -55
  571. data/rbi/stripe/services/v2/billing_service.rbi +0 -14
  572. data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -200
  573. data/rbi/stripe/services/v2/core/event_service.rbi +0 -38
  574. data/rbi/stripe/services/v2/core_service.rbi +0 -12
  575. data/rbi/stripe/services/v2_services.rbi +0 -10
  576. data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -131
@@ -1,3860 +0,0 @@
1
- # File generated from our OpenAPI spec
2
- # frozen_string_literal: true
3
-
4
- # typed: true
5
- module Stripe
6
- # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
7
- # For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
8
- # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
9
- #
10
- # Create a SetupIntent when you're ready to collect your customer's payment credentials.
11
- # Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
12
- # The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides
13
- # you through the setup process.
14
- #
15
- # Successful SetupIntents result in payment credentials that are optimized for future payments.
16
- # For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
17
- # [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
18
- # to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
19
- # If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
20
- # it automatically attaches the resulting payment method to that Customer after successful setup.
21
- # We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
22
- # PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
23
- #
24
- # By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
25
- #
26
- # Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
27
- class SetupIntent < APIResource
28
- class AutomaticPaymentMethods < Stripe::StripeObject
29
- # Controls whether this SetupIntent will accept redirect-based payment methods.
30
- #
31
- # Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.
32
- sig { returns(String) }
33
- attr_reader :allow_redirects
34
- # Automatically calculates compatible payment methods
35
- sig { returns(T.nilable(T::Boolean)) }
36
- attr_reader :enabled
37
- end
38
- class LastSetupError < Stripe::StripeObject
39
- # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
40
- sig { returns(String) }
41
- attr_reader :advice_code
42
- # For card errors, the ID of the failed charge.
43
- sig { returns(String) }
44
- attr_reader :charge
45
- # For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
46
- sig { returns(String) }
47
- attr_reader :code
48
- # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
49
- sig { returns(String) }
50
- attr_reader :decline_code
51
- # A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
52
- sig { returns(String) }
53
- attr_reader :doc_url
54
- # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
55
- sig { returns(String) }
56
- attr_reader :message
57
- # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
58
- sig { returns(String) }
59
- attr_reader :network_advice_code
60
- # For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
61
- sig { returns(String) }
62
- attr_reader :network_decline_code
63
- # If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
64
- sig { returns(String) }
65
- attr_reader :param
66
- # A PaymentIntent guides you through the process of collecting a payment from your customer.
67
- # We recommend that you create exactly one PaymentIntent for each order or
68
- # customer session in your system. You can reference the PaymentIntent later to
69
- # see the history of payment attempts for a particular session.
70
- #
71
- # A PaymentIntent transitions through
72
- # [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
73
- # throughout its lifetime as it interfaces with Stripe.js to perform
74
- # authentication flows and ultimately creates at most one successful charge.
75
- #
76
- # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
77
- sig { returns(Stripe::PaymentIntent) }
78
- attr_reader :payment_intent
79
- # PaymentMethod objects represent your customer's payment instruments.
80
- # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
81
- # Customer objects to store instrument details for future payments.
82
- #
83
- # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
84
- sig { returns(Stripe::PaymentMethod) }
85
- attr_reader :payment_method
86
- # If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
87
- sig { returns(String) }
88
- attr_reader :payment_method_type
89
- # A URL to the request log entry in your dashboard.
90
- sig { returns(String) }
91
- attr_reader :request_log_url
92
- # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
93
- # For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
94
- # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
95
- #
96
- # Create a SetupIntent when you're ready to collect your customer's payment credentials.
97
- # Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
98
- # The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides
99
- # you through the setup process.
100
- #
101
- # Successful SetupIntents result in payment credentials that are optimized for future payments.
102
- # For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
103
- # [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
104
- # to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
105
- # If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
106
- # it automatically attaches the resulting payment method to that Customer after successful setup.
107
- # We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
108
- # PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
109
- #
110
- # By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
111
- #
112
- # Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
113
- sig { returns(Stripe::SetupIntent) }
114
- attr_reader :setup_intent
115
- # Attribute for field source
116
- sig { returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)) }
117
- attr_reader :source
118
- # The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
119
- sig { returns(String) }
120
- attr_reader :type
121
- end
122
- class NextAction < Stripe::StripeObject
123
- class CashappHandleRedirectOrDisplayQrCode < Stripe::StripeObject
124
- class QrCode < Stripe::StripeObject
125
- # The date (unix timestamp) when the QR code expires.
126
- sig { returns(Integer) }
127
- attr_reader :expires_at
128
- # The image_url_png string used to render QR code
129
- sig { returns(String) }
130
- attr_reader :image_url_png
131
- # The image_url_svg string used to render QR code
132
- sig { returns(String) }
133
- attr_reader :image_url_svg
134
- end
135
- # The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
136
- sig { returns(String) }
137
- attr_reader :hosted_instructions_url
138
- # The url for mobile redirect based auth
139
- sig { returns(String) }
140
- attr_reader :mobile_auth_url
141
- # Attribute for field qr_code
142
- sig { returns(QrCode) }
143
- attr_reader :qr_code
144
- end
145
- class RedirectToUrl < Stripe::StripeObject
146
- # If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
147
- sig { returns(T.nilable(String)) }
148
- attr_reader :return_url
149
- # The URL you must redirect your customer to in order to authenticate.
150
- sig { returns(T.nilable(String)) }
151
- attr_reader :url
152
- end
153
- class VerifyWithMicrodeposits < Stripe::StripeObject
154
- # The timestamp when the microdeposits are expected to land.
155
- sig { returns(Integer) }
156
- attr_reader :arrival_date
157
- # The URL for the hosted verification page, which allows customers to verify their bank account.
158
- sig { returns(String) }
159
- attr_reader :hosted_verification_url
160
- # The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
161
- sig { returns(T.nilable(String)) }
162
- attr_reader :microdeposit_type
163
- end
164
- # Attribute for field cashapp_handle_redirect_or_display_qr_code
165
- sig { returns(CashappHandleRedirectOrDisplayQrCode) }
166
- attr_reader :cashapp_handle_redirect_or_display_qr_code
167
- # Attribute for field redirect_to_url
168
- sig { returns(RedirectToUrl) }
169
- attr_reader :redirect_to_url
170
- # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.
171
- sig { returns(String) }
172
- attr_reader :type
173
- # When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
174
- sig { returns(T::Hash[String, T.untyped]) }
175
- attr_reader :use_stripe_sdk
176
- # Attribute for field verify_with_microdeposits
177
- sig { returns(VerifyWithMicrodeposits) }
178
- attr_reader :verify_with_microdeposits
179
- end
180
- class PaymentMethodConfigurationDetails < Stripe::StripeObject
181
- # ID of the payment method configuration used.
182
- sig { returns(String) }
183
- attr_reader :id
184
- # ID of the parent payment method configuration used.
185
- sig { returns(T.nilable(String)) }
186
- attr_reader :parent
187
- end
188
- class PaymentMethodOptions < Stripe::StripeObject
189
- class AcssDebit < Stripe::StripeObject
190
- class MandateOptions < Stripe::StripeObject
191
- # A URL for custom mandate text
192
- sig { returns(String) }
193
- attr_reader :custom_mandate_url
194
- # List of Stripe products where this mandate can be selected automatically.
195
- sig { returns(T::Array[String]) }
196
- attr_reader :default_for
197
- # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
198
- sig { returns(T.nilable(String)) }
199
- attr_reader :interval_description
200
- # Payment schedule for the mandate.
201
- sig { returns(T.nilable(String)) }
202
- attr_reader :payment_schedule
203
- # Transaction type of the mandate.
204
- sig { returns(T.nilable(String)) }
205
- attr_reader :transaction_type
206
- end
207
- # Currency supported by the bank account
208
- sig { returns(T.nilable(String)) }
209
- attr_reader :currency
210
- # Attribute for field mandate_options
211
- sig { returns(MandateOptions) }
212
- attr_reader :mandate_options
213
- # Bank account verification method.
214
- sig { returns(String) }
215
- attr_reader :verification_method
216
- end
217
- class AmazonPay < Stripe::StripeObject; end
218
- class BacsDebit < Stripe::StripeObject
219
- class MandateOptions < Stripe::StripeObject
220
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
221
- sig { returns(String) }
222
- attr_reader :reference_prefix
223
- end
224
- # Attribute for field mandate_options
225
- sig { returns(MandateOptions) }
226
- attr_reader :mandate_options
227
- end
228
- class Card < Stripe::StripeObject
229
- class MandateOptions < Stripe::StripeObject
230
- # Amount to be charged for future payments.
231
- sig { returns(Integer) }
232
- attr_reader :amount
233
- # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
234
- sig { returns(String) }
235
- attr_reader :amount_type
236
- # 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).
237
- sig { returns(String) }
238
- attr_reader :currency
239
- # A description of the mandate or subscription that is meant to be displayed to the customer.
240
- sig { returns(T.nilable(String)) }
241
- attr_reader :description
242
- # End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
243
- sig { returns(T.nilable(Integer)) }
244
- attr_reader :end_date
245
- # Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
246
- sig { returns(String) }
247
- attr_reader :interval
248
- # The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
249
- sig { returns(T.nilable(Integer)) }
250
- attr_reader :interval_count
251
- # Unique identifier for the mandate or subscription.
252
- sig { returns(String) }
253
- attr_reader :reference
254
- # Start date of the mandate or subscription. Start date should not be lesser than yesterday.
255
- sig { returns(Integer) }
256
- attr_reader :start_date
257
- # Specifies the type of mandates supported. Possible values are `india`.
258
- sig { returns(T.nilable(T::Array[String])) }
259
- attr_reader :supported_types
260
- end
261
- # Configuration options for setting up an eMandate for cards issued in India.
262
- sig { returns(T.nilable(MandateOptions)) }
263
- attr_reader :mandate_options
264
- # Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.
265
- sig { returns(T.nilable(String)) }
266
- attr_reader :network
267
- # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
268
- sig { returns(T.nilable(String)) }
269
- attr_reader :request_three_d_secure
270
- end
271
- class CardPresent < Stripe::StripeObject; end
272
- class Link < Stripe::StripeObject
273
- # [Deprecated] This is a legacy parameter that no longer has any function.
274
- sig { returns(T.nilable(String)) }
275
- attr_reader :persistent_token
276
- end
277
- class Paypal < Stripe::StripeObject
278
- # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
279
- sig { returns(T.nilable(String)) }
280
- attr_reader :billing_agreement_id
281
- end
282
- class SepaDebit < Stripe::StripeObject
283
- class MandateOptions < Stripe::StripeObject
284
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
285
- sig { returns(String) }
286
- attr_reader :reference_prefix
287
- end
288
- # Attribute for field mandate_options
289
- sig { returns(MandateOptions) }
290
- attr_reader :mandate_options
291
- end
292
- class UsBankAccount < Stripe::StripeObject
293
- class FinancialConnections < Stripe::StripeObject
294
- class Filters < Stripe::StripeObject
295
- # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
296
- sig { returns(T::Array[String]) }
297
- attr_reader :account_subcategories
298
- end
299
- # Attribute for field filters
300
- sig { returns(Filters) }
301
- attr_reader :filters
302
- # The list of permissions to request. The `payment_method` permission must be included.
303
- sig { returns(T::Array[String]) }
304
- attr_reader :permissions
305
- # Data features requested to be retrieved upon account creation.
306
- sig { returns(T.nilable(T::Array[String])) }
307
- attr_reader :prefetch
308
- # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
309
- sig { returns(String) }
310
- attr_reader :return_url
311
- end
312
- class MandateOptions < Stripe::StripeObject
313
- # Mandate collection method
314
- sig { returns(String) }
315
- attr_reader :collection_method
316
- end
317
- # Attribute for field financial_connections
318
- sig { returns(FinancialConnections) }
319
- attr_reader :financial_connections
320
- # Attribute for field mandate_options
321
- sig { returns(MandateOptions) }
322
- attr_reader :mandate_options
323
- # Bank account verification method.
324
- sig { returns(String) }
325
- attr_reader :verification_method
326
- end
327
- # Attribute for field acss_debit
328
- sig { returns(AcssDebit) }
329
- attr_reader :acss_debit
330
- # Attribute for field amazon_pay
331
- sig { returns(AmazonPay) }
332
- attr_reader :amazon_pay
333
- # Attribute for field bacs_debit
334
- sig { returns(BacsDebit) }
335
- attr_reader :bacs_debit
336
- # Attribute for field card
337
- sig { returns(Card) }
338
- attr_reader :card
339
- # Attribute for field card_present
340
- sig { returns(CardPresent) }
341
- attr_reader :card_present
342
- # Attribute for field link
343
- sig { returns(Link) }
344
- attr_reader :link
345
- # Attribute for field paypal
346
- sig { returns(Paypal) }
347
- attr_reader :paypal
348
- # Attribute for field sepa_debit
349
- sig { returns(SepaDebit) }
350
- attr_reader :sepa_debit
351
- # Attribute for field us_bank_account
352
- sig { returns(UsBankAccount) }
353
- attr_reader :us_bank_account
354
- end
355
- # ID of the Connect application that created the SetupIntent.
356
- sig { returns(T.nilable(T.any(String, Stripe::Application))) }
357
- attr_reader :application
358
- # If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
359
- #
360
- # It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
361
- sig { returns(T::Boolean) }
362
- attr_reader :attach_to_self
363
- # Settings for dynamic payment methods compatible with this Setup Intent
364
- sig { returns(T.nilable(AutomaticPaymentMethods)) }
365
- attr_reader :automatic_payment_methods
366
- # Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.
367
- sig { returns(T.nilable(String)) }
368
- attr_reader :cancellation_reason
369
- # The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
370
- #
371
- # The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
372
- sig { returns(T.nilable(String)) }
373
- attr_reader :client_secret
374
- # Time at which the object was created. Measured in seconds since the Unix epoch.
375
- sig { returns(Integer) }
376
- attr_reader :created
377
- # ID of the Customer this SetupIntent belongs to, if one exists.
378
- #
379
- # If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
380
- sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
381
- attr_reader :customer
382
- # An arbitrary string attached to the object. Often useful for displaying to users.
383
- sig { returns(T.nilable(String)) }
384
- attr_reader :description
385
- # Indicates the directions of money movement for which this payment method is intended to be used.
386
- #
387
- # Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
388
- sig { returns(T.nilable(T::Array[String])) }
389
- attr_reader :flow_directions
390
- # Unique identifier for the object.
391
- sig { returns(String) }
392
- attr_reader :id
393
- # The error encountered in the previous SetupIntent confirmation.
394
- sig { returns(T.nilable(LastSetupError)) }
395
- attr_reader :last_setup_error
396
- # The most recent SetupAttempt for this SetupIntent.
397
- sig { returns(T.nilable(T.any(String, Stripe::SetupAttempt))) }
398
- attr_reader :latest_attempt
399
- # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
400
- sig { returns(T::Boolean) }
401
- attr_reader :livemode
402
- # ID of the multi use Mandate generated by the SetupIntent.
403
- sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
404
- attr_reader :mandate
405
- # 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.
406
- sig { returns(T.nilable(T::Hash[String, String])) }
407
- attr_reader :metadata
408
- # If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
409
- sig { returns(T.nilable(NextAction)) }
410
- attr_reader :next_action
411
- # String representing the object's type. Objects of the same type share the same value.
412
- sig { returns(String) }
413
- attr_reader :object
414
- # The account (if any) for which the setup is intended.
415
- sig { returns(T.nilable(T.any(String, Stripe::Account))) }
416
- attr_reader :on_behalf_of
417
- # ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.
418
- sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
419
- attr_reader :payment_method
420
- # Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.
421
- sig { returns(T.nilable(PaymentMethodConfigurationDetails)) }
422
- attr_reader :payment_method_configuration_details
423
- # Payment method-specific configuration for this SetupIntent.
424
- sig { returns(T.nilable(PaymentMethodOptions)) }
425
- attr_reader :payment_method_options
426
- # The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
427
- sig { returns(T::Array[String]) }
428
- attr_reader :payment_method_types
429
- # ID of the single_use Mandate generated by the SetupIntent.
430
- sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
431
- attr_reader :single_use_mandate
432
- # [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
433
- sig { returns(String) }
434
- attr_reader :status
435
- # Indicates how the payment method is intended to be used in the future.
436
- #
437
- # Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.
438
- sig { returns(String) }
439
- attr_reader :usage
440
- class ListParams < Stripe::RequestParams
441
- class Created < Stripe::RequestParams
442
- # Minimum value to filter by (exclusive)
443
- sig { returns(T.nilable(Integer)) }
444
- attr_accessor :gt
445
- # Minimum value to filter by (inclusive)
446
- sig { returns(T.nilable(Integer)) }
447
- attr_accessor :gte
448
- # Maximum value to filter by (exclusive)
449
- sig { returns(T.nilable(Integer)) }
450
- attr_accessor :lt
451
- # Maximum value to filter by (inclusive)
452
- sig { returns(T.nilable(Integer)) }
453
- attr_accessor :lte
454
- sig {
455
- params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
456
- }
457
- def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
458
- end
459
- # If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
460
- #
461
- # It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
462
- sig { returns(T.nilable(T::Boolean)) }
463
- attr_accessor :attach_to_self
464
- # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
465
- sig { returns(T.nilable(T.any(::Stripe::SetupIntent::ListParams::Created, Integer))) }
466
- attr_accessor :created
467
- # Only return SetupIntents for the customer specified by this customer ID.
468
- sig { returns(T.nilable(String)) }
469
- attr_accessor :customer
470
- # 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.
471
- sig { returns(T.nilable(String)) }
472
- attr_accessor :ending_before
473
- # Specifies which fields in the response should be expanded.
474
- sig { returns(T.nilable(T::Array[String])) }
475
- attr_accessor :expand
476
- # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
477
- sig { returns(T.nilable(Integer)) }
478
- attr_accessor :limit
479
- # Only return SetupIntents that associate with the specified payment method.
480
- sig { returns(T.nilable(String)) }
481
- attr_accessor :payment_method
482
- # 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.
483
- sig { returns(T.nilable(String)) }
484
- attr_accessor :starting_after
485
- sig {
486
- params(attach_to_self: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::SetupIntent::ListParams::Created, Integer)), customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), payment_method: T.nilable(String), starting_after: T.nilable(String)).void
487
- }
488
- def initialize(
489
- attach_to_self: nil,
490
- created: nil,
491
- customer: nil,
492
- ending_before: nil,
493
- expand: nil,
494
- limit: nil,
495
- payment_method: nil,
496
- starting_after: nil
497
- ); end
498
- end
499
- class CreateParams < Stripe::RequestParams
500
- class AutomaticPaymentMethods < Stripe::RequestParams
501
- # Controls whether this SetupIntent will accept redirect-based payment methods.
502
- #
503
- # Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.
504
- sig { returns(T.nilable(String)) }
505
- attr_accessor :allow_redirects
506
- # Whether this feature is enabled.
507
- sig { returns(T::Boolean) }
508
- attr_accessor :enabled
509
- sig { params(allow_redirects: T.nilable(String), enabled: T::Boolean).void }
510
- def initialize(allow_redirects: nil, enabled: nil); end
511
- end
512
- class MandateData < Stripe::RequestParams
513
- class CustomerAcceptance < Stripe::RequestParams
514
- class Offline < Stripe::RequestParams
515
-
516
- end
517
- class Online < Stripe::RequestParams
518
- # The IP address from which the Mandate was accepted by the customer.
519
- sig { returns(String) }
520
- attr_accessor :ip_address
521
- # The user agent of the browser from which the Mandate was accepted by the customer.
522
- sig { returns(String) }
523
- attr_accessor :user_agent
524
- sig { params(ip_address: String, user_agent: String).void }
525
- def initialize(ip_address: nil, user_agent: nil); end
526
- end
527
- # The time at which the customer accepted the Mandate.
528
- sig { returns(T.nilable(Integer)) }
529
- attr_accessor :accepted_at
530
- # If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
531
- sig {
532
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Offline))
533
- }
534
- attr_accessor :offline
535
- # If this is a Mandate accepted online, this hash contains details about the online acceptance.
536
- sig {
537
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Online))
538
- }
539
- attr_accessor :online
540
- # The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
541
- sig { returns(String) }
542
- attr_accessor :type
543
- sig {
544
- params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance::Online), type: String).void
545
- }
546
- def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
547
- end
548
- # This hash contains details about the customer acceptance of the Mandate.
549
- sig { returns(::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance) }
550
- attr_accessor :customer_acceptance
551
- sig {
552
- params(customer_acceptance: ::Stripe::SetupIntent::CreateParams::MandateData::CustomerAcceptance).void
553
- }
554
- def initialize(customer_acceptance: nil); end
555
- end
556
- class PaymentMethodData < Stripe::RequestParams
557
- class AcssDebit < Stripe::RequestParams
558
- # Customer's bank account number.
559
- sig { returns(String) }
560
- attr_accessor :account_number
561
- # Institution number of the customer's bank.
562
- sig { returns(String) }
563
- attr_accessor :institution_number
564
- # Transit number of the customer's bank.
565
- sig { returns(String) }
566
- attr_accessor :transit_number
567
- sig {
568
- params(account_number: String, institution_number: String, transit_number: String).void
569
- }
570
- def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
571
- end
572
- class Affirm < Stripe::RequestParams
573
-
574
- end
575
- class AfterpayClearpay < Stripe::RequestParams
576
-
577
- end
578
- class Alipay < Stripe::RequestParams
579
-
580
- end
581
- class Alma < Stripe::RequestParams
582
-
583
- end
584
- class AmazonPay < Stripe::RequestParams
585
-
586
- end
587
- class AuBecsDebit < Stripe::RequestParams
588
- # The account number for the bank account.
589
- sig { returns(String) }
590
- attr_accessor :account_number
591
- # Bank-State-Branch number of the bank account.
592
- sig { returns(String) }
593
- attr_accessor :bsb_number
594
- sig { params(account_number: String, bsb_number: String).void }
595
- def initialize(account_number: nil, bsb_number: nil); end
596
- end
597
- class BacsDebit < Stripe::RequestParams
598
- # Account number of the bank account that the funds will be debited from.
599
- sig { returns(T.nilable(String)) }
600
- attr_accessor :account_number
601
- # Sort code of the bank account. (e.g., `10-20-30`)
602
- sig { returns(T.nilable(String)) }
603
- attr_accessor :sort_code
604
- sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
605
- def initialize(account_number: nil, sort_code: nil); end
606
- end
607
- class Bancontact < Stripe::RequestParams
608
-
609
- end
610
- class Billie < Stripe::RequestParams
611
-
612
- end
613
- class BillingDetails < Stripe::RequestParams
614
- class Address < Stripe::RequestParams
615
- # City, district, suburb, town, or village.
616
- sig { returns(T.nilable(String)) }
617
- attr_accessor :city
618
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
619
- sig { returns(T.nilable(String)) }
620
- attr_accessor :country
621
- # Address line 1 (e.g., street, PO Box, or company name).
622
- sig { returns(T.nilable(String)) }
623
- attr_accessor :line1
624
- # Address line 2 (e.g., apartment, suite, unit, or building).
625
- sig { returns(T.nilable(String)) }
626
- attr_accessor :line2
627
- # ZIP or postal code.
628
- sig { returns(T.nilable(String)) }
629
- attr_accessor :postal_code
630
- # State, county, province, or region.
631
- sig { returns(T.nilable(String)) }
632
- attr_accessor :state
633
- sig {
634
- 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
635
- }
636
- def initialize(
637
- city: nil,
638
- country: nil,
639
- line1: nil,
640
- line2: nil,
641
- postal_code: nil,
642
- state: nil
643
- ); end
644
- end
645
- # Billing address.
646
- sig {
647
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails::Address))))
648
- }
649
- attr_accessor :address
650
- # Email address.
651
- sig { returns(T.nilable(T.nilable(String))) }
652
- attr_accessor :email
653
- # Full name.
654
- sig { returns(T.nilable(T.nilable(String))) }
655
- attr_accessor :name
656
- # Billing phone number (including extension).
657
- sig { returns(T.nilable(T.nilable(String))) }
658
- attr_accessor :phone
659
- sig {
660
- params(address: T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails::Address))), email: T.nilable(T.nilable(String)), name: T.nilable(T.nilable(String)), phone: T.nilable(T.nilable(String))).void
661
- }
662
- def initialize(address: nil, email: nil, name: nil, phone: nil); end
663
- end
664
- class Blik < Stripe::RequestParams
665
-
666
- end
667
- class Boleto < Stripe::RequestParams
668
- # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
669
- sig { returns(String) }
670
- attr_accessor :tax_id
671
- sig { params(tax_id: String).void }
672
- def initialize(tax_id: nil); end
673
- end
674
- class Cashapp < Stripe::RequestParams
675
-
676
- end
677
- class CustomerBalance < Stripe::RequestParams
678
-
679
- end
680
- class Eps < Stripe::RequestParams
681
- # The customer's bank.
682
- sig { returns(T.nilable(String)) }
683
- attr_accessor :bank
684
- sig { params(bank: T.nilable(String)).void }
685
- def initialize(bank: nil); end
686
- end
687
- class Fpx < Stripe::RequestParams
688
- # Account holder type for FPX transaction
689
- sig { returns(T.nilable(String)) }
690
- attr_accessor :account_holder_type
691
- # The customer's bank.
692
- sig { returns(String) }
693
- attr_accessor :bank
694
- sig { params(account_holder_type: T.nilable(String), bank: String).void }
695
- def initialize(account_holder_type: nil, bank: nil); end
696
- end
697
- class Giropay < Stripe::RequestParams
698
-
699
- end
700
- class Grabpay < Stripe::RequestParams
701
-
702
- end
703
- class Ideal < Stripe::RequestParams
704
- # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
705
- sig { returns(T.nilable(String)) }
706
- attr_accessor :bank
707
- sig { params(bank: T.nilable(String)).void }
708
- def initialize(bank: nil); end
709
- end
710
- class InteracPresent < Stripe::RequestParams
711
-
712
- end
713
- class KakaoPay < Stripe::RequestParams
714
-
715
- end
716
- class Klarna < Stripe::RequestParams
717
- class Dob < Stripe::RequestParams
718
- # The day of birth, between 1 and 31.
719
- sig { returns(Integer) }
720
- attr_accessor :day
721
- # The month of birth, between 1 and 12.
722
- sig { returns(Integer) }
723
- attr_accessor :month
724
- # The four-digit year of birth.
725
- sig { returns(Integer) }
726
- attr_accessor :year
727
- sig { params(day: Integer, month: Integer, year: Integer).void }
728
- def initialize(day: nil, month: nil, year: nil); end
729
- end
730
- # Customer's date of birth
731
- sig {
732
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna::Dob))
733
- }
734
- attr_accessor :dob
735
- sig {
736
- params(dob: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna::Dob)).void
737
- }
738
- def initialize(dob: nil); end
739
- end
740
- class Konbini < Stripe::RequestParams
741
-
742
- end
743
- class KrCard < Stripe::RequestParams
744
-
745
- end
746
- class Link < Stripe::RequestParams
747
-
748
- end
749
- class Mobilepay < Stripe::RequestParams
750
-
751
- end
752
- class Multibanco < Stripe::RequestParams
753
-
754
- end
755
- class NaverPay < Stripe::RequestParams
756
- # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
757
- sig { returns(T.nilable(String)) }
758
- attr_accessor :funding
759
- sig { params(funding: T.nilable(String)).void }
760
- def initialize(funding: nil); end
761
- end
762
- class NzBankAccount < Stripe::RequestParams
763
- # The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
764
- sig { returns(T.nilable(String)) }
765
- attr_accessor :account_holder_name
766
- # The account number for the bank account.
767
- sig { returns(String) }
768
- attr_accessor :account_number
769
- # The numeric code for the bank account's bank.
770
- sig { returns(String) }
771
- attr_accessor :bank_code
772
- # The numeric code for the bank account's bank branch.
773
- sig { returns(String) }
774
- attr_accessor :branch_code
775
- # Attribute for param field reference
776
- sig { returns(T.nilable(String)) }
777
- attr_accessor :reference
778
- # The suffix of the bank account number.
779
- sig { returns(String) }
780
- attr_accessor :suffix
781
- sig {
782
- params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
783
- }
784
- def initialize(
785
- account_holder_name: nil,
786
- account_number: nil,
787
- bank_code: nil,
788
- branch_code: nil,
789
- reference: nil,
790
- suffix: nil
791
- ); end
792
- end
793
- class Oxxo < Stripe::RequestParams
794
-
795
- end
796
- class P24 < Stripe::RequestParams
797
- # The customer's bank.
798
- sig { returns(T.nilable(String)) }
799
- attr_accessor :bank
800
- sig { params(bank: T.nilable(String)).void }
801
- def initialize(bank: nil); end
802
- end
803
- class PayByBank < Stripe::RequestParams
804
-
805
- end
806
- class Payco < Stripe::RequestParams
807
-
808
- end
809
- class Paynow < Stripe::RequestParams
810
-
811
- end
812
- class Paypal < Stripe::RequestParams
813
-
814
- end
815
- class Pix < Stripe::RequestParams
816
-
817
- end
818
- class Promptpay < Stripe::RequestParams
819
-
820
- end
821
- class RadarOptions < Stripe::RequestParams
822
- # 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.
823
- sig { returns(T.nilable(String)) }
824
- attr_accessor :session
825
- sig { params(session: T.nilable(String)).void }
826
- def initialize(session: nil); end
827
- end
828
- class RevolutPay < Stripe::RequestParams
829
-
830
- end
831
- class SamsungPay < Stripe::RequestParams
832
-
833
- end
834
- class Satispay < Stripe::RequestParams
835
-
836
- end
837
- class SepaDebit < Stripe::RequestParams
838
- # IBAN of the bank account.
839
- sig { returns(String) }
840
- attr_accessor :iban
841
- sig { params(iban: String).void }
842
- def initialize(iban: nil); end
843
- end
844
- class Sofort < Stripe::RequestParams
845
- # Two-letter ISO code representing the country the bank account is located in.
846
- sig { returns(String) }
847
- attr_accessor :country
848
- sig { params(country: String).void }
849
- def initialize(country: nil); end
850
- end
851
- class Swish < Stripe::RequestParams
852
-
853
- end
854
- class Twint < Stripe::RequestParams
855
-
856
- end
857
- class UsBankAccount < Stripe::RequestParams
858
- # Account holder type: individual or company.
859
- sig { returns(T.nilable(String)) }
860
- attr_accessor :account_holder_type
861
- # Account number of the bank account.
862
- sig { returns(T.nilable(String)) }
863
- attr_accessor :account_number
864
- # Account type: checkings or savings. Defaults to checking if omitted.
865
- sig { returns(T.nilable(String)) }
866
- attr_accessor :account_type
867
- # The ID of a Financial Connections Account to use as a payment method.
868
- sig { returns(T.nilable(String)) }
869
- attr_accessor :financial_connections_account
870
- # Routing number of the bank account.
871
- sig { returns(T.nilable(String)) }
872
- attr_accessor :routing_number
873
- sig {
874
- params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
875
- }
876
- def initialize(
877
- account_holder_type: nil,
878
- account_number: nil,
879
- account_type: nil,
880
- financial_connections_account: nil,
881
- routing_number: nil
882
- ); end
883
- end
884
- class WechatPay < Stripe::RequestParams
885
-
886
- end
887
- class Zip < Stripe::RequestParams
888
-
889
- end
890
- # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
891
- sig {
892
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AcssDebit))
893
- }
894
- attr_accessor :acss_debit
895
- # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
896
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Affirm)) }
897
- attr_accessor :affirm
898
- # If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
899
- sig {
900
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AfterpayClearpay))
901
- }
902
- attr_accessor :afterpay_clearpay
903
- # If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
904
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alipay)) }
905
- attr_accessor :alipay
906
- # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
907
- sig { returns(T.nilable(String)) }
908
- attr_accessor :allow_redisplay
909
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
910
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alma)) }
911
- attr_accessor :alma
912
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
913
- sig {
914
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AmazonPay))
915
- }
916
- attr_accessor :amazon_pay
917
- # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
918
- sig {
919
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AuBecsDebit))
920
- }
921
- attr_accessor :au_becs_debit
922
- # If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
923
- sig {
924
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BacsDebit))
925
- }
926
- attr_accessor :bacs_debit
927
- # If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
928
- sig {
929
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Bancontact))
930
- }
931
- attr_accessor :bancontact
932
- # If this is a `billie` PaymentMethod, this hash contains details about the billie payment method.
933
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Billie)) }
934
- attr_accessor :billie
935
- # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
936
- sig {
937
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails))
938
- }
939
- attr_accessor :billing_details
940
- # If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
941
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Blik)) }
942
- attr_accessor :blik
943
- # If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
944
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Boleto)) }
945
- attr_accessor :boleto
946
- # If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
947
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Cashapp)) }
948
- attr_accessor :cashapp
949
- # If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
950
- sig {
951
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::CustomerBalance))
952
- }
953
- attr_accessor :customer_balance
954
- # If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
955
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Eps)) }
956
- attr_accessor :eps
957
- # If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
958
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Fpx)) }
959
- attr_accessor :fpx
960
- # If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
961
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Giropay)) }
962
- attr_accessor :giropay
963
- # If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
964
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Grabpay)) }
965
- attr_accessor :grabpay
966
- # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
967
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Ideal)) }
968
- attr_accessor :ideal
969
- # If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
970
- sig {
971
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::InteracPresent))
972
- }
973
- attr_accessor :interac_present
974
- # If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
975
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KakaoPay)) }
976
- attr_accessor :kakao_pay
977
- # If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
978
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna)) }
979
- attr_accessor :klarna
980
- # If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
981
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Konbini)) }
982
- attr_accessor :konbini
983
- # If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
984
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KrCard)) }
985
- attr_accessor :kr_card
986
- # If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
987
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Link)) }
988
- attr_accessor :link
989
- # 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`.
990
- sig { returns(T.nilable(T::Hash[String, String])) }
991
- attr_accessor :metadata
992
- # If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
993
- sig {
994
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Mobilepay))
995
- }
996
- attr_accessor :mobilepay
997
- # If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
998
- sig {
999
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Multibanco))
1000
- }
1001
- attr_accessor :multibanco
1002
- # If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
1003
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NaverPay)) }
1004
- attr_accessor :naver_pay
1005
- # If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
1006
- sig {
1007
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NzBankAccount))
1008
- }
1009
- attr_accessor :nz_bank_account
1010
- # If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
1011
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Oxxo)) }
1012
- attr_accessor :oxxo
1013
- # If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
1014
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::P24)) }
1015
- attr_accessor :p24
1016
- # If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
1017
- sig {
1018
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::PayByBank))
1019
- }
1020
- attr_accessor :pay_by_bank
1021
- # If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
1022
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payco)) }
1023
- attr_accessor :payco
1024
- # If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
1025
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paynow)) }
1026
- attr_accessor :paynow
1027
- # If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
1028
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypal)) }
1029
- attr_accessor :paypal
1030
- # If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
1031
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Pix)) }
1032
- attr_accessor :pix
1033
- # If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
1034
- sig {
1035
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Promptpay))
1036
- }
1037
- attr_accessor :promptpay
1038
- # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
1039
- sig {
1040
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RadarOptions))
1041
- }
1042
- attr_accessor :radar_options
1043
- # If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
1044
- sig {
1045
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RevolutPay))
1046
- }
1047
- attr_accessor :revolut_pay
1048
- # If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
1049
- sig {
1050
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SamsungPay))
1051
- }
1052
- attr_accessor :samsung_pay
1053
- # If this is a `satispay` PaymentMethod, this hash contains details about the satispay payment method.
1054
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Satispay)) }
1055
- attr_accessor :satispay
1056
- # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
1057
- sig {
1058
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SepaDebit))
1059
- }
1060
- attr_accessor :sepa_debit
1061
- # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
1062
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Sofort)) }
1063
- attr_accessor :sofort
1064
- # If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
1065
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Swish)) }
1066
- attr_accessor :swish
1067
- # If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
1068
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Twint)) }
1069
- attr_accessor :twint
1070
- # The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
1071
- sig { returns(String) }
1072
- attr_accessor :type
1073
- # If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
1074
- sig {
1075
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::UsBankAccount))
1076
- }
1077
- attr_accessor :us_bank_account
1078
- # If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
1079
- sig {
1080
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::WechatPay))
1081
- }
1082
- attr_accessor :wechat_pay
1083
- # If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
1084
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Zip)) }
1085
- attr_accessor :zip
1086
- sig {
1087
- params(acss_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Cashapp), customer_balance: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Giropay), grabpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Grabpay), ideal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Link), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Paypal), pix: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Promptpay), radar_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RadarOptions), revolut_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::SepaDebit), sofort: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Sofort), swish: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::Zip)).void
1088
- }
1089
- def initialize(
1090
- acss_debit: nil,
1091
- affirm: nil,
1092
- afterpay_clearpay: nil,
1093
- alipay: nil,
1094
- allow_redisplay: nil,
1095
- alma: nil,
1096
- amazon_pay: nil,
1097
- au_becs_debit: nil,
1098
- bacs_debit: nil,
1099
- bancontact: nil,
1100
- billie: nil,
1101
- billing_details: nil,
1102
- blik: nil,
1103
- boleto: nil,
1104
- cashapp: nil,
1105
- customer_balance: nil,
1106
- eps: nil,
1107
- fpx: nil,
1108
- giropay: nil,
1109
- grabpay: nil,
1110
- ideal: nil,
1111
- interac_present: nil,
1112
- kakao_pay: nil,
1113
- klarna: nil,
1114
- konbini: nil,
1115
- kr_card: nil,
1116
- link: nil,
1117
- metadata: nil,
1118
- mobilepay: nil,
1119
- multibanco: nil,
1120
- naver_pay: nil,
1121
- nz_bank_account: nil,
1122
- oxxo: nil,
1123
- p24: nil,
1124
- pay_by_bank: nil,
1125
- payco: nil,
1126
- paynow: nil,
1127
- paypal: nil,
1128
- pix: nil,
1129
- promptpay: nil,
1130
- radar_options: nil,
1131
- revolut_pay: nil,
1132
- samsung_pay: nil,
1133
- satispay: nil,
1134
- sepa_debit: nil,
1135
- sofort: nil,
1136
- swish: nil,
1137
- twint: nil,
1138
- type: nil,
1139
- us_bank_account: nil,
1140
- wechat_pay: nil,
1141
- zip: nil
1142
- ); end
1143
- end
1144
- class PaymentMethodOptions < Stripe::RequestParams
1145
- class AcssDebit < Stripe::RequestParams
1146
- class MandateOptions < Stripe::RequestParams
1147
- # A URL for custom mandate text to render during confirmation step.
1148
- # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
1149
- # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
1150
- sig { returns(T.nilable(T.nilable(String))) }
1151
- attr_accessor :custom_mandate_url
1152
- # List of Stripe products where this mandate can be selected automatically.
1153
- sig { returns(T.nilable(T::Array[String])) }
1154
- attr_accessor :default_for
1155
- # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
1156
- sig { returns(T.nilable(String)) }
1157
- attr_accessor :interval_description
1158
- # Payment schedule for the mandate.
1159
- sig { returns(T.nilable(String)) }
1160
- attr_accessor :payment_schedule
1161
- # Transaction type of the mandate.
1162
- sig { returns(T.nilable(String)) }
1163
- attr_accessor :transaction_type
1164
- sig {
1165
- params(custom_mandate_url: T.nilable(T.nilable(String)), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
1166
- }
1167
- def initialize(
1168
- custom_mandate_url: nil,
1169
- default_for: nil,
1170
- interval_description: nil,
1171
- payment_schedule: nil,
1172
- transaction_type: nil
1173
- ); end
1174
- end
1175
- # 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).
1176
- sig { returns(T.nilable(String)) }
1177
- attr_accessor :currency
1178
- # Additional fields for Mandate creation
1179
- sig {
1180
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
1181
- }
1182
- attr_accessor :mandate_options
1183
- # Bank account verification method.
1184
- sig { returns(T.nilable(String)) }
1185
- attr_accessor :verification_method
1186
- sig {
1187
- params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
1188
- }
1189
- def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
1190
- end
1191
- class AmazonPay < Stripe::RequestParams
1192
-
1193
- end
1194
- class BacsDebit < Stripe::RequestParams
1195
- class MandateOptions < Stripe::RequestParams
1196
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
1197
- sig { returns(T.nilable(T.nilable(String))) }
1198
- attr_accessor :reference_prefix
1199
- sig { params(reference_prefix: T.nilable(T.nilable(String))).void }
1200
- def initialize(reference_prefix: nil); end
1201
- end
1202
- # Additional fields for Mandate creation
1203
- sig {
1204
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
1205
- }
1206
- attr_accessor :mandate_options
1207
- sig {
1208
- params(mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
1209
- }
1210
- def initialize(mandate_options: nil); end
1211
- end
1212
- class Card < Stripe::RequestParams
1213
- class MandateOptions < Stripe::RequestParams
1214
- # Amount to be charged for future payments.
1215
- sig { returns(Integer) }
1216
- attr_accessor :amount
1217
- # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
1218
- sig { returns(String) }
1219
- attr_accessor :amount_type
1220
- # Currency in which future payments will be charged. 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).
1221
- sig { returns(String) }
1222
- attr_accessor :currency
1223
- # A description of the mandate or subscription that is meant to be displayed to the customer.
1224
- sig { returns(T.nilable(String)) }
1225
- attr_accessor :description
1226
- # End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
1227
- sig { returns(T.nilable(Integer)) }
1228
- attr_accessor :end_date
1229
- # Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
1230
- sig { returns(String) }
1231
- attr_accessor :interval
1232
- # The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
1233
- sig { returns(T.nilable(Integer)) }
1234
- attr_accessor :interval_count
1235
- # Unique identifier for the mandate or subscription.
1236
- sig { returns(String) }
1237
- attr_accessor :reference
1238
- # Start date of the mandate or subscription. Start date should not be lesser than yesterday.
1239
- sig { returns(Integer) }
1240
- attr_accessor :start_date
1241
- # Specifies the type of mandates supported. Possible values are `india`.
1242
- sig { returns(T.nilable(T::Array[String])) }
1243
- attr_accessor :supported_types
1244
- sig {
1245
- params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
1246
- }
1247
- def initialize(
1248
- amount: nil,
1249
- amount_type: nil,
1250
- currency: nil,
1251
- description: nil,
1252
- end_date: nil,
1253
- interval: nil,
1254
- interval_count: nil,
1255
- reference: nil,
1256
- start_date: nil,
1257
- supported_types: nil
1258
- ); end
1259
- end
1260
- class ThreeDSecure < Stripe::RequestParams
1261
- class NetworkOptions < Stripe::RequestParams
1262
- class CartesBancaires < Stripe::RequestParams
1263
- # The cryptogram calculation algorithm used by the card Issuer's ACS
1264
- # to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
1265
- # messageExtension: CB-AVALGO
1266
- sig { returns(String) }
1267
- attr_accessor :cb_avalgo
1268
- # The exemption indicator returned from Cartes Bancaires in the ARes.
1269
- # message extension: CB-EXEMPTION; string (4 characters)
1270
- # This is a 3 byte bitmap (low significant byte first and most significant
1271
- # bit first) that has been Base64 encoded
1272
- sig { returns(T.nilable(String)) }
1273
- attr_accessor :cb_exemption
1274
- # The risk score returned from Cartes Bancaires in the ARes.
1275
- # message extension: CB-SCORE; numeric value 0-99
1276
- sig { returns(T.nilable(Integer)) }
1277
- attr_accessor :cb_score
1278
- sig {
1279
- params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
1280
- }
1281
- def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
1282
- end
1283
- # Cartes Bancaires-specific 3DS fields.
1284
- sig {
1285
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
1286
- }
1287
- attr_accessor :cartes_bancaires
1288
- sig {
1289
- params(cartes_bancaires: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
1290
- }
1291
- def initialize(cartes_bancaires: nil); end
1292
- end
1293
- # The `transStatus` returned from the card Issuer’s ACS in the ARes.
1294
- sig { returns(T.nilable(String)) }
1295
- attr_accessor :ares_trans_status
1296
- # The cryptogram, also known as the "authentication value" (AAV, CAVV or
1297
- # AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
1298
- # (Most 3D Secure providers will return the base64-encoded version, which
1299
- # is what you should specify here.)
1300
- sig { returns(T.nilable(String)) }
1301
- attr_accessor :cryptogram
1302
- # The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
1303
- # provider and indicates what degree of authentication was performed.
1304
- sig { returns(T.nilable(String)) }
1305
- attr_accessor :electronic_commerce_indicator
1306
- # Network specific 3DS fields. Network specific arguments require an
1307
- # explicit card brand choice. The parameter `payment_method_options.card.network``
1308
- # must be populated accordingly
1309
- sig {
1310
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
1311
- }
1312
- attr_accessor :network_options
1313
- # The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
1314
- # AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
1315
- sig { returns(T.nilable(String)) }
1316
- attr_accessor :requestor_challenge_indicator
1317
- # For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
1318
- # Transaction ID (dsTransID).
1319
- sig { returns(T.nilable(String)) }
1320
- attr_accessor :transaction_id
1321
- # The version of 3D Secure that was performed.
1322
- sig { returns(T.nilable(String)) }
1323
- attr_accessor :version
1324
- sig {
1325
- params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
1326
- }
1327
- def initialize(
1328
- ares_trans_status: nil,
1329
- cryptogram: nil,
1330
- electronic_commerce_indicator: nil,
1331
- network_options: nil,
1332
- requestor_challenge_indicator: nil,
1333
- transaction_id: nil,
1334
- version: nil
1335
- ); end
1336
- end
1337
- # Configuration options for setting up an eMandate for cards issued in India.
1338
- sig {
1339
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions))
1340
- }
1341
- attr_accessor :mandate_options
1342
- # When specified, this parameter signals that a card has been collected
1343
- # as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
1344
- # parameter can only be provided during confirmation.
1345
- sig { returns(T.nilable(T::Boolean)) }
1346
- attr_accessor :moto
1347
- # Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
1348
- sig { returns(T.nilable(String)) }
1349
- attr_accessor :network
1350
- # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
1351
- sig { returns(T.nilable(String)) }
1352
- attr_accessor :request_three_d_secure
1353
- # If 3D Secure authentication was performed with a third-party provider,
1354
- # the authentication details to use for this setup.
1355
- sig {
1356
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure))
1357
- }
1358
- attr_accessor :three_d_secure
1359
- sig {
1360
- params(mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
1361
- }
1362
- def initialize(
1363
- mandate_options: nil,
1364
- moto: nil,
1365
- network: nil,
1366
- request_three_d_secure: nil,
1367
- three_d_secure: nil
1368
- ); end
1369
- end
1370
- class CardPresent < Stripe::RequestParams
1371
-
1372
- end
1373
- class Link < Stripe::RequestParams
1374
- # [Deprecated] This is a legacy parameter that no longer has any function.
1375
- sig { returns(T.nilable(String)) }
1376
- attr_accessor :persistent_token
1377
- sig { params(persistent_token: T.nilable(String)).void }
1378
- def initialize(persistent_token: nil); end
1379
- end
1380
- class Paypal < Stripe::RequestParams
1381
- # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
1382
- sig { returns(T.nilable(String)) }
1383
- attr_accessor :billing_agreement_id
1384
- sig { params(billing_agreement_id: T.nilable(String)).void }
1385
- def initialize(billing_agreement_id: nil); end
1386
- end
1387
- class SepaDebit < Stripe::RequestParams
1388
- class MandateOptions < Stripe::RequestParams
1389
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
1390
- sig { returns(T.nilable(T.nilable(String))) }
1391
- attr_accessor :reference_prefix
1392
- sig { params(reference_prefix: T.nilable(T.nilable(String))).void }
1393
- def initialize(reference_prefix: nil); end
1394
- end
1395
- # Additional fields for Mandate creation
1396
- sig {
1397
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
1398
- }
1399
- attr_accessor :mandate_options
1400
- sig {
1401
- params(mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
1402
- }
1403
- def initialize(mandate_options: nil); end
1404
- end
1405
- class UsBankAccount < Stripe::RequestParams
1406
- class FinancialConnections < Stripe::RequestParams
1407
- class Filters < Stripe::RequestParams
1408
- # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
1409
- sig { returns(T.nilable(T::Array[String])) }
1410
- attr_accessor :account_subcategories
1411
- sig { params(account_subcategories: T.nilable(T::Array[String])).void }
1412
- def initialize(account_subcategories: nil); end
1413
- end
1414
- # Provide filters for the linked accounts that the customer can select for the payment method.
1415
- sig {
1416
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
1417
- }
1418
- attr_accessor :filters
1419
- # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
1420
- sig { returns(T.nilable(T::Array[String])) }
1421
- attr_accessor :permissions
1422
- # List of data features that you would like to retrieve upon account creation.
1423
- sig { returns(T.nilable(T::Array[String])) }
1424
- attr_accessor :prefetch
1425
- # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
1426
- sig { returns(T.nilable(String)) }
1427
- attr_accessor :return_url
1428
- sig {
1429
- params(filters: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
1430
- }
1431
- def initialize(filters: nil, permissions: nil, prefetch: nil, return_url: nil); end
1432
- end
1433
- class MandateOptions < Stripe::RequestParams
1434
- # The method used to collect offline mandate customer acceptance.
1435
- sig { returns(T.nilable(T.nilable(String))) }
1436
- attr_accessor :collection_method
1437
- sig { params(collection_method: T.nilable(T.nilable(String))).void }
1438
- def initialize(collection_method: nil); end
1439
- end
1440
- class Networks < Stripe::RequestParams
1441
- # Triggers validations to run across the selected networks
1442
- sig { returns(T.nilable(T::Array[String])) }
1443
- attr_accessor :requested
1444
- sig { params(requested: T.nilable(T::Array[String])).void }
1445
- def initialize(requested: nil); end
1446
- end
1447
- # Additional fields for Financial Connections Session creation
1448
- sig {
1449
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
1450
- }
1451
- attr_accessor :financial_connections
1452
- # Additional fields for Mandate creation
1453
- sig {
1454
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
1455
- }
1456
- attr_accessor :mandate_options
1457
- # Additional fields for network related functions
1458
- sig {
1459
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks))
1460
- }
1461
- attr_accessor :networks
1462
- # Bank account verification method.
1463
- sig { returns(T.nilable(String)) }
1464
- attr_accessor :verification_method
1465
- sig {
1466
- params(financial_connections: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
1467
- }
1468
- def initialize(
1469
- financial_connections: nil,
1470
- mandate_options: nil,
1471
- networks: nil,
1472
- verification_method: nil
1473
- ); end
1474
- end
1475
- # If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
1476
- sig {
1477
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit))
1478
- }
1479
- attr_accessor :acss_debit
1480
- # If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
1481
- sig {
1482
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AmazonPay))
1483
- }
1484
- attr_accessor :amazon_pay
1485
- # If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
1486
- sig {
1487
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit))
1488
- }
1489
- attr_accessor :bacs_debit
1490
- # Configuration for any card setup attempted on this SetupIntent.
1491
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card)) }
1492
- attr_accessor :card
1493
- # If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
1494
- sig {
1495
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::CardPresent))
1496
- }
1497
- attr_accessor :card_present
1498
- # If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
1499
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Link)) }
1500
- attr_accessor :link
1501
- # If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
1502
- sig {
1503
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Paypal))
1504
- }
1505
- attr_accessor :paypal
1506
- # If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
1507
- sig {
1508
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit))
1509
- }
1510
- attr_accessor :sepa_debit
1511
- # If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
1512
- sig {
1513
- returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount))
1514
- }
1515
- attr_accessor :us_bank_account
1516
- sig {
1517
- params(acss_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::CardPresent), link: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::Paypal), sepa_debit: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions::UsBankAccount)).void
1518
- }
1519
- def initialize(
1520
- acss_debit: nil,
1521
- amazon_pay: nil,
1522
- bacs_debit: nil,
1523
- card: nil,
1524
- card_present: nil,
1525
- link: nil,
1526
- paypal: nil,
1527
- sepa_debit: nil,
1528
- us_bank_account: nil
1529
- ); end
1530
- end
1531
- class SingleUse < Stripe::RequestParams
1532
- # Amount the customer is granting permission to collect later. 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).
1533
- sig { returns(Integer) }
1534
- attr_accessor :amount
1535
- # 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).
1536
- sig { returns(String) }
1537
- attr_accessor :currency
1538
- sig { params(amount: Integer, currency: String).void }
1539
- def initialize(amount: nil, currency: nil); end
1540
- end
1541
- # If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
1542
- #
1543
- # It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
1544
- sig { returns(T.nilable(T::Boolean)) }
1545
- attr_accessor :attach_to_self
1546
- # When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.
1547
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::AutomaticPaymentMethods)) }
1548
- attr_accessor :automatic_payment_methods
1549
- # Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.
1550
- sig { returns(T.nilable(T::Boolean)) }
1551
- attr_accessor :confirm
1552
- # ID of the ConfirmationToken used to confirm this SetupIntent.
1553
- #
1554
- # If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
1555
- sig { returns(T.nilable(String)) }
1556
- attr_accessor :confirmation_token
1557
- # ID of the Customer this SetupIntent belongs to, if one exists.
1558
- #
1559
- # If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
1560
- sig { returns(T.nilable(String)) }
1561
- attr_accessor :customer
1562
- # An arbitrary string attached to the object. Often useful for displaying to users.
1563
- sig { returns(T.nilable(String)) }
1564
- attr_accessor :description
1565
- # Specifies which fields in the response should be expanded.
1566
- sig { returns(T.nilable(T::Array[String])) }
1567
- attr_accessor :expand
1568
- # Indicates the directions of money movement for which this payment method is intended to be used.
1569
- #
1570
- # Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
1571
- sig { returns(T.nilable(T::Array[String])) }
1572
- attr_accessor :flow_directions
1573
- # This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).
1574
- sig {
1575
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::MandateData))))
1576
- }
1577
- attr_accessor :mandate_data
1578
- # 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`.
1579
- sig { returns(T.nilable(T::Hash[String, String])) }
1580
- attr_accessor :metadata
1581
- # The Stripe account ID created for this SetupIntent.
1582
- sig { returns(T.nilable(String)) }
1583
- attr_accessor :on_behalf_of
1584
- # ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
1585
- sig { returns(T.nilable(String)) }
1586
- attr_accessor :payment_method
1587
- # The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.
1588
- sig { returns(T.nilable(String)) }
1589
- attr_accessor :payment_method_configuration
1590
- # When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
1591
- # value in the SetupIntent.
1592
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData)) }
1593
- attr_accessor :payment_method_data
1594
- # Payment method-specific configuration for this SetupIntent.
1595
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions)) }
1596
- attr_accessor :payment_method_options
1597
- # The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
1598
- sig { returns(T.nilable(T::Array[String])) }
1599
- attr_accessor :payment_method_types
1600
- # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).
1601
- sig { returns(T.nilable(String)) }
1602
- attr_accessor :return_url
1603
- # If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.
1604
- #
1605
- # Single-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`.
1606
- sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::SingleUse)) }
1607
- attr_accessor :single_use
1608
- # Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.
1609
- sig { returns(T.nilable(String)) }
1610
- attr_accessor :usage
1611
- # Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
1612
- sig { returns(T.nilable(T::Boolean)) }
1613
- attr_accessor :use_stripe_sdk
1614
- sig {
1615
- params(attach_to_self: T.nilable(T::Boolean), automatic_payment_methods: T.nilable(::Stripe::SetupIntent::CreateParams::AutomaticPaymentMethods), confirm: T.nilable(T::Boolean), confirmation_token: T.nilable(String), customer: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), flow_directions: T.nilable(T::Array[String]), mandate_data: T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::CreateParams::MandateData))), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), return_url: T.nilable(String), single_use: T.nilable(::Stripe::SetupIntent::CreateParams::SingleUse), usage: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
1616
- }
1617
- def initialize(
1618
- attach_to_self: nil,
1619
- automatic_payment_methods: nil,
1620
- confirm: nil,
1621
- confirmation_token: nil,
1622
- customer: nil,
1623
- description: nil,
1624
- expand: nil,
1625
- flow_directions: nil,
1626
- mandate_data: nil,
1627
- metadata: nil,
1628
- on_behalf_of: nil,
1629
- payment_method: nil,
1630
- payment_method_configuration: nil,
1631
- payment_method_data: nil,
1632
- payment_method_options: nil,
1633
- payment_method_types: nil,
1634
- return_url: nil,
1635
- single_use: nil,
1636
- usage: nil,
1637
- use_stripe_sdk: nil
1638
- ); end
1639
- end
1640
- class UpdateParams < Stripe::RequestParams
1641
- class PaymentMethodData < Stripe::RequestParams
1642
- class AcssDebit < Stripe::RequestParams
1643
- # Customer's bank account number.
1644
- sig { returns(String) }
1645
- attr_accessor :account_number
1646
- # Institution number of the customer's bank.
1647
- sig { returns(String) }
1648
- attr_accessor :institution_number
1649
- # Transit number of the customer's bank.
1650
- sig { returns(String) }
1651
- attr_accessor :transit_number
1652
- sig {
1653
- params(account_number: String, institution_number: String, transit_number: String).void
1654
- }
1655
- def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
1656
- end
1657
- class Affirm < Stripe::RequestParams
1658
-
1659
- end
1660
- class AfterpayClearpay < Stripe::RequestParams
1661
-
1662
- end
1663
- class Alipay < Stripe::RequestParams
1664
-
1665
- end
1666
- class Alma < Stripe::RequestParams
1667
-
1668
- end
1669
- class AmazonPay < Stripe::RequestParams
1670
-
1671
- end
1672
- class AuBecsDebit < Stripe::RequestParams
1673
- # The account number for the bank account.
1674
- sig { returns(String) }
1675
- attr_accessor :account_number
1676
- # Bank-State-Branch number of the bank account.
1677
- sig { returns(String) }
1678
- attr_accessor :bsb_number
1679
- sig { params(account_number: String, bsb_number: String).void }
1680
- def initialize(account_number: nil, bsb_number: nil); end
1681
- end
1682
- class BacsDebit < Stripe::RequestParams
1683
- # Account number of the bank account that the funds will be debited from.
1684
- sig { returns(T.nilable(String)) }
1685
- attr_accessor :account_number
1686
- # Sort code of the bank account. (e.g., `10-20-30`)
1687
- sig { returns(T.nilable(String)) }
1688
- attr_accessor :sort_code
1689
- sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
1690
- def initialize(account_number: nil, sort_code: nil); end
1691
- end
1692
- class Bancontact < Stripe::RequestParams
1693
-
1694
- end
1695
- class Billie < Stripe::RequestParams
1696
-
1697
- end
1698
- class BillingDetails < Stripe::RequestParams
1699
- class Address < Stripe::RequestParams
1700
- # City, district, suburb, town, or village.
1701
- sig { returns(T.nilable(String)) }
1702
- attr_accessor :city
1703
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
1704
- sig { returns(T.nilable(String)) }
1705
- attr_accessor :country
1706
- # Address line 1 (e.g., street, PO Box, or company name).
1707
- sig { returns(T.nilable(String)) }
1708
- attr_accessor :line1
1709
- # Address line 2 (e.g., apartment, suite, unit, or building).
1710
- sig { returns(T.nilable(String)) }
1711
- attr_accessor :line2
1712
- # ZIP or postal code.
1713
- sig { returns(T.nilable(String)) }
1714
- attr_accessor :postal_code
1715
- # State, county, province, or region.
1716
- sig { returns(T.nilable(String)) }
1717
- attr_accessor :state
1718
- sig {
1719
- 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
1720
- }
1721
- def initialize(
1722
- city: nil,
1723
- country: nil,
1724
- line1: nil,
1725
- line2: nil,
1726
- postal_code: nil,
1727
- state: nil
1728
- ); end
1729
- end
1730
- # Billing address.
1731
- sig {
1732
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails::Address))))
1733
- }
1734
- attr_accessor :address
1735
- # Email address.
1736
- sig { returns(T.nilable(T.nilable(String))) }
1737
- attr_accessor :email
1738
- # Full name.
1739
- sig { returns(T.nilable(T.nilable(String))) }
1740
- attr_accessor :name
1741
- # Billing phone number (including extension).
1742
- sig { returns(T.nilable(T.nilable(String))) }
1743
- attr_accessor :phone
1744
- sig {
1745
- params(address: T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails::Address))), email: T.nilable(T.nilable(String)), name: T.nilable(T.nilable(String)), phone: T.nilable(T.nilable(String))).void
1746
- }
1747
- def initialize(address: nil, email: nil, name: nil, phone: nil); end
1748
- end
1749
- class Blik < Stripe::RequestParams
1750
-
1751
- end
1752
- class Boleto < Stripe::RequestParams
1753
- # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
1754
- sig { returns(String) }
1755
- attr_accessor :tax_id
1756
- sig { params(tax_id: String).void }
1757
- def initialize(tax_id: nil); end
1758
- end
1759
- class Cashapp < Stripe::RequestParams
1760
-
1761
- end
1762
- class CustomerBalance < Stripe::RequestParams
1763
-
1764
- end
1765
- class Eps < Stripe::RequestParams
1766
- # The customer's bank.
1767
- sig { returns(T.nilable(String)) }
1768
- attr_accessor :bank
1769
- sig { params(bank: T.nilable(String)).void }
1770
- def initialize(bank: nil); end
1771
- end
1772
- class Fpx < Stripe::RequestParams
1773
- # Account holder type for FPX transaction
1774
- sig { returns(T.nilable(String)) }
1775
- attr_accessor :account_holder_type
1776
- # The customer's bank.
1777
- sig { returns(String) }
1778
- attr_accessor :bank
1779
- sig { params(account_holder_type: T.nilable(String), bank: String).void }
1780
- def initialize(account_holder_type: nil, bank: nil); end
1781
- end
1782
- class Giropay < Stripe::RequestParams
1783
-
1784
- end
1785
- class Grabpay < Stripe::RequestParams
1786
-
1787
- end
1788
- class Ideal < Stripe::RequestParams
1789
- # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
1790
- sig { returns(T.nilable(String)) }
1791
- attr_accessor :bank
1792
- sig { params(bank: T.nilable(String)).void }
1793
- def initialize(bank: nil); end
1794
- end
1795
- class InteracPresent < Stripe::RequestParams
1796
-
1797
- end
1798
- class KakaoPay < Stripe::RequestParams
1799
-
1800
- end
1801
- class Klarna < Stripe::RequestParams
1802
- class Dob < Stripe::RequestParams
1803
- # The day of birth, between 1 and 31.
1804
- sig { returns(Integer) }
1805
- attr_accessor :day
1806
- # The month of birth, between 1 and 12.
1807
- sig { returns(Integer) }
1808
- attr_accessor :month
1809
- # The four-digit year of birth.
1810
- sig { returns(Integer) }
1811
- attr_accessor :year
1812
- sig { params(day: Integer, month: Integer, year: Integer).void }
1813
- def initialize(day: nil, month: nil, year: nil); end
1814
- end
1815
- # Customer's date of birth
1816
- sig {
1817
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna::Dob))
1818
- }
1819
- attr_accessor :dob
1820
- sig {
1821
- params(dob: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna::Dob)).void
1822
- }
1823
- def initialize(dob: nil); end
1824
- end
1825
- class Konbini < Stripe::RequestParams
1826
-
1827
- end
1828
- class KrCard < Stripe::RequestParams
1829
-
1830
- end
1831
- class Link < Stripe::RequestParams
1832
-
1833
- end
1834
- class Mobilepay < Stripe::RequestParams
1835
-
1836
- end
1837
- class Multibanco < Stripe::RequestParams
1838
-
1839
- end
1840
- class NaverPay < Stripe::RequestParams
1841
- # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
1842
- sig { returns(T.nilable(String)) }
1843
- attr_accessor :funding
1844
- sig { params(funding: T.nilable(String)).void }
1845
- def initialize(funding: nil); end
1846
- end
1847
- class NzBankAccount < Stripe::RequestParams
1848
- # The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
1849
- sig { returns(T.nilable(String)) }
1850
- attr_accessor :account_holder_name
1851
- # The account number for the bank account.
1852
- sig { returns(String) }
1853
- attr_accessor :account_number
1854
- # The numeric code for the bank account's bank.
1855
- sig { returns(String) }
1856
- attr_accessor :bank_code
1857
- # The numeric code for the bank account's bank branch.
1858
- sig { returns(String) }
1859
- attr_accessor :branch_code
1860
- # Attribute for param field reference
1861
- sig { returns(T.nilable(String)) }
1862
- attr_accessor :reference
1863
- # The suffix of the bank account number.
1864
- sig { returns(String) }
1865
- attr_accessor :suffix
1866
- sig {
1867
- params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
1868
- }
1869
- def initialize(
1870
- account_holder_name: nil,
1871
- account_number: nil,
1872
- bank_code: nil,
1873
- branch_code: nil,
1874
- reference: nil,
1875
- suffix: nil
1876
- ); end
1877
- end
1878
- class Oxxo < Stripe::RequestParams
1879
-
1880
- end
1881
- class P24 < Stripe::RequestParams
1882
- # The customer's bank.
1883
- sig { returns(T.nilable(String)) }
1884
- attr_accessor :bank
1885
- sig { params(bank: T.nilable(String)).void }
1886
- def initialize(bank: nil); end
1887
- end
1888
- class PayByBank < Stripe::RequestParams
1889
-
1890
- end
1891
- class Payco < Stripe::RequestParams
1892
-
1893
- end
1894
- class Paynow < Stripe::RequestParams
1895
-
1896
- end
1897
- class Paypal < Stripe::RequestParams
1898
-
1899
- end
1900
- class Pix < Stripe::RequestParams
1901
-
1902
- end
1903
- class Promptpay < Stripe::RequestParams
1904
-
1905
- end
1906
- class RadarOptions < Stripe::RequestParams
1907
- # 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.
1908
- sig { returns(T.nilable(String)) }
1909
- attr_accessor :session
1910
- sig { params(session: T.nilable(String)).void }
1911
- def initialize(session: nil); end
1912
- end
1913
- class RevolutPay < Stripe::RequestParams
1914
-
1915
- end
1916
- class SamsungPay < Stripe::RequestParams
1917
-
1918
- end
1919
- class Satispay < Stripe::RequestParams
1920
-
1921
- end
1922
- class SepaDebit < Stripe::RequestParams
1923
- # IBAN of the bank account.
1924
- sig { returns(String) }
1925
- attr_accessor :iban
1926
- sig { params(iban: String).void }
1927
- def initialize(iban: nil); end
1928
- end
1929
- class Sofort < Stripe::RequestParams
1930
- # Two-letter ISO code representing the country the bank account is located in.
1931
- sig { returns(String) }
1932
- attr_accessor :country
1933
- sig { params(country: String).void }
1934
- def initialize(country: nil); end
1935
- end
1936
- class Swish < Stripe::RequestParams
1937
-
1938
- end
1939
- class Twint < Stripe::RequestParams
1940
-
1941
- end
1942
- class UsBankAccount < Stripe::RequestParams
1943
- # Account holder type: individual or company.
1944
- sig { returns(T.nilable(String)) }
1945
- attr_accessor :account_holder_type
1946
- # Account number of the bank account.
1947
- sig { returns(T.nilable(String)) }
1948
- attr_accessor :account_number
1949
- # Account type: checkings or savings. Defaults to checking if omitted.
1950
- sig { returns(T.nilable(String)) }
1951
- attr_accessor :account_type
1952
- # The ID of a Financial Connections Account to use as a payment method.
1953
- sig { returns(T.nilable(String)) }
1954
- attr_accessor :financial_connections_account
1955
- # Routing number of the bank account.
1956
- sig { returns(T.nilable(String)) }
1957
- attr_accessor :routing_number
1958
- sig {
1959
- params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
1960
- }
1961
- def initialize(
1962
- account_holder_type: nil,
1963
- account_number: nil,
1964
- account_type: nil,
1965
- financial_connections_account: nil,
1966
- routing_number: nil
1967
- ); end
1968
- end
1969
- class WechatPay < Stripe::RequestParams
1970
-
1971
- end
1972
- class Zip < Stripe::RequestParams
1973
-
1974
- end
1975
- # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
1976
- sig {
1977
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AcssDebit))
1978
- }
1979
- attr_accessor :acss_debit
1980
- # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
1981
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Affirm)) }
1982
- attr_accessor :affirm
1983
- # If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
1984
- sig {
1985
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AfterpayClearpay))
1986
- }
1987
- attr_accessor :afterpay_clearpay
1988
- # If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
1989
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alipay)) }
1990
- attr_accessor :alipay
1991
- # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
1992
- sig { returns(T.nilable(String)) }
1993
- attr_accessor :allow_redisplay
1994
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
1995
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alma)) }
1996
- attr_accessor :alma
1997
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
1998
- sig {
1999
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AmazonPay))
2000
- }
2001
- attr_accessor :amazon_pay
2002
- # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
2003
- sig {
2004
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AuBecsDebit))
2005
- }
2006
- attr_accessor :au_becs_debit
2007
- # If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
2008
- sig {
2009
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BacsDebit))
2010
- }
2011
- attr_accessor :bacs_debit
2012
- # If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
2013
- sig {
2014
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Bancontact))
2015
- }
2016
- attr_accessor :bancontact
2017
- # If this is a `billie` PaymentMethod, this hash contains details about the billie payment method.
2018
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Billie)) }
2019
- attr_accessor :billie
2020
- # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
2021
- sig {
2022
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails))
2023
- }
2024
- attr_accessor :billing_details
2025
- # If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
2026
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Blik)) }
2027
- attr_accessor :blik
2028
- # If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
2029
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Boleto)) }
2030
- attr_accessor :boleto
2031
- # If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
2032
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Cashapp)) }
2033
- attr_accessor :cashapp
2034
- # If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
2035
- sig {
2036
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::CustomerBalance))
2037
- }
2038
- attr_accessor :customer_balance
2039
- # If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
2040
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Eps)) }
2041
- attr_accessor :eps
2042
- # If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
2043
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Fpx)) }
2044
- attr_accessor :fpx
2045
- # If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
2046
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Giropay)) }
2047
- attr_accessor :giropay
2048
- # If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
2049
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Grabpay)) }
2050
- attr_accessor :grabpay
2051
- # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
2052
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Ideal)) }
2053
- attr_accessor :ideal
2054
- # If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
2055
- sig {
2056
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::InteracPresent))
2057
- }
2058
- attr_accessor :interac_present
2059
- # If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
2060
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KakaoPay)) }
2061
- attr_accessor :kakao_pay
2062
- # If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
2063
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna)) }
2064
- attr_accessor :klarna
2065
- # If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
2066
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Konbini)) }
2067
- attr_accessor :konbini
2068
- # If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
2069
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KrCard)) }
2070
- attr_accessor :kr_card
2071
- # If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
2072
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Link)) }
2073
- attr_accessor :link
2074
- # 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`.
2075
- sig { returns(T.nilable(T::Hash[String, String])) }
2076
- attr_accessor :metadata
2077
- # If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
2078
- sig {
2079
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Mobilepay))
2080
- }
2081
- attr_accessor :mobilepay
2082
- # If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
2083
- sig {
2084
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Multibanco))
2085
- }
2086
- attr_accessor :multibanco
2087
- # If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
2088
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NaverPay)) }
2089
- attr_accessor :naver_pay
2090
- # If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
2091
- sig {
2092
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NzBankAccount))
2093
- }
2094
- attr_accessor :nz_bank_account
2095
- # If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
2096
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Oxxo)) }
2097
- attr_accessor :oxxo
2098
- # If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
2099
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::P24)) }
2100
- attr_accessor :p24
2101
- # If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
2102
- sig {
2103
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::PayByBank))
2104
- }
2105
- attr_accessor :pay_by_bank
2106
- # If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
2107
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payco)) }
2108
- attr_accessor :payco
2109
- # If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
2110
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paynow)) }
2111
- attr_accessor :paynow
2112
- # If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
2113
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypal)) }
2114
- attr_accessor :paypal
2115
- # If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
2116
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Pix)) }
2117
- attr_accessor :pix
2118
- # If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
2119
- sig {
2120
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Promptpay))
2121
- }
2122
- attr_accessor :promptpay
2123
- # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
2124
- sig {
2125
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RadarOptions))
2126
- }
2127
- attr_accessor :radar_options
2128
- # If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
2129
- sig {
2130
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RevolutPay))
2131
- }
2132
- attr_accessor :revolut_pay
2133
- # If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
2134
- sig {
2135
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SamsungPay))
2136
- }
2137
- attr_accessor :samsung_pay
2138
- # If this is a `satispay` PaymentMethod, this hash contains details about the satispay payment method.
2139
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Satispay)) }
2140
- attr_accessor :satispay
2141
- # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
2142
- sig {
2143
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SepaDebit))
2144
- }
2145
- attr_accessor :sepa_debit
2146
- # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
2147
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Sofort)) }
2148
- attr_accessor :sofort
2149
- # If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
2150
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Swish)) }
2151
- attr_accessor :swish
2152
- # If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
2153
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Twint)) }
2154
- attr_accessor :twint
2155
- # The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
2156
- sig { returns(String) }
2157
- attr_accessor :type
2158
- # If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
2159
- sig {
2160
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::UsBankAccount))
2161
- }
2162
- attr_accessor :us_bank_account
2163
- # If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
2164
- sig {
2165
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::WechatPay))
2166
- }
2167
- attr_accessor :wechat_pay
2168
- # If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
2169
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Zip)) }
2170
- attr_accessor :zip
2171
- sig {
2172
- params(acss_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Cashapp), customer_balance: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Giropay), grabpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Grabpay), ideal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Link), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Paypal), pix: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Promptpay), radar_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RadarOptions), revolut_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::SepaDebit), sofort: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Sofort), swish: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::Zip)).void
2173
- }
2174
- def initialize(
2175
- acss_debit: nil,
2176
- affirm: nil,
2177
- afterpay_clearpay: nil,
2178
- alipay: nil,
2179
- allow_redisplay: nil,
2180
- alma: nil,
2181
- amazon_pay: nil,
2182
- au_becs_debit: nil,
2183
- bacs_debit: nil,
2184
- bancontact: nil,
2185
- billie: nil,
2186
- billing_details: nil,
2187
- blik: nil,
2188
- boleto: nil,
2189
- cashapp: nil,
2190
- customer_balance: nil,
2191
- eps: nil,
2192
- fpx: nil,
2193
- giropay: nil,
2194
- grabpay: nil,
2195
- ideal: nil,
2196
- interac_present: nil,
2197
- kakao_pay: nil,
2198
- klarna: nil,
2199
- konbini: nil,
2200
- kr_card: nil,
2201
- link: nil,
2202
- metadata: nil,
2203
- mobilepay: nil,
2204
- multibanco: nil,
2205
- naver_pay: nil,
2206
- nz_bank_account: nil,
2207
- oxxo: nil,
2208
- p24: nil,
2209
- pay_by_bank: nil,
2210
- payco: nil,
2211
- paynow: nil,
2212
- paypal: nil,
2213
- pix: nil,
2214
- promptpay: nil,
2215
- radar_options: nil,
2216
- revolut_pay: nil,
2217
- samsung_pay: nil,
2218
- satispay: nil,
2219
- sepa_debit: nil,
2220
- sofort: nil,
2221
- swish: nil,
2222
- twint: nil,
2223
- type: nil,
2224
- us_bank_account: nil,
2225
- wechat_pay: nil,
2226
- zip: nil
2227
- ); end
2228
- end
2229
- class PaymentMethodOptions < Stripe::RequestParams
2230
- class AcssDebit < Stripe::RequestParams
2231
- class MandateOptions < Stripe::RequestParams
2232
- # A URL for custom mandate text to render during confirmation step.
2233
- # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
2234
- # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
2235
- sig { returns(T.nilable(T.nilable(String))) }
2236
- attr_accessor :custom_mandate_url
2237
- # List of Stripe products where this mandate can be selected automatically.
2238
- sig { returns(T.nilable(T::Array[String])) }
2239
- attr_accessor :default_for
2240
- # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
2241
- sig { returns(T.nilable(String)) }
2242
- attr_accessor :interval_description
2243
- # Payment schedule for the mandate.
2244
- sig { returns(T.nilable(String)) }
2245
- attr_accessor :payment_schedule
2246
- # Transaction type of the mandate.
2247
- sig { returns(T.nilable(String)) }
2248
- attr_accessor :transaction_type
2249
- sig {
2250
- params(custom_mandate_url: T.nilable(T.nilable(String)), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
2251
- }
2252
- def initialize(
2253
- custom_mandate_url: nil,
2254
- default_for: nil,
2255
- interval_description: nil,
2256
- payment_schedule: nil,
2257
- transaction_type: nil
2258
- ); end
2259
- end
2260
- # 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).
2261
- sig { returns(T.nilable(String)) }
2262
- attr_accessor :currency
2263
- # Additional fields for Mandate creation
2264
- sig {
2265
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions))
2266
- }
2267
- attr_accessor :mandate_options
2268
- # Bank account verification method.
2269
- sig { returns(T.nilable(String)) }
2270
- attr_accessor :verification_method
2271
- sig {
2272
- params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
2273
- }
2274
- def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
2275
- end
2276
- class AmazonPay < Stripe::RequestParams
2277
-
2278
- end
2279
- class BacsDebit < Stripe::RequestParams
2280
- class MandateOptions < Stripe::RequestParams
2281
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
2282
- sig { returns(T.nilable(T.nilable(String))) }
2283
- attr_accessor :reference_prefix
2284
- sig { params(reference_prefix: T.nilable(T.nilable(String))).void }
2285
- def initialize(reference_prefix: nil); end
2286
- end
2287
- # Additional fields for Mandate creation
2288
- sig {
2289
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions))
2290
- }
2291
- attr_accessor :mandate_options
2292
- sig {
2293
- params(mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
2294
- }
2295
- def initialize(mandate_options: nil); end
2296
- end
2297
- class Card < Stripe::RequestParams
2298
- class MandateOptions < Stripe::RequestParams
2299
- # Amount to be charged for future payments.
2300
- sig { returns(Integer) }
2301
- attr_accessor :amount
2302
- # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
2303
- sig { returns(String) }
2304
- attr_accessor :amount_type
2305
- # Currency in which future payments will be charged. 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).
2306
- sig { returns(String) }
2307
- attr_accessor :currency
2308
- # A description of the mandate or subscription that is meant to be displayed to the customer.
2309
- sig { returns(T.nilable(String)) }
2310
- attr_accessor :description
2311
- # End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
2312
- sig { returns(T.nilable(Integer)) }
2313
- attr_accessor :end_date
2314
- # Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
2315
- sig { returns(String) }
2316
- attr_accessor :interval
2317
- # The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
2318
- sig { returns(T.nilable(Integer)) }
2319
- attr_accessor :interval_count
2320
- # Unique identifier for the mandate or subscription.
2321
- sig { returns(String) }
2322
- attr_accessor :reference
2323
- # Start date of the mandate or subscription. Start date should not be lesser than yesterday.
2324
- sig { returns(Integer) }
2325
- attr_accessor :start_date
2326
- # Specifies the type of mandates supported. Possible values are `india`.
2327
- sig { returns(T.nilable(T::Array[String])) }
2328
- attr_accessor :supported_types
2329
- sig {
2330
- params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
2331
- }
2332
- def initialize(
2333
- amount: nil,
2334
- amount_type: nil,
2335
- currency: nil,
2336
- description: nil,
2337
- end_date: nil,
2338
- interval: nil,
2339
- interval_count: nil,
2340
- reference: nil,
2341
- start_date: nil,
2342
- supported_types: nil
2343
- ); end
2344
- end
2345
- class ThreeDSecure < Stripe::RequestParams
2346
- class NetworkOptions < Stripe::RequestParams
2347
- class CartesBancaires < Stripe::RequestParams
2348
- # The cryptogram calculation algorithm used by the card Issuer's ACS
2349
- # to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
2350
- # messageExtension: CB-AVALGO
2351
- sig { returns(String) }
2352
- attr_accessor :cb_avalgo
2353
- # The exemption indicator returned from Cartes Bancaires in the ARes.
2354
- # message extension: CB-EXEMPTION; string (4 characters)
2355
- # This is a 3 byte bitmap (low significant byte first and most significant
2356
- # bit first) that has been Base64 encoded
2357
- sig { returns(T.nilable(String)) }
2358
- attr_accessor :cb_exemption
2359
- # The risk score returned from Cartes Bancaires in the ARes.
2360
- # message extension: CB-SCORE; numeric value 0-99
2361
- sig { returns(T.nilable(Integer)) }
2362
- attr_accessor :cb_score
2363
- sig {
2364
- params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
2365
- }
2366
- def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
2367
- end
2368
- # Cartes Bancaires-specific 3DS fields.
2369
- sig {
2370
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
2371
- }
2372
- attr_accessor :cartes_bancaires
2373
- sig {
2374
- params(cartes_bancaires: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
2375
- }
2376
- def initialize(cartes_bancaires: nil); end
2377
- end
2378
- # The `transStatus` returned from the card Issuer’s ACS in the ARes.
2379
- sig { returns(T.nilable(String)) }
2380
- attr_accessor :ares_trans_status
2381
- # The cryptogram, also known as the "authentication value" (AAV, CAVV or
2382
- # AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
2383
- # (Most 3D Secure providers will return the base64-encoded version, which
2384
- # is what you should specify here.)
2385
- sig { returns(T.nilable(String)) }
2386
- attr_accessor :cryptogram
2387
- # The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
2388
- # provider and indicates what degree of authentication was performed.
2389
- sig { returns(T.nilable(String)) }
2390
- attr_accessor :electronic_commerce_indicator
2391
- # Network specific 3DS fields. Network specific arguments require an
2392
- # explicit card brand choice. The parameter `payment_method_options.card.network``
2393
- # must be populated accordingly
2394
- sig {
2395
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
2396
- }
2397
- attr_accessor :network_options
2398
- # The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
2399
- # AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
2400
- sig { returns(T.nilable(String)) }
2401
- attr_accessor :requestor_challenge_indicator
2402
- # For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
2403
- # Transaction ID (dsTransID).
2404
- sig { returns(T.nilable(String)) }
2405
- attr_accessor :transaction_id
2406
- # The version of 3D Secure that was performed.
2407
- sig { returns(T.nilable(String)) }
2408
- attr_accessor :version
2409
- sig {
2410
- params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
2411
- }
2412
- def initialize(
2413
- ares_trans_status: nil,
2414
- cryptogram: nil,
2415
- electronic_commerce_indicator: nil,
2416
- network_options: nil,
2417
- requestor_challenge_indicator: nil,
2418
- transaction_id: nil,
2419
- version: nil
2420
- ); end
2421
- end
2422
- # Configuration options for setting up an eMandate for cards issued in India.
2423
- sig {
2424
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions))
2425
- }
2426
- attr_accessor :mandate_options
2427
- # When specified, this parameter signals that a card has been collected
2428
- # as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
2429
- # parameter can only be provided during confirmation.
2430
- sig { returns(T.nilable(T::Boolean)) }
2431
- attr_accessor :moto
2432
- # Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
2433
- sig { returns(T.nilable(String)) }
2434
- attr_accessor :network
2435
- # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
2436
- sig { returns(T.nilable(String)) }
2437
- attr_accessor :request_three_d_secure
2438
- # If 3D Secure authentication was performed with a third-party provider,
2439
- # the authentication details to use for this setup.
2440
- sig {
2441
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure))
2442
- }
2443
- attr_accessor :three_d_secure
2444
- sig {
2445
- params(mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::ThreeDSecure)).void
2446
- }
2447
- def initialize(
2448
- mandate_options: nil,
2449
- moto: nil,
2450
- network: nil,
2451
- request_three_d_secure: nil,
2452
- three_d_secure: nil
2453
- ); end
2454
- end
2455
- class CardPresent < Stripe::RequestParams
2456
-
2457
- end
2458
- class Link < Stripe::RequestParams
2459
- # [Deprecated] This is a legacy parameter that no longer has any function.
2460
- sig { returns(T.nilable(String)) }
2461
- attr_accessor :persistent_token
2462
- sig { params(persistent_token: T.nilable(String)).void }
2463
- def initialize(persistent_token: nil); end
2464
- end
2465
- class Paypal < Stripe::RequestParams
2466
- # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
2467
- sig { returns(T.nilable(String)) }
2468
- attr_accessor :billing_agreement_id
2469
- sig { params(billing_agreement_id: T.nilable(String)).void }
2470
- def initialize(billing_agreement_id: nil); end
2471
- end
2472
- class SepaDebit < Stripe::RequestParams
2473
- class MandateOptions < Stripe::RequestParams
2474
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
2475
- sig { returns(T.nilable(T.nilable(String))) }
2476
- attr_accessor :reference_prefix
2477
- sig { params(reference_prefix: T.nilable(T.nilable(String))).void }
2478
- def initialize(reference_prefix: nil); end
2479
- end
2480
- # Additional fields for Mandate creation
2481
- sig {
2482
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions))
2483
- }
2484
- attr_accessor :mandate_options
2485
- sig {
2486
- params(mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
2487
- }
2488
- def initialize(mandate_options: nil); end
2489
- end
2490
- class UsBankAccount < Stripe::RequestParams
2491
- class FinancialConnections < Stripe::RequestParams
2492
- class Filters < Stripe::RequestParams
2493
- # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
2494
- sig { returns(T.nilable(T::Array[String])) }
2495
- attr_accessor :account_subcategories
2496
- sig { params(account_subcategories: T.nilable(T::Array[String])).void }
2497
- def initialize(account_subcategories: nil); end
2498
- end
2499
- # Provide filters for the linked accounts that the customer can select for the payment method.
2500
- sig {
2501
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
2502
- }
2503
- attr_accessor :filters
2504
- # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
2505
- sig { returns(T.nilable(T::Array[String])) }
2506
- attr_accessor :permissions
2507
- # List of data features that you would like to retrieve upon account creation.
2508
- sig { returns(T.nilable(T::Array[String])) }
2509
- attr_accessor :prefetch
2510
- # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
2511
- sig { returns(T.nilable(String)) }
2512
- attr_accessor :return_url
2513
- sig {
2514
- params(filters: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
2515
- }
2516
- def initialize(filters: nil, permissions: nil, prefetch: nil, return_url: nil); end
2517
- end
2518
- class MandateOptions < Stripe::RequestParams
2519
- # The method used to collect offline mandate customer acceptance.
2520
- sig { returns(T.nilable(T.nilable(String))) }
2521
- attr_accessor :collection_method
2522
- sig { params(collection_method: T.nilable(T.nilable(String))).void }
2523
- def initialize(collection_method: nil); end
2524
- end
2525
- class Networks < Stripe::RequestParams
2526
- # Triggers validations to run across the selected networks
2527
- sig { returns(T.nilable(T::Array[String])) }
2528
- attr_accessor :requested
2529
- sig { params(requested: T.nilable(T::Array[String])).void }
2530
- def initialize(requested: nil); end
2531
- end
2532
- # Additional fields for Financial Connections Session creation
2533
- sig {
2534
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
2535
- }
2536
- attr_accessor :financial_connections
2537
- # Additional fields for Mandate creation
2538
- sig {
2539
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
2540
- }
2541
- attr_accessor :mandate_options
2542
- # Additional fields for network related functions
2543
- sig {
2544
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks))
2545
- }
2546
- attr_accessor :networks
2547
- # Bank account verification method.
2548
- sig { returns(T.nilable(String)) }
2549
- attr_accessor :verification_method
2550
- sig {
2551
- params(financial_connections: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
2552
- }
2553
- def initialize(
2554
- financial_connections: nil,
2555
- mandate_options: nil,
2556
- networks: nil,
2557
- verification_method: nil
2558
- ); end
2559
- end
2560
- # If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
2561
- sig {
2562
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit))
2563
- }
2564
- attr_accessor :acss_debit
2565
- # If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
2566
- sig {
2567
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AmazonPay))
2568
- }
2569
- attr_accessor :amazon_pay
2570
- # If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
2571
- sig {
2572
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit))
2573
- }
2574
- attr_accessor :bacs_debit
2575
- # Configuration for any card setup attempted on this SetupIntent.
2576
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card)) }
2577
- attr_accessor :card
2578
- # If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
2579
- sig {
2580
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::CardPresent))
2581
- }
2582
- attr_accessor :card_present
2583
- # If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
2584
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Link)) }
2585
- attr_accessor :link
2586
- # If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
2587
- sig {
2588
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Paypal))
2589
- }
2590
- attr_accessor :paypal
2591
- # If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
2592
- sig {
2593
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit))
2594
- }
2595
- attr_accessor :sepa_debit
2596
- # If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
2597
- sig {
2598
- returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount))
2599
- }
2600
- attr_accessor :us_bank_account
2601
- sig {
2602
- params(acss_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::CardPresent), link: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Paypal), sepa_debit: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::UsBankAccount)).void
2603
- }
2604
- def initialize(
2605
- acss_debit: nil,
2606
- amazon_pay: nil,
2607
- bacs_debit: nil,
2608
- card: nil,
2609
- card_present: nil,
2610
- link: nil,
2611
- paypal: nil,
2612
- sepa_debit: nil,
2613
- us_bank_account: nil
2614
- ); end
2615
- end
2616
- # If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
2617
- #
2618
- # It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
2619
- sig { returns(T.nilable(T::Boolean)) }
2620
- attr_accessor :attach_to_self
2621
- # ID of the Customer this SetupIntent belongs to, if one exists.
2622
- #
2623
- # If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
2624
- sig { returns(T.nilable(String)) }
2625
- attr_accessor :customer
2626
- # An arbitrary string attached to the object. Often useful for displaying to users.
2627
- sig { returns(T.nilable(String)) }
2628
- attr_accessor :description
2629
- # Specifies which fields in the response should be expanded.
2630
- sig { returns(T.nilable(T::Array[String])) }
2631
- attr_accessor :expand
2632
- # Indicates the directions of money movement for which this payment method is intended to be used.
2633
- #
2634
- # Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
2635
- sig { returns(T.nilable(T::Array[String])) }
2636
- attr_accessor :flow_directions
2637
- # 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`.
2638
- sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
2639
- attr_accessor :metadata
2640
- # ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.
2641
- sig { returns(T.nilable(String)) }
2642
- attr_accessor :payment_method
2643
- # The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.
2644
- sig { returns(T.nilable(String)) }
2645
- attr_accessor :payment_method_configuration
2646
- # When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
2647
- # value in the SetupIntent.
2648
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData)) }
2649
- attr_accessor :payment_method_data
2650
- # Payment method-specific configuration for this SetupIntent.
2651
- sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions)) }
2652
- attr_accessor :payment_method_options
2653
- # The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
2654
- sig { returns(T.nilable(T::Array[String])) }
2655
- attr_accessor :payment_method_types
2656
- sig {
2657
- params(attach_to_self: T.nilable(T::Boolean), customer: T.nilable(String), description: T.nilable(String), expand: T.nilable(T::Array[String]), flow_directions: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String])).void
2658
- }
2659
- def initialize(
2660
- attach_to_self: nil,
2661
- customer: nil,
2662
- description: nil,
2663
- expand: nil,
2664
- flow_directions: nil,
2665
- metadata: nil,
2666
- payment_method: nil,
2667
- payment_method_configuration: nil,
2668
- payment_method_data: nil,
2669
- payment_method_options: nil,
2670
- payment_method_types: nil
2671
- ); end
2672
- end
2673
- class CancelParams < Stripe::RequestParams
2674
- # Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate`
2675
- sig { returns(T.nilable(String)) }
2676
- attr_accessor :cancellation_reason
2677
- # Specifies which fields in the response should be expanded.
2678
- sig { returns(T.nilable(T::Array[String])) }
2679
- attr_accessor :expand
2680
- sig {
2681
- params(cancellation_reason: T.nilable(String), expand: T.nilable(T::Array[String])).void
2682
- }
2683
- def initialize(cancellation_reason: nil, expand: nil); end
2684
- end
2685
- class ConfirmParams < Stripe::RequestParams
2686
- class MandateData < Stripe::RequestParams
2687
- class CustomerAcceptance < Stripe::RequestParams
2688
- class Offline < Stripe::RequestParams
2689
-
2690
- end
2691
- class Online < Stripe::RequestParams
2692
- # The IP address from which the Mandate was accepted by the customer.
2693
- sig { returns(T.nilable(String)) }
2694
- attr_accessor :ip_address
2695
- # The user agent of the browser from which the Mandate was accepted by the customer.
2696
- sig { returns(T.nilable(String)) }
2697
- attr_accessor :user_agent
2698
- sig { params(ip_address: T.nilable(String), user_agent: T.nilable(String)).void }
2699
- def initialize(ip_address: nil, user_agent: nil); end
2700
- end
2701
- # The time at which the customer accepted the Mandate.
2702
- sig { returns(T.nilable(Integer)) }
2703
- attr_accessor :accepted_at
2704
- # If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
2705
- sig {
2706
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline))
2707
- }
2708
- attr_accessor :offline
2709
- # If this is a Mandate accepted online, this hash contains details about the online acceptance.
2710
- sig {
2711
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Online))
2712
- }
2713
- attr_accessor :online
2714
- # The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
2715
- sig { returns(String) }
2716
- attr_accessor :type
2717
- sig {
2718
- params(accepted_at: T.nilable(Integer), offline: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Offline), online: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance::Online), type: String).void
2719
- }
2720
- def initialize(accepted_at: nil, offline: nil, online: nil, type: nil); end
2721
- end
2722
- # This hash contains details about the customer acceptance of the Mandate.
2723
- sig {
2724
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance))
2725
- }
2726
- attr_accessor :customer_acceptance
2727
- sig {
2728
- params(customer_acceptance: T.nilable(::Stripe::SetupIntent::ConfirmParams::MandateData::CustomerAcceptance)).void
2729
- }
2730
- def initialize(customer_acceptance: nil); end
2731
- end
2732
- class PaymentMethodData < Stripe::RequestParams
2733
- class AcssDebit < Stripe::RequestParams
2734
- # Customer's bank account number.
2735
- sig { returns(String) }
2736
- attr_accessor :account_number
2737
- # Institution number of the customer's bank.
2738
- sig { returns(String) }
2739
- attr_accessor :institution_number
2740
- # Transit number of the customer's bank.
2741
- sig { returns(String) }
2742
- attr_accessor :transit_number
2743
- sig {
2744
- params(account_number: String, institution_number: String, transit_number: String).void
2745
- }
2746
- def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
2747
- end
2748
- class Affirm < Stripe::RequestParams
2749
-
2750
- end
2751
- class AfterpayClearpay < Stripe::RequestParams
2752
-
2753
- end
2754
- class Alipay < Stripe::RequestParams
2755
-
2756
- end
2757
- class Alma < Stripe::RequestParams
2758
-
2759
- end
2760
- class AmazonPay < Stripe::RequestParams
2761
-
2762
- end
2763
- class AuBecsDebit < Stripe::RequestParams
2764
- # The account number for the bank account.
2765
- sig { returns(String) }
2766
- attr_accessor :account_number
2767
- # Bank-State-Branch number of the bank account.
2768
- sig { returns(String) }
2769
- attr_accessor :bsb_number
2770
- sig { params(account_number: String, bsb_number: String).void }
2771
- def initialize(account_number: nil, bsb_number: nil); end
2772
- end
2773
- class BacsDebit < Stripe::RequestParams
2774
- # Account number of the bank account that the funds will be debited from.
2775
- sig { returns(T.nilable(String)) }
2776
- attr_accessor :account_number
2777
- # Sort code of the bank account. (e.g., `10-20-30`)
2778
- sig { returns(T.nilable(String)) }
2779
- attr_accessor :sort_code
2780
- sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
2781
- def initialize(account_number: nil, sort_code: nil); end
2782
- end
2783
- class Bancontact < Stripe::RequestParams
2784
-
2785
- end
2786
- class Billie < Stripe::RequestParams
2787
-
2788
- end
2789
- class BillingDetails < Stripe::RequestParams
2790
- class Address < Stripe::RequestParams
2791
- # City, district, suburb, town, or village.
2792
- sig { returns(T.nilable(String)) }
2793
- attr_accessor :city
2794
- # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2795
- sig { returns(T.nilable(String)) }
2796
- attr_accessor :country
2797
- # Address line 1 (e.g., street, PO Box, or company name).
2798
- sig { returns(T.nilable(String)) }
2799
- attr_accessor :line1
2800
- # Address line 2 (e.g., apartment, suite, unit, or building).
2801
- sig { returns(T.nilable(String)) }
2802
- attr_accessor :line2
2803
- # ZIP or postal code.
2804
- sig { returns(T.nilable(String)) }
2805
- attr_accessor :postal_code
2806
- # State, county, province, or region.
2807
- sig { returns(T.nilable(String)) }
2808
- attr_accessor :state
2809
- sig {
2810
- 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
2811
- }
2812
- def initialize(
2813
- city: nil,
2814
- country: nil,
2815
- line1: nil,
2816
- line2: nil,
2817
- postal_code: nil,
2818
- state: nil
2819
- ); end
2820
- end
2821
- # Billing address.
2822
- sig {
2823
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address))))
2824
- }
2825
- attr_accessor :address
2826
- # Email address.
2827
- sig { returns(T.nilable(T.nilable(String))) }
2828
- attr_accessor :email
2829
- # Full name.
2830
- sig { returns(T.nilable(T.nilable(String))) }
2831
- attr_accessor :name
2832
- # Billing phone number (including extension).
2833
- sig { returns(T.nilable(T.nilable(String))) }
2834
- attr_accessor :phone
2835
- sig {
2836
- params(address: T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails::Address))), email: T.nilable(T.nilable(String)), name: T.nilable(T.nilable(String)), phone: T.nilable(T.nilable(String))).void
2837
- }
2838
- def initialize(address: nil, email: nil, name: nil, phone: nil); end
2839
- end
2840
- class Blik < Stripe::RequestParams
2841
-
2842
- end
2843
- class Boleto < Stripe::RequestParams
2844
- # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
2845
- sig { returns(String) }
2846
- attr_accessor :tax_id
2847
- sig { params(tax_id: String).void }
2848
- def initialize(tax_id: nil); end
2849
- end
2850
- class Cashapp < Stripe::RequestParams
2851
-
2852
- end
2853
- class CustomerBalance < Stripe::RequestParams
2854
-
2855
- end
2856
- class Eps < Stripe::RequestParams
2857
- # The customer's bank.
2858
- sig { returns(T.nilable(String)) }
2859
- attr_accessor :bank
2860
- sig { params(bank: T.nilable(String)).void }
2861
- def initialize(bank: nil); end
2862
- end
2863
- class Fpx < Stripe::RequestParams
2864
- # Account holder type for FPX transaction
2865
- sig { returns(T.nilable(String)) }
2866
- attr_accessor :account_holder_type
2867
- # The customer's bank.
2868
- sig { returns(String) }
2869
- attr_accessor :bank
2870
- sig { params(account_holder_type: T.nilable(String), bank: String).void }
2871
- def initialize(account_holder_type: nil, bank: nil); end
2872
- end
2873
- class Giropay < Stripe::RequestParams
2874
-
2875
- end
2876
- class Grabpay < Stripe::RequestParams
2877
-
2878
- end
2879
- class Ideal < Stripe::RequestParams
2880
- # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
2881
- sig { returns(T.nilable(String)) }
2882
- attr_accessor :bank
2883
- sig { params(bank: T.nilable(String)).void }
2884
- def initialize(bank: nil); end
2885
- end
2886
- class InteracPresent < Stripe::RequestParams
2887
-
2888
- end
2889
- class KakaoPay < Stripe::RequestParams
2890
-
2891
- end
2892
- class Klarna < Stripe::RequestParams
2893
- class Dob < Stripe::RequestParams
2894
- # The day of birth, between 1 and 31.
2895
- sig { returns(Integer) }
2896
- attr_accessor :day
2897
- # The month of birth, between 1 and 12.
2898
- sig { returns(Integer) }
2899
- attr_accessor :month
2900
- # The four-digit year of birth.
2901
- sig { returns(Integer) }
2902
- attr_accessor :year
2903
- sig { params(day: Integer, month: Integer, year: Integer).void }
2904
- def initialize(day: nil, month: nil, year: nil); end
2905
- end
2906
- # Customer's date of birth
2907
- sig {
2908
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna::Dob))
2909
- }
2910
- attr_accessor :dob
2911
- sig {
2912
- params(dob: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna::Dob)).void
2913
- }
2914
- def initialize(dob: nil); end
2915
- end
2916
- class Konbini < Stripe::RequestParams
2917
-
2918
- end
2919
- class KrCard < Stripe::RequestParams
2920
-
2921
- end
2922
- class Link < Stripe::RequestParams
2923
-
2924
- end
2925
- class Mobilepay < Stripe::RequestParams
2926
-
2927
- end
2928
- class Multibanco < Stripe::RequestParams
2929
-
2930
- end
2931
- class NaverPay < Stripe::RequestParams
2932
- # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
2933
- sig { returns(T.nilable(String)) }
2934
- attr_accessor :funding
2935
- sig { params(funding: T.nilable(String)).void }
2936
- def initialize(funding: nil); end
2937
- end
2938
- class NzBankAccount < Stripe::RequestParams
2939
- # The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
2940
- sig { returns(T.nilable(String)) }
2941
- attr_accessor :account_holder_name
2942
- # The account number for the bank account.
2943
- sig { returns(String) }
2944
- attr_accessor :account_number
2945
- # The numeric code for the bank account's bank.
2946
- sig { returns(String) }
2947
- attr_accessor :bank_code
2948
- # The numeric code for the bank account's bank branch.
2949
- sig { returns(String) }
2950
- attr_accessor :branch_code
2951
- # Attribute for param field reference
2952
- sig { returns(T.nilable(String)) }
2953
- attr_accessor :reference
2954
- # The suffix of the bank account number.
2955
- sig { returns(String) }
2956
- attr_accessor :suffix
2957
- sig {
2958
- params(account_holder_name: T.nilable(String), account_number: String, bank_code: String, branch_code: String, reference: T.nilable(String), suffix: String).void
2959
- }
2960
- def initialize(
2961
- account_holder_name: nil,
2962
- account_number: nil,
2963
- bank_code: nil,
2964
- branch_code: nil,
2965
- reference: nil,
2966
- suffix: nil
2967
- ); end
2968
- end
2969
- class Oxxo < Stripe::RequestParams
2970
-
2971
- end
2972
- class P24 < Stripe::RequestParams
2973
- # The customer's bank.
2974
- sig { returns(T.nilable(String)) }
2975
- attr_accessor :bank
2976
- sig { params(bank: T.nilable(String)).void }
2977
- def initialize(bank: nil); end
2978
- end
2979
- class PayByBank < Stripe::RequestParams
2980
-
2981
- end
2982
- class Payco < Stripe::RequestParams
2983
-
2984
- end
2985
- class Paynow < Stripe::RequestParams
2986
-
2987
- end
2988
- class Paypal < Stripe::RequestParams
2989
-
2990
- end
2991
- class Pix < Stripe::RequestParams
2992
-
2993
- end
2994
- class Promptpay < Stripe::RequestParams
2995
-
2996
- end
2997
- class RadarOptions < Stripe::RequestParams
2998
- # 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.
2999
- sig { returns(T.nilable(String)) }
3000
- attr_accessor :session
3001
- sig { params(session: T.nilable(String)).void }
3002
- def initialize(session: nil); end
3003
- end
3004
- class RevolutPay < Stripe::RequestParams
3005
-
3006
- end
3007
- class SamsungPay < Stripe::RequestParams
3008
-
3009
- end
3010
- class Satispay < Stripe::RequestParams
3011
-
3012
- end
3013
- class SepaDebit < Stripe::RequestParams
3014
- # IBAN of the bank account.
3015
- sig { returns(String) }
3016
- attr_accessor :iban
3017
- sig { params(iban: String).void }
3018
- def initialize(iban: nil); end
3019
- end
3020
- class Sofort < Stripe::RequestParams
3021
- # Two-letter ISO code representing the country the bank account is located in.
3022
- sig { returns(String) }
3023
- attr_accessor :country
3024
- sig { params(country: String).void }
3025
- def initialize(country: nil); end
3026
- end
3027
- class Swish < Stripe::RequestParams
3028
-
3029
- end
3030
- class Twint < Stripe::RequestParams
3031
-
3032
- end
3033
- class UsBankAccount < Stripe::RequestParams
3034
- # Account holder type: individual or company.
3035
- sig { returns(T.nilable(String)) }
3036
- attr_accessor :account_holder_type
3037
- # Account number of the bank account.
3038
- sig { returns(T.nilable(String)) }
3039
- attr_accessor :account_number
3040
- # Account type: checkings or savings. Defaults to checking if omitted.
3041
- sig { returns(T.nilable(String)) }
3042
- attr_accessor :account_type
3043
- # The ID of a Financial Connections Account to use as a payment method.
3044
- sig { returns(T.nilable(String)) }
3045
- attr_accessor :financial_connections_account
3046
- # Routing number of the bank account.
3047
- sig { returns(T.nilable(String)) }
3048
- attr_accessor :routing_number
3049
- sig {
3050
- params(account_holder_type: T.nilable(String), account_number: T.nilable(String), account_type: T.nilable(String), financial_connections_account: T.nilable(String), routing_number: T.nilable(String)).void
3051
- }
3052
- def initialize(
3053
- account_holder_type: nil,
3054
- account_number: nil,
3055
- account_type: nil,
3056
- financial_connections_account: nil,
3057
- routing_number: nil
3058
- ); end
3059
- end
3060
- class WechatPay < Stripe::RequestParams
3061
-
3062
- end
3063
- class Zip < Stripe::RequestParams
3064
-
3065
- end
3066
- # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
3067
- sig {
3068
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AcssDebit))
3069
- }
3070
- attr_accessor :acss_debit
3071
- # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
3072
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Affirm)) }
3073
- attr_accessor :affirm
3074
- # If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
3075
- sig {
3076
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay))
3077
- }
3078
- attr_accessor :afterpay_clearpay
3079
- # If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
3080
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alipay)) }
3081
- attr_accessor :alipay
3082
- # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
3083
- sig { returns(T.nilable(String)) }
3084
- attr_accessor :allow_redisplay
3085
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
3086
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alma)) }
3087
- attr_accessor :alma
3088
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
3089
- sig {
3090
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AmazonPay))
3091
- }
3092
- attr_accessor :amazon_pay
3093
- # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
3094
- sig {
3095
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AuBecsDebit))
3096
- }
3097
- attr_accessor :au_becs_debit
3098
- # If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
3099
- sig {
3100
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BacsDebit))
3101
- }
3102
- attr_accessor :bacs_debit
3103
- # If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
3104
- sig {
3105
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Bancontact))
3106
- }
3107
- attr_accessor :bancontact
3108
- # If this is a `billie` PaymentMethod, this hash contains details about the billie payment method.
3109
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Billie)) }
3110
- attr_accessor :billie
3111
- # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
3112
- sig {
3113
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails))
3114
- }
3115
- attr_accessor :billing_details
3116
- # If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
3117
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Blik)) }
3118
- attr_accessor :blik
3119
- # If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
3120
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Boleto)) }
3121
- attr_accessor :boleto
3122
- # If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
3123
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Cashapp)) }
3124
- attr_accessor :cashapp
3125
- # If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
3126
- sig {
3127
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::CustomerBalance))
3128
- }
3129
- attr_accessor :customer_balance
3130
- # If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
3131
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Eps)) }
3132
- attr_accessor :eps
3133
- # If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
3134
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Fpx)) }
3135
- attr_accessor :fpx
3136
- # If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
3137
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Giropay)) }
3138
- attr_accessor :giropay
3139
- # If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
3140
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Grabpay)) }
3141
- attr_accessor :grabpay
3142
- # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
3143
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Ideal)) }
3144
- attr_accessor :ideal
3145
- # If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
3146
- sig {
3147
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::InteracPresent))
3148
- }
3149
- attr_accessor :interac_present
3150
- # If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
3151
- sig {
3152
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KakaoPay))
3153
- }
3154
- attr_accessor :kakao_pay
3155
- # If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
3156
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna)) }
3157
- attr_accessor :klarna
3158
- # If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
3159
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Konbini)) }
3160
- attr_accessor :konbini
3161
- # If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
3162
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KrCard)) }
3163
- attr_accessor :kr_card
3164
- # If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
3165
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Link)) }
3166
- attr_accessor :link
3167
- # 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`.
3168
- sig { returns(T.nilable(T::Hash[String, String])) }
3169
- attr_accessor :metadata
3170
- # If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
3171
- sig {
3172
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Mobilepay))
3173
- }
3174
- attr_accessor :mobilepay
3175
- # If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
3176
- sig {
3177
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Multibanco))
3178
- }
3179
- attr_accessor :multibanco
3180
- # If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
3181
- sig {
3182
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NaverPay))
3183
- }
3184
- attr_accessor :naver_pay
3185
- # If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
3186
- sig {
3187
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NzBankAccount))
3188
- }
3189
- attr_accessor :nz_bank_account
3190
- # If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
3191
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Oxxo)) }
3192
- attr_accessor :oxxo
3193
- # If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
3194
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::P24)) }
3195
- attr_accessor :p24
3196
- # If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
3197
- sig {
3198
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::PayByBank))
3199
- }
3200
- attr_accessor :pay_by_bank
3201
- # If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
3202
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payco)) }
3203
- attr_accessor :payco
3204
- # If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
3205
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paynow)) }
3206
- attr_accessor :paynow
3207
- # If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
3208
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypal)) }
3209
- attr_accessor :paypal
3210
- # If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
3211
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Pix)) }
3212
- attr_accessor :pix
3213
- # If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
3214
- sig {
3215
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Promptpay))
3216
- }
3217
- attr_accessor :promptpay
3218
- # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
3219
- sig {
3220
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RadarOptions))
3221
- }
3222
- attr_accessor :radar_options
3223
- # If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
3224
- sig {
3225
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RevolutPay))
3226
- }
3227
- attr_accessor :revolut_pay
3228
- # If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
3229
- sig {
3230
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SamsungPay))
3231
- }
3232
- attr_accessor :samsung_pay
3233
- # If this is a `satispay` PaymentMethod, this hash contains details about the satispay payment method.
3234
- sig {
3235
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Satispay))
3236
- }
3237
- attr_accessor :satispay
3238
- # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
3239
- sig {
3240
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SepaDebit))
3241
- }
3242
- attr_accessor :sepa_debit
3243
- # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
3244
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Sofort)) }
3245
- attr_accessor :sofort
3246
- # If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
3247
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Swish)) }
3248
- attr_accessor :swish
3249
- # If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
3250
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Twint)) }
3251
- attr_accessor :twint
3252
- # The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
3253
- sig { returns(String) }
3254
- attr_accessor :type
3255
- # If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
3256
- sig {
3257
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::UsBankAccount))
3258
- }
3259
- attr_accessor :us_bank_account
3260
- # If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
3261
- sig {
3262
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::WechatPay))
3263
- }
3264
- attr_accessor :wechat_pay
3265
- # If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
3266
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Zip)) }
3267
- attr_accessor :zip
3268
- sig {
3269
- params(acss_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AcssDebit), affirm: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Affirm), afterpay_clearpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AfterpayClearpay), alipay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alipay), allow_redisplay: T.nilable(String), alma: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Alma), amazon_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AmazonPay), au_becs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AuBecsDebit), bacs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BacsDebit), bancontact: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Bancontact), billie: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Billie), billing_details: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::BillingDetails), blik: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Blik), boleto: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Boleto), cashapp: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Cashapp), customer_balance: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::CustomerBalance), eps: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Eps), fpx: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Fpx), giropay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Giropay), grabpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Grabpay), ideal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Ideal), interac_present: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::InteracPresent), kakao_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KakaoPay), klarna: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Klarna), konbini: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Konbini), kr_card: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::KrCard), link: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Link), metadata: T.nilable(T::Hash[String, String]), mobilepay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Mobilepay), multibanco: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Multibanco), naver_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NaverPay), nz_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::NzBankAccount), oxxo: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Oxxo), p24: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::P24), pay_by_bank: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::PayByBank), payco: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Payco), paynow: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paynow), paypal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Paypal), pix: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Pix), promptpay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Promptpay), radar_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RadarOptions), revolut_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::RevolutPay), samsung_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SamsungPay), satispay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Satispay), sepa_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::SepaDebit), sofort: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Sofort), swish: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Swish), twint: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Twint), type: String, us_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::UsBankAccount), wechat_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::WechatPay), zip: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::Zip)).void
3270
- }
3271
- def initialize(
3272
- acss_debit: nil,
3273
- affirm: nil,
3274
- afterpay_clearpay: nil,
3275
- alipay: nil,
3276
- allow_redisplay: nil,
3277
- alma: nil,
3278
- amazon_pay: nil,
3279
- au_becs_debit: nil,
3280
- bacs_debit: nil,
3281
- bancontact: nil,
3282
- billie: nil,
3283
- billing_details: nil,
3284
- blik: nil,
3285
- boleto: nil,
3286
- cashapp: nil,
3287
- customer_balance: nil,
3288
- eps: nil,
3289
- fpx: nil,
3290
- giropay: nil,
3291
- grabpay: nil,
3292
- ideal: nil,
3293
- interac_present: nil,
3294
- kakao_pay: nil,
3295
- klarna: nil,
3296
- konbini: nil,
3297
- kr_card: nil,
3298
- link: nil,
3299
- metadata: nil,
3300
- mobilepay: nil,
3301
- multibanco: nil,
3302
- naver_pay: nil,
3303
- nz_bank_account: nil,
3304
- oxxo: nil,
3305
- p24: nil,
3306
- pay_by_bank: nil,
3307
- payco: nil,
3308
- paynow: nil,
3309
- paypal: nil,
3310
- pix: nil,
3311
- promptpay: nil,
3312
- radar_options: nil,
3313
- revolut_pay: nil,
3314
- samsung_pay: nil,
3315
- satispay: nil,
3316
- sepa_debit: nil,
3317
- sofort: nil,
3318
- swish: nil,
3319
- twint: nil,
3320
- type: nil,
3321
- us_bank_account: nil,
3322
- wechat_pay: nil,
3323
- zip: nil
3324
- ); end
3325
- end
3326
- class PaymentMethodOptions < Stripe::RequestParams
3327
- class AcssDebit < Stripe::RequestParams
3328
- class MandateOptions < Stripe::RequestParams
3329
- # A URL for custom mandate text to render during confirmation step.
3330
- # The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
3331
- # or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
3332
- sig { returns(T.nilable(T.nilable(String))) }
3333
- attr_accessor :custom_mandate_url
3334
- # List of Stripe products where this mandate can be selected automatically.
3335
- sig { returns(T.nilable(T::Array[String])) }
3336
- attr_accessor :default_for
3337
- # Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
3338
- sig { returns(T.nilable(String)) }
3339
- attr_accessor :interval_description
3340
- # Payment schedule for the mandate.
3341
- sig { returns(T.nilable(String)) }
3342
- attr_accessor :payment_schedule
3343
- # Transaction type of the mandate.
3344
- sig { returns(T.nilable(String)) }
3345
- attr_accessor :transaction_type
3346
- sig {
3347
- params(custom_mandate_url: T.nilable(T.nilable(String)), default_for: T.nilable(T::Array[String]), interval_description: T.nilable(String), payment_schedule: T.nilable(String), transaction_type: T.nilable(String)).void
3348
- }
3349
- def initialize(
3350
- custom_mandate_url: nil,
3351
- default_for: nil,
3352
- interval_description: nil,
3353
- payment_schedule: nil,
3354
- transaction_type: nil
3355
- ); end
3356
- end
3357
- # 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).
3358
- sig { returns(T.nilable(String)) }
3359
- attr_accessor :currency
3360
- # Additional fields for Mandate creation
3361
- sig {
3362
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions))
3363
- }
3364
- attr_accessor :mandate_options
3365
- # Bank account verification method.
3366
- sig { returns(T.nilable(String)) }
3367
- attr_accessor :verification_method
3368
- sig {
3369
- params(currency: T.nilable(String), mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions), verification_method: T.nilable(String)).void
3370
- }
3371
- def initialize(currency: nil, mandate_options: nil, verification_method: nil); end
3372
- end
3373
- class AmazonPay < Stripe::RequestParams
3374
-
3375
- end
3376
- class BacsDebit < Stripe::RequestParams
3377
- class MandateOptions < Stripe::RequestParams
3378
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
3379
- sig { returns(T.nilable(T.nilable(String))) }
3380
- attr_accessor :reference_prefix
3381
- sig { params(reference_prefix: T.nilable(T.nilable(String))).void }
3382
- def initialize(reference_prefix: nil); end
3383
- end
3384
- # Additional fields for Mandate creation
3385
- sig {
3386
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions))
3387
- }
3388
- attr_accessor :mandate_options
3389
- sig {
3390
- params(mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions)).void
3391
- }
3392
- def initialize(mandate_options: nil); end
3393
- end
3394
- class Card < Stripe::RequestParams
3395
- class MandateOptions < Stripe::RequestParams
3396
- # Amount to be charged for future payments.
3397
- sig { returns(Integer) }
3398
- attr_accessor :amount
3399
- # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
3400
- sig { returns(String) }
3401
- attr_accessor :amount_type
3402
- # Currency in which future payments will be charged. 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).
3403
- sig { returns(String) }
3404
- attr_accessor :currency
3405
- # A description of the mandate or subscription that is meant to be displayed to the customer.
3406
- sig { returns(T.nilable(String)) }
3407
- attr_accessor :description
3408
- # End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
3409
- sig { returns(T.nilable(Integer)) }
3410
- attr_accessor :end_date
3411
- # Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.
3412
- sig { returns(String) }
3413
- attr_accessor :interval
3414
- # The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.
3415
- sig { returns(T.nilable(Integer)) }
3416
- attr_accessor :interval_count
3417
- # Unique identifier for the mandate or subscription.
3418
- sig { returns(String) }
3419
- attr_accessor :reference
3420
- # Start date of the mandate or subscription. Start date should not be lesser than yesterday.
3421
- sig { returns(Integer) }
3422
- attr_accessor :start_date
3423
- # Specifies the type of mandates supported. Possible values are `india`.
3424
- sig { returns(T.nilable(T::Array[String])) }
3425
- attr_accessor :supported_types
3426
- sig {
3427
- params(amount: Integer, amount_type: String, currency: String, description: T.nilable(String), end_date: T.nilable(Integer), interval: String, interval_count: T.nilable(Integer), reference: String, start_date: Integer, supported_types: T.nilable(T::Array[String])).void
3428
- }
3429
- def initialize(
3430
- amount: nil,
3431
- amount_type: nil,
3432
- currency: nil,
3433
- description: nil,
3434
- end_date: nil,
3435
- interval: nil,
3436
- interval_count: nil,
3437
- reference: nil,
3438
- start_date: nil,
3439
- supported_types: nil
3440
- ); end
3441
- end
3442
- class ThreeDSecure < Stripe::RequestParams
3443
- class NetworkOptions < Stripe::RequestParams
3444
- class CartesBancaires < Stripe::RequestParams
3445
- # The cryptogram calculation algorithm used by the card Issuer's ACS
3446
- # to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.
3447
- # messageExtension: CB-AVALGO
3448
- sig { returns(String) }
3449
- attr_accessor :cb_avalgo
3450
- # The exemption indicator returned from Cartes Bancaires in the ARes.
3451
- # message extension: CB-EXEMPTION; string (4 characters)
3452
- # This is a 3 byte bitmap (low significant byte first and most significant
3453
- # bit first) that has been Base64 encoded
3454
- sig { returns(T.nilable(String)) }
3455
- attr_accessor :cb_exemption
3456
- # The risk score returned from Cartes Bancaires in the ARes.
3457
- # message extension: CB-SCORE; numeric value 0-99
3458
- sig { returns(T.nilable(Integer)) }
3459
- attr_accessor :cb_score
3460
- sig {
3461
- params(cb_avalgo: String, cb_exemption: T.nilable(String), cb_score: T.nilable(Integer)).void
3462
- }
3463
- def initialize(cb_avalgo: nil, cb_exemption: nil, cb_score: nil); end
3464
- end
3465
- # Cartes Bancaires-specific 3DS fields.
3466
- sig {
3467
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires))
3468
- }
3469
- attr_accessor :cartes_bancaires
3470
- sig {
3471
- params(cartes_bancaires: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions::CartesBancaires)).void
3472
- }
3473
- def initialize(cartes_bancaires: nil); end
3474
- end
3475
- # The `transStatus` returned from the card Issuer’s ACS in the ARes.
3476
- sig { returns(T.nilable(String)) }
3477
- attr_accessor :ares_trans_status
3478
- # The cryptogram, also known as the "authentication value" (AAV, CAVV or
3479
- # AEVV). This value is 20 bytes, base64-encoded into a 28-character string.
3480
- # (Most 3D Secure providers will return the base64-encoded version, which
3481
- # is what you should specify here.)
3482
- sig { returns(T.nilable(String)) }
3483
- attr_accessor :cryptogram
3484
- # The Electronic Commerce Indicator (ECI) is returned by your 3D Secure
3485
- # provider and indicates what degree of authentication was performed.
3486
- sig { returns(T.nilable(String)) }
3487
- attr_accessor :electronic_commerce_indicator
3488
- # Network specific 3DS fields. Network specific arguments require an
3489
- # explicit card brand choice. The parameter `payment_method_options.card.network``
3490
- # must be populated accordingly
3491
- sig {
3492
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions))
3493
- }
3494
- attr_accessor :network_options
3495
- # The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the
3496
- # AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.
3497
- sig { returns(T.nilable(String)) }
3498
- attr_accessor :requestor_challenge_indicator
3499
- # For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server
3500
- # Transaction ID (dsTransID).
3501
- sig { returns(T.nilable(String)) }
3502
- attr_accessor :transaction_id
3503
- # The version of 3D Secure that was performed.
3504
- sig { returns(T.nilable(String)) }
3505
- attr_accessor :version
3506
- sig {
3507
- params(ares_trans_status: T.nilable(String), cryptogram: T.nilable(String), electronic_commerce_indicator: T.nilable(String), network_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure::NetworkOptions), requestor_challenge_indicator: T.nilable(String), transaction_id: T.nilable(String), version: T.nilable(String)).void
3508
- }
3509
- def initialize(
3510
- ares_trans_status: nil,
3511
- cryptogram: nil,
3512
- electronic_commerce_indicator: nil,
3513
- network_options: nil,
3514
- requestor_challenge_indicator: nil,
3515
- transaction_id: nil,
3516
- version: nil
3517
- ); end
3518
- end
3519
- # Configuration options for setting up an eMandate for cards issued in India.
3520
- sig {
3521
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions))
3522
- }
3523
- attr_accessor :mandate_options
3524
- # When specified, this parameter signals that a card has been collected
3525
- # as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This
3526
- # parameter can only be provided during confirmation.
3527
- sig { returns(T.nilable(T::Boolean)) }
3528
- attr_accessor :moto
3529
- # Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.
3530
- sig { returns(T.nilable(String)) }
3531
- attr_accessor :network
3532
- # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
3533
- sig { returns(T.nilable(String)) }
3534
- attr_accessor :request_three_d_secure
3535
- # If 3D Secure authentication was performed with a third-party provider,
3536
- # the authentication details to use for this setup.
3537
- sig {
3538
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure))
3539
- }
3540
- attr_accessor :three_d_secure
3541
- sig {
3542
- params(mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::MandateOptions), moto: T.nilable(T::Boolean), network: T.nilable(String), request_three_d_secure: T.nilable(String), three_d_secure: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card::ThreeDSecure)).void
3543
- }
3544
- def initialize(
3545
- mandate_options: nil,
3546
- moto: nil,
3547
- network: nil,
3548
- request_three_d_secure: nil,
3549
- three_d_secure: nil
3550
- ); end
3551
- end
3552
- class CardPresent < Stripe::RequestParams
3553
-
3554
- end
3555
- class Link < Stripe::RequestParams
3556
- # [Deprecated] This is a legacy parameter that no longer has any function.
3557
- sig { returns(T.nilable(String)) }
3558
- attr_accessor :persistent_token
3559
- sig { params(persistent_token: T.nilable(String)).void }
3560
- def initialize(persistent_token: nil); end
3561
- end
3562
- class Paypal < Stripe::RequestParams
3563
- # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
3564
- sig { returns(T.nilable(String)) }
3565
- attr_accessor :billing_agreement_id
3566
- sig { params(billing_agreement_id: T.nilable(String)).void }
3567
- def initialize(billing_agreement_id: nil); end
3568
- end
3569
- class SepaDebit < Stripe::RequestParams
3570
- class MandateOptions < Stripe::RequestParams
3571
- # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
3572
- sig { returns(T.nilable(T.nilable(String))) }
3573
- attr_accessor :reference_prefix
3574
- sig { params(reference_prefix: T.nilable(T.nilable(String))).void }
3575
- def initialize(reference_prefix: nil); end
3576
- end
3577
- # Additional fields for Mandate creation
3578
- sig {
3579
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions))
3580
- }
3581
- attr_accessor :mandate_options
3582
- sig {
3583
- params(mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions)).void
3584
- }
3585
- def initialize(mandate_options: nil); end
3586
- end
3587
- class UsBankAccount < Stripe::RequestParams
3588
- class FinancialConnections < Stripe::RequestParams
3589
- class Filters < Stripe::RequestParams
3590
- # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
3591
- sig { returns(T.nilable(T::Array[String])) }
3592
- attr_accessor :account_subcategories
3593
- sig { params(account_subcategories: T.nilable(T::Array[String])).void }
3594
- def initialize(account_subcategories: nil); end
3595
- end
3596
- # Provide filters for the linked accounts that the customer can select for the payment method.
3597
- sig {
3598
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters))
3599
- }
3600
- attr_accessor :filters
3601
- # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
3602
- sig { returns(T.nilable(T::Array[String])) }
3603
- attr_accessor :permissions
3604
- # List of data features that you would like to retrieve upon account creation.
3605
- sig { returns(T.nilable(T::Array[String])) }
3606
- attr_accessor :prefetch
3607
- # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
3608
- sig { returns(T.nilable(String)) }
3609
- attr_accessor :return_url
3610
- sig {
3611
- params(filters: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters), permissions: T.nilable(T::Array[String]), prefetch: T.nilable(T::Array[String]), return_url: T.nilable(String)).void
3612
- }
3613
- def initialize(filters: nil, permissions: nil, prefetch: nil, return_url: nil); end
3614
- end
3615
- class MandateOptions < Stripe::RequestParams
3616
- # The method used to collect offline mandate customer acceptance.
3617
- sig { returns(T.nilable(T.nilable(String))) }
3618
- attr_accessor :collection_method
3619
- sig { params(collection_method: T.nilable(T.nilable(String))).void }
3620
- def initialize(collection_method: nil); end
3621
- end
3622
- class Networks < Stripe::RequestParams
3623
- # Triggers validations to run across the selected networks
3624
- sig { returns(T.nilable(T::Array[String])) }
3625
- attr_accessor :requested
3626
- sig { params(requested: T.nilable(T::Array[String])).void }
3627
- def initialize(requested: nil); end
3628
- end
3629
- # Additional fields for Financial Connections Session creation
3630
- sig {
3631
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections))
3632
- }
3633
- attr_accessor :financial_connections
3634
- # Additional fields for Mandate creation
3635
- sig {
3636
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions))
3637
- }
3638
- attr_accessor :mandate_options
3639
- # Additional fields for network related functions
3640
- sig {
3641
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks))
3642
- }
3643
- attr_accessor :networks
3644
- # Bank account verification method.
3645
- sig { returns(T.nilable(String)) }
3646
- attr_accessor :verification_method
3647
- sig {
3648
- params(financial_connections: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections), mandate_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions), networks: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks), verification_method: T.nilable(String)).void
3649
- }
3650
- def initialize(
3651
- financial_connections: nil,
3652
- mandate_options: nil,
3653
- networks: nil,
3654
- verification_method: nil
3655
- ); end
3656
- end
3657
- # If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.
3658
- sig {
3659
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit))
3660
- }
3661
- attr_accessor :acss_debit
3662
- # If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.
3663
- sig {
3664
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AmazonPay))
3665
- }
3666
- attr_accessor :amazon_pay
3667
- # If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.
3668
- sig {
3669
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit))
3670
- }
3671
- attr_accessor :bacs_debit
3672
- # Configuration for any card setup attempted on this SetupIntent.
3673
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card)) }
3674
- attr_accessor :card
3675
- # If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.
3676
- sig {
3677
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::CardPresent))
3678
- }
3679
- attr_accessor :card_present
3680
- # If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
3681
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Link)) }
3682
- attr_accessor :link
3683
- # If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
3684
- sig {
3685
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Paypal))
3686
- }
3687
- attr_accessor :paypal
3688
- # If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
3689
- sig {
3690
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit))
3691
- }
3692
- attr_accessor :sepa_debit
3693
- # If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
3694
- sig {
3695
- returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount))
3696
- }
3697
- attr_accessor :us_bank_account
3698
- sig {
3699
- params(acss_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AcssDebit), amazon_pay: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::AmazonPay), bacs_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::BacsDebit), card: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Card), card_present: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::CardPresent), link: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Link), paypal: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::Paypal), sepa_debit: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount)).void
3700
- }
3701
- def initialize(
3702
- acss_debit: nil,
3703
- amazon_pay: nil,
3704
- bacs_debit: nil,
3705
- card: nil,
3706
- card_present: nil,
3707
- link: nil,
3708
- paypal: nil,
3709
- sepa_debit: nil,
3710
- us_bank_account: nil
3711
- ); end
3712
- end
3713
- # ID of the ConfirmationToken used to confirm this SetupIntent.
3714
- #
3715
- # If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.
3716
- sig { returns(T.nilable(String)) }
3717
- attr_accessor :confirmation_token
3718
- # Specifies which fields in the response should be expanded.
3719
- sig { returns(T.nilable(T::Array[String])) }
3720
- attr_accessor :expand
3721
- # Attribute for param field mandate_data
3722
- sig {
3723
- returns(T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::MandateData))))
3724
- }
3725
- attr_accessor :mandate_data
3726
- # ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
3727
- sig { returns(T.nilable(String)) }
3728
- attr_accessor :payment_method
3729
- # When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)
3730
- # value in the SetupIntent.
3731
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData)) }
3732
- attr_accessor :payment_method_data
3733
- # Payment method-specific configuration for this SetupIntent.
3734
- sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions)) }
3735
- attr_accessor :payment_method_options
3736
- # The URL to redirect your customer back to after they authenticate on the payment method's app or site.
3737
- # If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
3738
- # This parameter is only used for cards and other redirect-based payment methods.
3739
- sig { returns(T.nilable(String)) }
3740
- attr_accessor :return_url
3741
- # Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
3742
- sig { returns(T.nilable(T::Boolean)) }
3743
- attr_accessor :use_stripe_sdk
3744
- sig {
3745
- params(confirmation_token: T.nilable(String), expand: T.nilable(T::Array[String]), mandate_data: T.nilable(T.nilable(T.any(String, ::Stripe::SetupIntent::ConfirmParams::MandateData))), payment_method: T.nilable(String), payment_method_data: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodOptions), return_url: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
3746
- }
3747
- def initialize(
3748
- confirmation_token: nil,
3749
- expand: nil,
3750
- mandate_data: nil,
3751
- payment_method: nil,
3752
- payment_method_data: nil,
3753
- payment_method_options: nil,
3754
- return_url: nil,
3755
- use_stripe_sdk: nil
3756
- ); end
3757
- end
3758
- class VerifyMicrodepositsParams < Stripe::RequestParams
3759
- # Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
3760
- sig { returns(T.nilable(T::Array[Integer])) }
3761
- attr_accessor :amounts
3762
- # A six-character code starting with SM present in the microdeposit sent to the bank account.
3763
- sig { returns(T.nilable(String)) }
3764
- attr_accessor :descriptor_code
3765
- # Specifies which fields in the response should be expanded.
3766
- sig { returns(T.nilable(T::Array[String])) }
3767
- attr_accessor :expand
3768
- sig {
3769
- params(amounts: T.nilable(T::Array[Integer]), descriptor_code: T.nilable(String), expand: T.nilable(T::Array[String])).void
3770
- }
3771
- def initialize(amounts: nil, descriptor_code: nil, expand: nil); end
3772
- end
3773
- # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
3774
- #
3775
- # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
3776
- sig {
3777
- params(params: T.any(::Stripe::SetupIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
3778
- }
3779
- def cancel(params = {}, opts = {}); end
3780
-
3781
- # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
3782
- #
3783
- # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
3784
- sig {
3785
- params(intent: String, params: T.any(::Stripe::SetupIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
3786
- }
3787
- def self.cancel(intent, params = {}, opts = {}); end
3788
-
3789
- # Confirm that your customer intends to set up the current or
3790
- # provided payment method. For example, you would confirm a SetupIntent
3791
- # when a customer hits the “Save” button on a payment method management
3792
- # page on your website.
3793
- #
3794
- # If the selected payment method does not require any additional
3795
- # steps from the customer, the SetupIntent will transition to the
3796
- # succeeded status.
3797
- #
3798
- # Otherwise, it will transition to the requires_action status and
3799
- # suggest additional actions via next_action. If setup fails,
3800
- # the SetupIntent will transition to the
3801
- # requires_payment_method status or the canceled status if the
3802
- # confirmation limit is reached.
3803
- sig {
3804
- params(params: T.any(::Stripe::SetupIntent::ConfirmParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
3805
- }
3806
- def confirm(params = {}, opts = {}); end
3807
-
3808
- # Confirm that your customer intends to set up the current or
3809
- # provided payment method. For example, you would confirm a SetupIntent
3810
- # when a customer hits the “Save” button on a payment method management
3811
- # page on your website.
3812
- #
3813
- # If the selected payment method does not require any additional
3814
- # steps from the customer, the SetupIntent will transition to the
3815
- # succeeded status.
3816
- #
3817
- # Otherwise, it will transition to the requires_action status and
3818
- # suggest additional actions via next_action. If setup fails,
3819
- # the SetupIntent will transition to the
3820
- # requires_payment_method status or the canceled status if the
3821
- # confirmation limit is reached.
3822
- sig {
3823
- params(intent: String, params: T.any(::Stripe::SetupIntent::ConfirmParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
3824
- }
3825
- def self.confirm(intent, params = {}, opts = {}); end
3826
-
3827
- # Creates a SetupIntent object.
3828
- #
3829
- # After you create the SetupIntent, attach a payment method and [confirm](https://stripe.com/docs/api/setup_intents/confirm)
3830
- # it to collect any required permissions to charge the payment method later.
3831
- sig {
3832
- params(params: T.any(::Stripe::SetupIntent::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
3833
- }
3834
- def self.create(params = {}, opts = {}); end
3835
-
3836
- # Returns a list of SetupIntents.
3837
- sig {
3838
- params(params: T.any(::Stripe::SetupIntent::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
3839
- }
3840
- def self.list(params = {}, opts = {}); end
3841
-
3842
- # Updates a SetupIntent object.
3843
- sig {
3844
- params(intent: String, params: T.any(::Stripe::SetupIntent::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
3845
- }
3846
- def self.update(intent, params = {}, opts = {}); end
3847
-
3848
- # Verifies microdeposits on a SetupIntent object.
3849
- sig {
3850
- params(params: T.any(::Stripe::SetupIntent::VerifyMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
3851
- }
3852
- def verify_microdeposits(params = {}, opts = {}); end
3853
-
3854
- # Verifies microdeposits on a SetupIntent object.
3855
- sig {
3856
- params(intent: String, params: T.any(::Stripe::SetupIntent::VerifyMicrodepositsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent)
3857
- }
3858
- def self.verify_microdeposits(intent, params = {}, opts = {}); end
3859
- end
3860
- end