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