stripe 16.4.0 → 16.6.0-beta.1

package/types/SetupIntentsResource.d.ts

@@ -334,6 +334,11 @@ declare module 'stripe' {
          */
         paypal?: PaymentMethodData.Paypal;
 
+        /**
+         * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+         */
+        payto?: PaymentMethodData.Payto;
+
         /**
          * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
          */
@@ -349,6 +354,11 @@ declare module 'stripe' {
          */
         radar_options?: PaymentMethodData.RadarOptions;
 
+        /**
+         * If this is a Rechnung PaymentMethod, this hash contains details about the Rechnung payment method.
+         */
+        rechnung?: PaymentMethodData.Rechnung;
+
         /**
          * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
          */
@@ -673,6 +683,23 @@ declare module 'stripe' {
 
         interface Paypal {}
 
+        interface Payto {
+          /**
+           * The account number for the bank account.
+           */
+          account_number?: string;
+
+          /**
+           * Bank-State-Branch number of the bank account.
+           */
+          bsb_number?: string;
+
+          /**
+           * The PayID alias for the bank account.
+           */
+          pay_id?: string;
+        }
+
         interface Pix {}
 
         interface Promptpay {}
@@ -684,6 +711,32 @@ declare module 'stripe' {
           session?: string;
         }
 
+        interface Rechnung {
+          /**
+           * Customer's date of birth
+           */
+          dob: Rechnung.Dob;
+        }
+
+        namespace Rechnung {
+          interface Dob {
+            /**
+             * The day of birth, between 1 and 31.
+             */
+            day: number;
+
+            /**
+             * The month of birth, between 1 and 12.
+             */
+            month: number;
+
+            /**
+             * The four-digit year of birth.
+             */
+            year: number;
+          }
+        }
+
         interface RevolutPay {}
 
         interface SepaDebit {
@@ -735,8 +788,10 @@ declare module 'stripe' {
           | 'p24'
           | 'paynow'
           | 'paypal'
+          | 'payto'
           | 'pix'
           | 'promptpay'
+          | 'rechnung'
           | 'revolut_pay'
           | 'sepa_debit'
           | 'sofort'
@@ -815,6 +870,11 @@ declare module 'stripe' {
          */
         paypal?: PaymentMethodOptions.Paypal;
 
+        /**
+         * If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
+         */
+        payto?: PaymentMethodOptions.Payto;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -1098,6 +1158,86 @@ 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;
+
+          currency?: string;
+
+          /**
+           * 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 {
+          /**
+           * Additional fields for Mandate creation.
+           */
+          mandate_options?: Payto.MandateOptions;
+        }
+
+        namespace Payto {
+          interface MandateOptions {
+            /**
+             * Amount that will be collected. It is required when `amount_type` is `fixed`.
+             */
+            amount?: number;
+
+            /**
+             * 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.
+             */
+            amount_type?: MandateOptions.AmountType;
+
+            /**
+             * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+             */
+            end_date?: string;
+
+            /**
+             * The periodicity at which payments will be collected.
+             */
+            payment_schedule?: MandateOptions.PaymentSchedule;
+
+            /**
+             * 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.
+             */
+            payments_per_period?: number;
+
+            /**
+             * The purpose for which payments are made. Defaults to retail.
+             */
+            purpose?: MandateOptions.Purpose;
+
+            /**
+             * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+             */
+            start_date?: string;
+          }
+
+          namespace MandateOptions {
+            type AmountType = 'fixed' | 'maximum';
+
+            type PaymentSchedule =
+              | 'adhoc'
+              | 'annual'
+              | 'daily'
+              | 'fortnightly'
+              | 'monthly'
+              | 'quarterly'
+              | 'semi_annual'
+              | 'weekly';
+
+            type Purpose =
+              | 'dependant_support'
+              | 'government'
+              | 'loan'
+              | 'mortgage'
+              | 'other'
+              | 'pension'
+              | 'personal'
+              | 'retail'
+              | 'salary'
+              | 'tax'
+              | 'utility';
+          }
         }
 
         interface SepaDebit {
@@ -1140,6 +1280,11 @@ declare module 'stripe' {
              */
             filters?: FinancialConnections.Filters;
 
+            /**
+             * Customize manual entry behavior
+             */
+            manual_entry?: FinancialConnections.ManualEntry;
+
             /**
              * 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`.
              */
@@ -1162,19 +1307,39 @@ declare module 'stripe' {
                * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                */
               account_subcategories?: Array<Filters.AccountSubcategory>;
+
+              /**
+               * ID of the institution to use to filter for selectable accounts.
+               */
+              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' | 'ownership' | 'transactions';
+            type Prefetch =
+              | 'balances'
+              | 'inferred_balances'
+              | 'ownership'
+              | 'transactions';
           }
 
           interface MandateOptions {
@@ -1444,6 +1609,11 @@ declare module 'stripe' {
          */
         paypal?: PaymentMethodData.Paypal;
 
+        /**
+         * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+         */
+        payto?: PaymentMethodData.Payto;
+
         /**
          * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
          */
@@ -1459,6 +1629,11 @@ declare module 'stripe' {
          */
         radar_options?: PaymentMethodData.RadarOptions;
 
+        /**
+         * If this is a Rechnung PaymentMethod, this hash contains details about the Rechnung payment method.
+         */
+        rechnung?: PaymentMethodData.Rechnung;
+
         /**
          * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
          */
@@ -1783,6 +1958,23 @@ declare module 'stripe' {
 
         interface Paypal {}
 
+        interface Payto {
+          /**
+           * The account number for the bank account.
+           */
+          account_number?: string;
+
+          /**
+           * Bank-State-Branch number of the bank account.
+           */
+          bsb_number?: string;
+
+          /**
+           * The PayID alias for the bank account.
+           */
+          pay_id?: string;
+        }
+
         interface Pix {}
 
         interface Promptpay {}
@@ -1794,6 +1986,32 @@ declare module 'stripe' {
           session?: string;
         }
 
+        interface Rechnung {
+          /**
+           * Customer's date of birth
+           */
+          dob: Rechnung.Dob;
+        }
+
+        namespace Rechnung {
+          interface Dob {
+            /**
+             * The day of birth, between 1 and 31.
+             */
+            day: number;
+
+            /**
+             * The month of birth, between 1 and 12.
+             */
+            month: number;
+
+            /**
+             * The four-digit year of birth.
+             */
+            year: number;
+          }
+        }
+
         interface RevolutPay {}
 
         interface SepaDebit {
@@ -1845,8 +2063,10 @@ declare module 'stripe' {
           | 'p24'
           | 'paynow'
           | 'paypal'
+          | 'payto'
           | 'pix'
           | 'promptpay'
+          | 'rechnung'
           | 'revolut_pay'
           | 'sepa_debit'
           | 'sofort'
@@ -1925,6 +2145,11 @@ declare module 'stripe' {
          */
         paypal?: PaymentMethodOptions.Paypal;
 
+        /**
+         * If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
+         */
+        payto?: PaymentMethodOptions.Payto;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -2208,6 +2433,86 @@ 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;
+
+          currency?: string;
+
+          /**
+           * 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 {
+          /**
+           * Additional fields for Mandate creation.
+           */
+          mandate_options?: Payto.MandateOptions;
+        }
+
+        namespace Payto {
+          interface MandateOptions {
+            /**
+             * Amount that will be collected. It is required when `amount_type` is `fixed`.
+             */
+            amount?: number;
+
+            /**
+             * 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.
+             */
+            amount_type?: MandateOptions.AmountType;
+
+            /**
+             * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+             */
+            end_date?: string;
+
+            /**
+             * The periodicity at which payments will be collected.
+             */
+            payment_schedule?: MandateOptions.PaymentSchedule;
+
+            /**
+             * 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.
+             */
+            payments_per_period?: number;
+
+            /**
+             * The purpose for which payments are made. Defaults to retail.
+             */
+            purpose?: MandateOptions.Purpose;
+
+            /**
+             * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+             */
+            start_date?: string;
+          }
+
+          namespace MandateOptions {
+            type AmountType = 'fixed' | 'maximum';
+
+            type PaymentSchedule =
+              | 'adhoc'
+              | 'annual'
+              | 'daily'
+              | 'fortnightly'
+              | 'monthly'
+              | 'quarterly'
+              | 'semi_annual'
+              | 'weekly';
+
+            type Purpose =
+              | 'dependant_support'
+              | 'government'
+              | 'loan'
+              | 'mortgage'
+              | 'other'
+              | 'pension'
+              | 'personal'
+              | 'retail'
+              | 'salary'
+              | 'tax'
+              | 'utility';
+          }
         }
 
         interface SepaDebit {
@@ -2250,6 +2555,11 @@ declare module 'stripe' {
              */
             filters?: FinancialConnections.Filters;
 
+            /**
+             * Customize manual entry behavior
+             */
+            manual_entry?: FinancialConnections.ManualEntry;
+
             /**
              * 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`.
              */
@@ -2272,19 +2582,39 @@ declare module 'stripe' {
                * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                */
               account_subcategories?: Array<Filters.AccountSubcategory>;
+
+              /**
+               * ID of the institution to use to filter for selectable accounts.
+               */
+              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' | 'ownership' | 'transactions';
+            type Prefetch =
+              | 'balances'
+              | 'inferred_balances'
+              | 'ownership'
+              | 'transactions';
           }
 
           interface MandateOptions {
@@ -2603,6 +2933,11 @@ declare module 'stripe' {
          */
         paypal?: PaymentMethodData.Paypal;
 
+        /**
+         * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+         */
+        payto?: PaymentMethodData.Payto;
+
         /**
          * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
          */
@@ -2618,6 +2953,11 @@ declare module 'stripe' {
          */
         radar_options?: PaymentMethodData.RadarOptions;
 
+        /**
+         * If this is a Rechnung PaymentMethod, this hash contains details about the Rechnung payment method.
+         */
+        rechnung?: PaymentMethodData.Rechnung;
+
         /**
          * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
          */
@@ -2942,6 +3282,23 @@ declare module 'stripe' {
 
         interface Paypal {}
 
+        interface Payto {
+          /**
+           * The account number for the bank account.
+           */
+          account_number?: string;
+
+          /**
+           * Bank-State-Branch number of the bank account.
+           */
+          bsb_number?: string;
+
+          /**
+           * The PayID alias for the bank account.
+           */
+          pay_id?: string;
+        }
+
         interface Pix {}
 
         interface Promptpay {}
@@ -2953,6 +3310,32 @@ declare module 'stripe' {
           session?: string;
         }
 
+        interface Rechnung {
+          /**
+           * Customer's date of birth
+           */
+          dob: Rechnung.Dob;
+        }
+
+        namespace Rechnung {
+          interface Dob {
+            /**
+             * The day of birth, between 1 and 31.
+             */
+            day: number;
+
+            /**
+             * The month of birth, between 1 and 12.
+             */
+            month: number;
+
+            /**
+             * The four-digit year of birth.
+             */
+            year: number;
+          }
+        }
+
         interface RevolutPay {}
 
         interface SepaDebit {
@@ -3004,8 +3387,10 @@ declare module 'stripe' {
           | 'p24'
           | 'paynow'
           | 'paypal'
+          | 'payto'
           | 'pix'
           | 'promptpay'
+          | 'rechnung'
           | 'revolut_pay'
           | 'sepa_debit'
           | 'sofort'
@@ -3084,6 +3469,11 @@ declare module 'stripe' {
          */
         paypal?: PaymentMethodOptions.Paypal;
 
+        /**
+         * If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.
+         */
+        payto?: PaymentMethodOptions.Payto;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -3367,6 +3757,86 @@ 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;
+
+          currency?: string;
+
+          /**
+           * 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 {
+          /**
+           * Additional fields for Mandate creation.
+           */
+          mandate_options?: Payto.MandateOptions;
+        }
+
+        namespace Payto {
+          interface MandateOptions {
+            /**
+             * Amount that will be collected. It is required when `amount_type` is `fixed`.
+             */
+            amount?: number;
+
+            /**
+             * 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.
+             */
+            amount_type?: MandateOptions.AmountType;
+
+            /**
+             * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+             */
+            end_date?: string;
+
+            /**
+             * The periodicity at which payments will be collected.
+             */
+            payment_schedule?: MandateOptions.PaymentSchedule;
+
+            /**
+             * 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.
+             */
+            payments_per_period?: number;
+
+            /**
+             * The purpose for which payments are made. Defaults to retail.
+             */
+            purpose?: MandateOptions.Purpose;
+
+            /**
+             * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+             */
+            start_date?: string;
+          }
+
+          namespace MandateOptions {
+            type AmountType = 'fixed' | 'maximum';
+
+            type PaymentSchedule =
+              | 'adhoc'
+              | 'annual'
+              | 'daily'
+              | 'fortnightly'
+              | 'monthly'
+              | 'quarterly'
+              | 'semi_annual'
+              | 'weekly';
+
+            type Purpose =
+              | 'dependant_support'
+              | 'government'
+              | 'loan'
+              | 'mortgage'
+              | 'other'
+              | 'pension'
+              | 'personal'
+              | 'retail'
+              | 'salary'
+              | 'tax'
+              | 'utility';
+          }
         }
 
         interface SepaDebit {
@@ -3409,6 +3879,11 @@ declare module 'stripe' {
              */
             filters?: FinancialConnections.Filters;
 
+            /**
+             * Customize manual entry behavior
+             */
+            manual_entry?: FinancialConnections.ManualEntry;
+
             /**
              * 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`.
              */
@@ -3431,19 +3906,39 @@ declare module 'stripe' {
                * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                */
               account_subcategories?: Array<Filters.AccountSubcategory>;
+
+              /**
+               * ID of the institution to use to filter for selectable accounts.
+               */
+              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' | 'ownership' | 'transactions';
+            type Prefetch =
+              | 'balances'
+              | 'inferred_balances'
+              | 'ownership'
+              | 'transactions';
           }
 
           interface MandateOptions {