stripe 20.1.0-alpha.4 → 20.1.0

package/types/SetupIntents.d.ts

@@ -5,7 +5,7 @@ declare module 'stripe' {
     /**
      * A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
      * For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
-     * Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
+     * Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow.
      *
      * Create a SetupIntent when you're ready to collect your customer's payment credentials.
      * Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
@@ -16,9 +16,9 @@ declare module 'stripe' {
      * For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
      * [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
      * to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
-     * If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
+     * If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer),
      * it automatically attaches the resulting payment method to that Customer after successful setup.
-     * We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
+     * We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on
      * PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
      *
      * By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
@@ -124,7 +124,7 @@ declare module 'stripe' {
       mandate: string | Stripe.Mandate | null;
 
       /**
-       * 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.
+       * 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.
        */
       metadata: Stripe.Metadata | null;
 
@@ -144,7 +144,7 @@ declare module 'stripe' {
       payment_method: string | Stripe.PaymentMethod | null;
 
       /**
-       * Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.
+       * Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this Setup Intent.
        */
       payment_method_configuration_details: SetupIntent.PaymentMethodConfigurationDetails | null;
 
@@ -158,15 +158,13 @@ declare module 'stripe' {
        */
       payment_method_types: Array<string>;
 
-      setup_details?: SetupIntent.SetupDetails;
-
       /**
        * ID of the single_use Mandate generated by the SetupIntent.
        */
       single_use_mandate: string | Stripe.Mandate | null;
 
       /**
-       * [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`.
+       * [Status](https://docs.stripe.com/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
        */
       status: SetupIntent.Status;
 
@@ -183,7 +181,7 @@ declare module 'stripe' {
         /**
          * 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.
          */
         allow_redirects?: AutomaticPaymentMethods.AllowRedirects;
 
@@ -222,9 +220,7 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
-        | 'gopay'
         | 'grabpay'
-        | 'id_bank_transfer'
         | 'ideal'
         | 'kakao_pay'
         | 'klarna'
@@ -241,19 +237,14 @@ declare module 'stripe' {
         | 'payco'
         | 'paynow'
         | 'paypal'
-        | 'paypay'
         | 'payto'
         | 'pix'
         | 'promptpay'
-        | 'qris'
-        | 'rechnung'
         | 'revolut_pay'
         | 'samsung_pay'
         | 'satispay'
         | 'sepa_debit'
-        | 'shopeepay'
         | 'sofort'
-        | 'stripe_balance'
         | 'swish'
         | 'twint'
         | 'us_bank_account'
@@ -264,7 +255,7 @@ declare module 'stripe' {
 
       interface LastSetupError {
         /**
-         * For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
+         * For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one.
          */
         advice_code?: string;
 
@@ -274,17 +265,17 @@ declare module 'stripe' {
         charge?: string;
 
         /**
-         * For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
+         * For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported.
          */
         code?: LastSetupError.Code;
 
         /**
-         * For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
+         * For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one.
          */
         decline_code?: string;
 
         /**
-         * A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
+         * A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
          */
         doc_url?: string;
 
@@ -315,20 +306,20 @@ declare module 'stripe' {
          * see the history of payment attempts for a particular session.
          *
          * A PaymentIntent transitions through
-         * [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
+         * [multiple statuses](https://docs.stripe.com/payments/paymentintents/lifecycle)
          * throughout its lifetime as it interfaces with Stripe.js to perform
          * authentication flows and ultimately creates at most one successful charge.
          *
-         * Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
+         * Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents)
          */
         payment_intent?: Stripe.PaymentIntent;
 
         /**
          * PaymentMethod objects represent your customer's payment instruments.
-         * You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
+         * You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to
          * Customer objects to store instrument details for future payments.
          *
-         * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
+         * Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).
          */
         payment_method?: Stripe.PaymentMethod;
 
@@ -345,7 +336,7 @@ declare module 'stripe' {
         /**
          * A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
          * For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
-         * Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
+         * Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow.
          *
          * Create a SetupIntent when you're ready to collect your customer's payment credentials.
          * Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
@@ -356,9 +347,9 @@ declare module 'stripe' {
          * For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
          * [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
          * to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
-         * If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
+         * If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer),
          * it automatically attaches the resulting payment method to that Customer after successful setup.
-         * We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
+         * We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on
          * PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
          *
          * By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
@@ -383,6 +374,7 @@ declare module 'stripe' {
           | 'account_information_mismatch'
           | 'account_invalid'
           | 'account_number_invalid'
+          | 'account_token_required_for_v2_account'
           | 'acss_debit_session_incomplete'
           | 'alipay_upgrade_required'
           | 'amount_too_large'
@@ -428,7 +420,6 @@ declare module 'stripe' {
           | 'financial_connections_account_inactive'
           | 'financial_connections_account_pending_account_numbers'
           | 'financial_connections_account_unavailable_account_numbers'
-          | 'financial_connections_institution_unavailable'
           | 'financial_connections_no_successful_transaction_refresh'
           | 'forwarding_api_inactive'
           | 'forwarding_api_invalid_parameter'
@@ -527,7 +518,6 @@ declare module 'stripe' {
           | 'return_intent_already_processed'
           | 'routing_number_invalid'
           | 'secret_key_required'
-          | 'sensitive_data_access_expired'
           | 'sepa_unsupported_account'
           | 'setup_attempt_failed'
           | 'setup_intent_authentication_failure'
@@ -547,7 +537,6 @@ declare module 'stripe' {
           | 'taxes_calculation_failed'
           | 'terminal_location_country_unsupported'
           | 'terminal_reader_busy'
-          | 'terminal_reader_collected_data_invalid'
           | 'terminal_reader_hardware_fault'
           | 'terminal_reader_invalid_location_for_activation'
           | 'terminal_reader_invalid_location_for_payment'
@@ -560,9 +549,7 @@ declare module 'stripe' {
           | 'token_in_use'
           | 'transfer_source_balance_parameters_mismatch'
           | 'transfers_not_allowed'
-          | 'url_invalid'
-          | 'v2_account_disconnection_unsupported'
-          | 'v2_account_missing_configuration';
+          | 'url_invalid';
 
         type Type =
           | 'api_error'
@@ -574,8 +561,6 @@ declare module 'stripe' {
       interface NextAction {
         cashapp_handle_redirect_or_display_qr_code?: NextAction.CashappHandleRedirectOrDisplayQrCode;
 
-        pix_display_qr_code?: NextAction.PixDisplayQrCode;
-
         redirect_to_url?: NextAction.RedirectToUrl;
 
         /**
@@ -625,33 +610,6 @@ declare module 'stripe' {
           }
         }
 
-        interface PixDisplayQrCode {
-          /**
-           * The raw data string used to generate QR code, it should be used together with QR code library.
-           */
-          data?: string;
-
-          /**
-           * The date (unix timestamp) when the PIX expires.
-           */
-          expires_at?: number;
-
-          /**
-           * The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
-           */
-          hosted_instructions_url?: string;
-
-          /**
-           * The image_url_png string used to render png QR code
-           */
-          image_url_png?: string;
-
-          /**
-           * The image_url_svg string used to render svg QR code
-           */
-          image_url_svg?: string;
-        }
-
         interface RedirectToUrl {
           /**
            * If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
@@ -721,8 +679,6 @@ declare module 'stripe' {
 
         payto?: PaymentMethodOptions.Payto;
 
-        pix?: PaymentMethodOptions.Pix;
-
         sepa_debit?: PaymentMethodOptions.SepaDebit;
 
         us_bank_account?: PaymentMethodOptions.UsBankAccount;
@@ -811,7 +767,7 @@ declare module 'stripe' {
           network: Card.Network | null;
 
           /**
-           * 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.
            */
           request_three_d_secure: Card.RequestThreeDSecure | null;
         }
@@ -920,16 +876,6 @@ declare module 'stripe' {
            * The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
            */
           billing_agreement_id: string | null;
-
-          /**
-           * 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).
-           */
-          currency?: string | null;
-
-          /**
-           * 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.
-           */
-          subsellers?: Array<string>;
         }
 
         interface Payto {
@@ -1002,67 +948,6 @@ declare module 'stripe' {
           }
         }
 
-        interface Pix {
-          mandate_options?: Pix.MandateOptions;
-        }
-
-        namespace Pix {
-          interface MandateOptions {
-            /**
-             * Amount to be charged for future payments.
-             */
-            amount?: number;
-
-            /**
-             * Determines if the amount includes the IOF tax.
-             */
-            amount_includes_iof?: MandateOptions.AmountIncludesIof;
-
-            /**
-             * Type of amount.
-             */
-            amount_type?: MandateOptions.AmountType;
-
-            /**
-             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
-             */
-            currency?: string;
-
-            /**
-             * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
-             */
-            end_date?: string;
-
-            /**
-             * Schedule at which the future payments will be charged.
-             */
-            payment_schedule?: MandateOptions.PaymentSchedule;
-
-            /**
-             * Subscription name displayed to buyers in their bank app.
-             */
-            reference?: string;
-
-            /**
-             * Start date of the mandate, in `YYYY-MM-DD`.
-             */
-            start_date?: string;
-          }
-
-          namespace MandateOptions {
-            type AmountIncludesIof = 'always' | 'never';
-
-            type AmountType = 'fixed' | 'maximum';
-
-            type PaymentSchedule =
-              | 'halfyearly'
-              | 'monthly'
-              | 'quarterly'
-              | 'weekly'
-              | 'yearly';
-          }
-        }
-
         interface SepaDebit {
           mandate_options?: SepaDebit.MandateOptions;
         }
@@ -1091,8 +976,6 @@ declare module 'stripe' {
           interface FinancialConnections {
             filters?: FinancialConnections.Filters;
 
-            manual_entry?: FinancialConnections.ManualEntry;
-
             /**
              * The list of permissions to request. The `payment_method` permission must be included.
              */
@@ -1115,39 +998,19 @@ declare module 'stripe' {
                * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
                */
               account_subcategories?: Array<Filters.AccountSubcategory>;
-
-              /**
-               * The institution to use to filter for possible accounts to link.
-               */
-              institution?: string;
             }
 
             namespace Filters {
               type AccountSubcategory = 'checking' | 'savings';
             }
 
-            interface ManualEntry {
-              /**
-               * Settings for configuring manual entry of account details.
-               */
-              mode?: ManualEntry.Mode;
-            }
-
-            namespace ManualEntry {
-              type Mode = 'automatic' | 'custom';
-            }
-
             type Permission =
               | 'balances'
               | 'ownership'
               | 'payment_method'
               | 'transactions';
 
-            type Prefetch =
-              | 'balances'
-              | 'inferred_balances'
-              | 'ownership'
-              | 'transactions';
+            type Prefetch = 'balances' | 'ownership' | 'transactions';
           }
 
           interface MandateOptions {
@@ -1161,25 +1024,6 @@ declare module 'stripe' {
         }
       }
 
-      interface SetupDetails {
-        benefit?: SetupDetails.Benefit;
-      }
-
-      namespace SetupDetails {
-        interface Benefit {
-          fr_meal_voucher?: Benefit.FrMealVoucher;
-        }
-
-        namespace Benefit {
-          interface FrMealVoucher {
-            /**
-             * The 14-digit SIRET of the meal voucher acceptor.
-             */
-            siret?: string;
-          }
-        }
-      }
-
       type Status =
         | 'canceled'
         | 'processing'