stripe 18.1.0.pre.beta.1 → 18.1.0

data/lib/stripe/params/setup_intent_create_params.rb

@@ -6,7 +6,7 @@ module Stripe
     class AutomaticPaymentMethods < ::Stripe::RequestParams
       # Controls whether this SetupIntent will accept redirect-based payment methods.
       #
-      # 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.
+      # 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://docs.stripe.com/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.
       attr_accessor :allow_redirects
       # Whether this feature is enabled.
       attr_accessor :enabled
@@ -117,7 +117,7 @@ module Stripe
           attr_accessor :line2
           # ZIP or postal code.
           attr_accessor :postal_code
-          # State, county, province, or region.
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_accessor :state
 
           def initialize(
@@ -193,18 +193,8 @@ module Stripe
       end
 
       class Giropay < ::Stripe::RequestParams; end
-      class Gopay < ::Stripe::RequestParams; end
       class Grabpay < ::Stripe::RequestParams; end
 
-      class IdBankTransfer < ::Stripe::RequestParams
-        # Bank where the account is held.
-        attr_accessor :bank
-
-        def initialize(bank: nil)
-          @bank = bank
-        end
-      end
-
       class Ideal < ::Stripe::RequestParams
         # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
         attr_accessor :bank
@@ -302,7 +292,6 @@ module Stripe
       class Payco < ::Stripe::RequestParams; end
       class Paynow < ::Stripe::RequestParams; end
       class Paypal < ::Stripe::RequestParams; end
-      class Paypay < ::Stripe::RequestParams; end
 
       class Payto < ::Stripe::RequestParams
         # The account number for the bank account.
@@ -321,10 +310,9 @@ module Stripe
 
       class Pix < ::Stripe::RequestParams; end
       class Promptpay < ::Stripe::RequestParams; end
-      class Qris < ::Stripe::RequestParams; end
 
       class RadarOptions < ::Stripe::RequestParams
-        # 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.
+        # A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
         attr_accessor :session
 
         def initialize(session: nil)
@@ -332,29 +320,6 @@ module Stripe
         end
       end
 
-      class Rechnung < ::Stripe::RequestParams
-        class Dob < ::Stripe::RequestParams
-          # The day of birth, between 1 and 31.
-          attr_accessor :day
-          # The month of birth, between 1 and 12.
-          attr_accessor :month
-          # The four-digit year of birth.
-          attr_accessor :year
-
-          def initialize(day: nil, month: nil, year: nil)
-            @day = day
-            @month = month
-            @year = year
-          end
-        end
-        # Customer's date of birth
-        attr_accessor :dob
-
-        def initialize(dob: nil)
-          @dob = dob
-        end
-      end
-
       class RevolutPay < ::Stripe::RequestParams; end
       class SamsungPay < ::Stripe::RequestParams; end
       class Satispay < ::Stripe::RequestParams; end
@@ -368,8 +333,6 @@ module Stripe
         end
       end
 
-      class Shopeepay < ::Stripe::RequestParams; end
-
       class Sofort < ::Stripe::RequestParams
         # Two-letter ISO code representing the country the bank account is located in.
         attr_accessor :country
@@ -379,18 +342,6 @@ module Stripe
         end
       end
 
-      class StripeBalance < ::Stripe::RequestParams
-        # The connected account ID whose Stripe balance to use as the source of payment
-        attr_accessor :account
-        # The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
-        attr_accessor :source_type
-
-        def initialize(account: nil, source_type: nil)
-          @account = account
-          @source_type = source_type
-        end
-      end
-
       class Swish < ::Stripe::RequestParams; end
       class Twint < ::Stripe::RequestParams; end
 
@@ -463,12 +414,8 @@ module Stripe
       attr_accessor :fpx
       # If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
       attr_accessor :giropay
-      # If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
-      attr_accessor :gopay
       # If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
       attr_accessor :grabpay
-      # If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
-      attr_accessor :id_bank_transfer
       # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
       attr_accessor :ideal
       # If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
@@ -485,7 +432,7 @@ module Stripe
       attr_accessor :link
       # If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
       attr_accessor :mb_way
-      # 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`.
+      # Set of [key-value pairs](https://docs.stripe.com/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`.
       attr_accessor :metadata
       # If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
       attr_accessor :mobilepay
@@ -507,20 +454,14 @@ module Stripe
       attr_accessor :paynow
       # If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
       attr_accessor :paypal
-      # If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
-      attr_accessor :paypay
       # If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
       attr_accessor :payto
       # If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
       attr_accessor :pix
       # If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
       attr_accessor :promptpay
-      # If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
-      attr_accessor :qris
-      # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
+      # Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
       attr_accessor :radar_options
-      # If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
-      attr_accessor :rechnung
       # If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
       attr_accessor :revolut_pay
       # If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
@@ -529,12 +470,8 @@ module Stripe
       attr_accessor :satispay
       # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
       attr_accessor :sepa_debit
-      # If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
-      attr_accessor :shopeepay
       # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
       attr_accessor :sofort
-      # This hash contains details about the Stripe balance payment method.
-      attr_accessor :stripe_balance
       # If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
       attr_accessor :swish
       # If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
@@ -569,9 +506,7 @@ module Stripe
         eps: nil,
         fpx: nil,
         giropay: nil,
-        gopay: nil,
         grabpay: nil,
-        id_bank_transfer: nil,
         ideal: nil,
         interac_present: nil,
         kakao_pay: nil,
@@ -591,20 +526,15 @@ module Stripe
         payco: nil,
         paynow: nil,
         paypal: nil,
-        paypay: nil,
         payto: nil,
         pix: nil,
         promptpay: nil,
-        qris: nil,
         radar_options: nil,
-        rechnung: nil,
         revolut_pay: nil,
         samsung_pay: nil,
         satispay: nil,
         sepa_debit: nil,
-        shopeepay: nil,
         sofort: nil,
-        stripe_balance: nil,
         swish: nil,
         twint: nil,
         type: nil,
@@ -632,9 +562,7 @@ module Stripe
         @eps = eps
         @fpx = fpx
         @giropay = giropay
-        @gopay = gopay
         @grabpay = grabpay
-        @id_bank_transfer = id_bank_transfer
         @ideal = ideal
         @interac_present = interac_present
         @kakao_pay = kakao_pay
@@ -654,20 +582,15 @@ module Stripe
         @payco = payco
         @paynow = paynow
         @paypal = paypal
-        @paypay = paypay
         @payto = payto
         @pix = pix
         @promptpay = promptpay
-        @qris = qris
         @radar_options = radar_options
-        @rechnung = rechnung
         @revolut_pay = revolut_pay
         @samsung_pay = samsung_pay
         @satispay = satispay
         @sepa_debit = sepa_debit
-        @shopeepay = shopeepay
         @sofort = sofort
-        @stripe_balance = stripe_balance
         @swish = swish
         @twint = twint
         @type = type
@@ -866,7 +789,7 @@ module Stripe
         attr_accessor :moto
         # 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.
         attr_accessor :network
-        # 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.
+        # 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
         attr_accessor :request_three_d_secure
         # If 3D Secure authentication was performed with a third-party provider,
         # the authentication details to use for this setup.
@@ -983,15 +906,9 @@ module Stripe
       class Paypal < ::Stripe::RequestParams
         # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
         attr_accessor :billing_agreement_id
-        # Attribute for param field currency
-        attr_accessor :currency
-        # 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.
-        attr_accessor :subsellers
 
-        def initialize(billing_agreement_id: nil, currency: nil, subsellers: nil)
+        def initialize(billing_agreement_id: nil)
           @billing_agreement_id = billing_agreement_id
-          @currency = currency
-          @subsellers = subsellers
         end
       end
 
@@ -1038,53 +955,6 @@ module Stripe
         end
       end
 
-      class Pix < ::Stripe::RequestParams
-        class MandateOptions < ::Stripe::RequestParams
-          # Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
-          attr_accessor :amount
-          # Determines if the amount includes the IOF tax. Defaults to `never`.
-          attr_accessor :amount_includes_iof
-          # Type of amount. Defaults to `maximum`.
-          attr_accessor :amount_type
-          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
-          attr_accessor :currency
-          # 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.
-          attr_accessor :end_date
-          # Schedule at which the future payments will be charged. Defaults to `weekly`.
-          attr_accessor :payment_schedule
-          # Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
-          attr_accessor :reference
-          # 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.
-          attr_accessor :start_date
-
-          def initialize(
-            amount: nil,
-            amount_includes_iof: nil,
-            amount_type: nil,
-            currency: nil,
-            end_date: nil,
-            payment_schedule: nil,
-            reference: nil,
-            start_date: nil
-          )
-            @amount = amount
-            @amount_includes_iof = amount_includes_iof
-            @amount_type = amount_type
-            @currency = currency
-            @end_date = end_date
-            @payment_schedule = payment_schedule
-            @reference = reference
-            @start_date = start_date
-          end
-        end
-        # Additional fields for mandate creation.
-        attr_accessor :mandate_options
-
-        def initialize(mandate_options: nil)
-          @mandate_options = mandate_options
-        end
-      end
-
       class SepaDebit < ::Stripe::RequestParams
         class MandateOptions < ::Stripe::RequestParams
           # 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'.
@@ -1107,27 +977,13 @@ module Stripe
           class Filters < ::Stripe::RequestParams
             # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
             attr_accessor :account_subcategories
-            # ID of the institution to use to filter for selectable accounts.
-            attr_accessor :institution
 
-            def initialize(account_subcategories: nil, institution: nil)
+            def initialize(account_subcategories: nil)
               @account_subcategories = account_subcategories
-              @institution = institution
-            end
-          end
-
-          class ManualEntry < ::Stripe::RequestParams
-            # Settings for configuring manual entry of account details.
-            attr_accessor :mode
-
-            def initialize(mode: nil)
-              @mode = mode
             end
           end
           # Provide filters for the linked accounts that the customer can select for the payment method.
           attr_accessor :filters
-          # Customize manual entry behavior
-          attr_accessor :manual_entry
           # 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`.
           attr_accessor :permissions
           # List of data features that you would like to retrieve upon account creation.
@@ -1135,15 +991,8 @@ module Stripe
           # 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.
           attr_accessor :return_url
 
-          def initialize(
-            filters: nil,
-            manual_entry: nil,
-            permissions: nil,
-            prefetch: nil,
-            return_url: nil
-          )
+          def initialize(filters: nil, permissions: nil, prefetch: nil, return_url: nil)
             @filters = filters
-            @manual_entry = manual_entry
             @permissions = permissions
             @prefetch = prefetch
             @return_url = return_url
@@ -1206,8 +1055,6 @@ module Stripe
       attr_accessor :paypal
       # If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
       attr_accessor :payto
-      # If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
-      attr_accessor :pix
       # If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
       attr_accessor :sepa_debit
       # If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.
@@ -1223,7 +1070,6 @@ module Stripe
         link: nil,
         paypal: nil,
         payto: nil,
-        pix: nil,
         sepa_debit: nil,
         us_bank_account: nil
       )
@@ -1236,14 +1082,13 @@ module Stripe
         @link = link
         @paypal = paypal
         @payto = payto
-        @pix = pix
         @sepa_debit = sepa_debit
         @us_bank_account = us_bank_account
       end
     end
 
     class SingleUse < ::Stripe::RequestParams
-      # 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).
+      # Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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).
       attr_accessor :amount
       # 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).
       attr_accessor :currency
@@ -1283,24 +1128,24 @@ module Stripe
     #
     # 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.
     attr_accessor :flow_directions
-    # 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).
+    # This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm).
     attr_accessor :mandate_data
-    # 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`.
+    # Set of [key-value pairs](https://docs.stripe.com/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`.
     attr_accessor :metadata
     # The Stripe account ID created for this SetupIntent.
     attr_accessor :on_behalf_of
     # ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
     attr_accessor :payment_method
-    # The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.
+    # The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent.
     attr_accessor :payment_method_configuration
-    # 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)
+    # When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method)
     # value in the SetupIntent.
     attr_accessor :payment_method_data
     # Payment method-specific configuration for this SetupIntent.
     attr_accessor :payment_method_options
     # 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).
     attr_accessor :payment_method_types
-    # 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).
+    # 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://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm).
     attr_accessor :return_url
     # If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.
     #