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