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