stripe 19.3.0 → 19.4.0-alpha.1

package/types/Refunds.d.ts

@@ -148,6 +148,8 @@ declare module 'stripe' {
 
         grabpay?: DestinationDetails.Grabpay;
 
+        id_bank_transfer?: DestinationDetails.IdBankTransfer;
+
         jp_bank_transfer?: DestinationDetails.JpBankTransfer;
 
         klarna?: DestinationDetails.Klarna;
@@ -295,6 +297,18 @@ declare module 'stripe' {
 
         interface Grabpay {}
 
+        interface IdBankTransfer {
+          /**
+           * The reference assigned to the refund.
+           */
+          reference: string | null;
+
+          /**
+           * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+           */
+          reference_status: string | null;
+        }
+
         interface JpBankTransfer {
           /**
            * The reference assigned to the refund.

package/types/SetupAttempts.d.ts

@@ -41,6 +41,11 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
 
+      /**
+       * The value of [customer_account](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer_account) on the SetupIntent at the time of this confirmation.
+       */
+      customer_account?: string | null;
+
       /**
        * Indicates the directions of money movement for which this payment method is intended to be used.
        *
@@ -108,6 +113,8 @@ declare module 'stripe' {
 
         cashapp?: PaymentMethodDetails.Cashapp;
 
+        id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
+
         ideal?: PaymentMethodDetails.Ideal;
 
         kakao_pay?: PaymentMethodDetails.KakaoPay;
@@ -124,12 +131,18 @@ declare module 'stripe' {
 
         paypal?: PaymentMethodDetails.Paypal;
 
+        payto?: PaymentMethodDetails.Payto;
+
+        pix?: PaymentMethodDetails.Pix;
+
         revolut_pay?: PaymentMethodDetails.RevolutPay;
 
         sepa_debit?: PaymentMethodDetails.SepaDebit;
 
         sofort?: PaymentMethodDetails.Sofort;
 
+        stripe_balance?: PaymentMethodDetails.StripeBalance;
+
         /**
          * The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.
          */
@@ -398,6 +411,32 @@ declare module 'stripe' {
 
         interface Cashapp {}
 
+        interface IdBankTransfer {
+          /**
+           * Bank where the account is located.
+           */
+          bank: IdBankTransfer.Bank | null;
+
+          /**
+           * Local bank code of the bank.
+           */
+          bank_code: string | null;
+
+          /**
+           * Name of the bank associated with the bank account.
+           */
+          bank_name: string | null;
+
+          /**
+           * Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
+           */
+          display_name: string | null;
+        }
+
+        namespace IdBankTransfer {
+          type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+        }
+
         interface Ideal {
           /**
            * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -491,6 +530,10 @@ declare module 'stripe' {
 
         interface Paypal {}
 
+        interface Payto {}
+
+        interface Pix {}
+
         interface RevolutPay {}
 
         interface SepaDebit {}
@@ -543,6 +586,8 @@ declare module 'stripe' {
           type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
         }
 
+        interface StripeBalance {}
+
         interface UsBankAccount {}
       }
 
@@ -712,6 +757,7 @@ 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'
@@ -810,6 +856,7 @@ 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'
@@ -829,6 +876,7 @@ 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'
@@ -841,7 +889,9 @@ declare module 'stripe' {
           | 'token_in_use'
           | 'transfer_source_balance_parameters_mismatch'
           | 'transfers_not_allowed'
-          | 'url_invalid';
+          | 'url_invalid'
+          | 'v2_account_disconnection_unsupported'
+          | 'v2_account_missing_configuration';
 
         type Type =
           | 'api_error'

package/types/SetupIntents.d.ts

@@ -77,6 +77,13 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
 
+      /**
+       * ID of the Account this SetupIntent belongs to, if one exists.
+       *
+       * 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.
+       */
+      customer_account?: string | null;
+
       /**
        * An arbitrary string attached to the object. Often useful for displaying to users.
        */
@@ -151,6 +158,8 @@ declare module 'stripe' {
        */
       payment_method_types: Array<string>;
 
+      setup_details?: SetupIntent.SetupDetails;
+
       /**
        * ID of the single_use Mandate generated by the SetupIntent.
        */
@@ -213,7 +222,9 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
+        | 'id_bank_transfer'
         | 'ideal'
         | 'kakao_pay'
         | 'klarna'
@@ -230,13 +241,19 @@ 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'
@@ -411,6 +428,7 @@ 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'
@@ -509,6 +527,7 @@ 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'
@@ -528,6 +547,7 @@ 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'
@@ -540,7 +560,9 @@ declare module 'stripe' {
           | 'token_in_use'
           | 'transfer_source_balance_parameters_mismatch'
           | 'transfers_not_allowed'
-          | 'url_invalid';
+          | 'url_invalid'
+          | 'v2_account_disconnection_unsupported'
+          | 'v2_account_missing_configuration';
 
         type Type =
           | 'api_error'
@@ -552,6 +574,8 @@ 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;
 
         /**
@@ -601,6 +625,33 @@ 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.
@@ -668,6 +719,10 @@ declare module 'stripe' {
 
         paypal?: PaymentMethodOptions.Paypal;
 
+        payto?: PaymentMethodOptions.Payto;
+
+        pix?: PaymentMethodOptions.Pix;
+
         sepa_debit?: PaymentMethodOptions.SepaDebit;
 
         us_bank_account?: PaymentMethodOptions.UsBankAccount;
@@ -865,6 +920,147 @@ 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 {
+          mandate_options?: Payto.MandateOptions;
+        }
+
+        namespace Payto {
+          interface MandateOptions {
+            /**
+             * Amount that will be collected. It is required when `amount_type` is `fixed`.
+             */
+            amount: number | null;
+
+            /**
+             * 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 | null;
+
+            /**
+             * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+             */
+            end_date: string | null;
+
+            /**
+             * The periodicity at which payments will be collected.
+             */
+            payment_schedule: MandateOptions.PaymentSchedule | null;
+
+            /**
+             * 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 | null;
+
+            /**
+             * The purpose for which payments are made. Defaults to retail.
+             */
+            purpose: MandateOptions.Purpose | null;
+
+            /**
+             * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+             */
+            start_date: string | null;
+          }
+
+          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 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 {
@@ -895,6 +1091,8 @@ 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.
              */
@@ -917,19 +1115,39 @@ 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' | 'ownership' | 'transactions';
+            type Prefetch =
+              | 'balances'
+              | 'inferred_balances'
+              | 'ownership'
+              | 'transactions';
           }
 
           interface MandateOptions {
@@ -943,6 +1161,25 @@ 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'