stripe 13.4.0.pre.beta.4 → 13.4.0

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