stripe 15.6.0.pre.beta.1 → 16.0.0

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