stripe 17.5.0 → 17.6.0-beta.1

package/types/TestHelpers/ConfirmationTokensResource.d.ts

@@ -129,11 +129,21 @@ declare module 'stripe' {
            */
           giropay?: PaymentMethodData.Giropay;
 
+          /**
+           * If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
+           */
+          gopay?: PaymentMethodData.Gopay;
+
           /**
            * If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
            */
           grabpay?: PaymentMethodData.Grabpay;
 
+          /**
+           * If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
+           */
+          id_bank_transfer?: PaymentMethodData.IdBankTransfer;
+
           /**
            * If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
            */
@@ -169,6 +179,11 @@ declare module 'stripe' {
            */
           link?: PaymentMethodData.Link;
 
+          /**
+           * If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
+           */
+          mb_way?: PaymentMethodData.MbWay;
+
           /**
            * 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`.
            */
@@ -214,6 +229,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.
            */
@@ -224,11 +244,21 @@ declare module 'stripe' {
            */
           promptpay?: PaymentMethodData.Promptpay;
 
+          /**
+           * If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
+           */
+          qris?: PaymentMethodData.Qris;
+
           /**
            * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
            */
           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.
            */
@@ -244,6 +274,11 @@ declare module 'stripe' {
            */
           sepa_debit?: PaymentMethodData.SepaDebit;
 
+          /**
+           * If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
+           */
+          shopeepay?: PaymentMethodData.Shopeepay;
+
           /**
            * If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
            */
@@ -452,8 +487,21 @@ declare module 'stripe' {
 
           interface Giropay {}
 
+          interface Gopay {}
+
           interface Grabpay {}
 
+          interface IdBankTransfer {
+            /**
+             * Bank where the account is held.
+             */
+            bank?: IdBankTransfer.Bank;
+          }
+
+          namespace IdBankTransfer {
+            type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+          }
+
           interface Ideal {
             /**
              * The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
@@ -517,6 +565,8 @@ declare module 'stripe' {
 
           interface Link {}
 
+          interface MbWay {}
+
           interface Mobilepay {}
 
           interface Multibanco {}
@@ -577,10 +627,29 @@ 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 {}
 
+          interface Qris {}
+
           interface RadarOptions {
             /**
              * 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.
@@ -588,6 +657,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 SamsungPay {}
@@ -599,6 +694,8 @@ declare module 'stripe' {
             iban: string;
           }
 
+          interface Shopeepay {}
+
           interface Sofort {
             /**
              * Two-letter ISO code representing the country the bank account is located in.
@@ -631,13 +728,16 @@ declare module 'stripe' {
             | 'eps'
             | 'fpx'
             | 'giropay'
+            | 'gopay'
             | 'grabpay'
+            | 'id_bank_transfer'
             | 'ideal'
             | 'kakao_pay'
             | 'klarna'
             | 'konbini'
             | 'kr_card'
             | 'link'
+            | 'mb_way'
             | 'mobilepay'
             | 'multibanco'
             | 'naver_pay'
@@ -646,11 +746,15 @@ declare module 'stripe' {
             | 'payco'
             | 'paynow'
             | 'paypal'
+            | 'payto'
             | 'pix'
             | 'promptpay'
+            | 'qris'
+            | 'rechnung'
             | 'revolut_pay'
             | 'samsung_pay'
             | 'sepa_debit'
+            | 'shopeepay'
             | 'sofort'
             | 'swish'
             | 'twint'

package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts

@@ -39,6 +39,11 @@ declare module 'stripe' {
            * Initiating payment method details for the object.
            */
           initiating_payment_method_details?: ReceivedCreditCreateParams.InitiatingPaymentMethodDetails;
+
+          /**
+           * Details about the network used for the ReceivedCredit.
+           */
+          network_details?: ReceivedCreditCreateParams.NetworkDetails;
         }
 
         namespace ReceivedCreditCreateParams {
@@ -74,6 +79,27 @@ declare module 'stripe' {
           }
 
           type Network = 'ach' | 'us_domestic_wire';
+
+          interface NetworkDetails {
+            /**
+             * Optional fields for `ach`.
+             */
+            ach?: NetworkDetails.Ach;
+
+            /**
+             * The type of flow that originated the ReceivedCredit.
+             */
+            type: 'ach';
+          }
+
+          namespace NetworkDetails {
+            interface Ach {
+              /**
+               * ACH Addenda record
+               */
+              addenda?: string;
+            }
+          }
         }
       }
 

package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts

@@ -39,6 +39,11 @@ declare module 'stripe' {
            * Initiating payment method details for the object.
            */
           initiating_payment_method_details?: ReceivedDebitCreateParams.InitiatingPaymentMethodDetails;
+
+          /**
+           * Details about the network used for the ReceivedDebit.
+           */
+          network_details?: ReceivedDebitCreateParams.NetworkDetails;
         }
 
         namespace ReceivedDebitCreateParams {
@@ -72,6 +77,27 @@ declare module 'stripe' {
               routing_number?: string;
             }
           }
+
+          interface NetworkDetails {
+            /**
+             * Optional fields for `ach`.
+             */
+            ach?: NetworkDetails.Ach;
+
+            /**
+             * The type of flow that originated the ReceivedDebit.
+             */
+            type: 'ach';
+          }
+
+          namespace NetworkDetails {
+            interface Ach {
+              /**
+               * Addenda record data associated with this ReceivedDebit.
+               */
+              addenda?: string;
+            }
+          }
         }
       }
 

package/types/TokensResource.d.ts

@@ -140,6 +140,10 @@ declare module 'stripe' {
            */
           ownership_declaration_shown_and_signed?: boolean;
 
+          ownership_exemption_reason?: Stripe.Emptyable<
+            Company.OwnershipExemptionReason
+          >;
+
           /**
            * The company's phone number (used for verification).
            */
@@ -194,6 +198,10 @@ declare module 'stripe' {
             user_agent?: string;
           }
 
+          type OwnershipExemptionReason =
+            | 'qualified_entity_exceeds_ownership_threshold'
+            | 'qualifies_as_financial_institution';
+
           type Structure =
             | 'free_zone_establishment'
             | 'free_zone_llc'

package/types/Treasury/FinancialAccountFeatures.d.ts

@@ -175,6 +175,11 @@ declare module 'stripe' {
 
         namespace FinancialAddresses {
           interface Aba {
+            /**
+             * Requested bank partner for this Financial Account
+             */
+            bank?: Aba.Bank;
+
             /**
              * Whether the FinancialAccount should have the Feature.
              */
@@ -192,6 +197,8 @@ declare module 'stripe' {
           }
 
           namespace Aba {
+            type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+
             type Status = 'active' | 'pending' | 'restricted';
 
             interface StatusDetail {

package/types/Treasury/FinancialAccounts.d.ts

@@ -38,6 +38,11 @@ declare module 'stripe' {
          */
         created: number;
 
+        /**
+         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+         */
+        display_name?: string | null;
+
         /**
          * Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
          * Stripe or the platform can control Features via the requested field.
@@ -49,6 +54,8 @@ declare module 'stripe' {
          */
         financial_addresses: Array<FinancialAccount.FinancialAddress>;
 
+        is_default?: boolean;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
@@ -59,6 +66,11 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata | null;
 
+        /**
+         * The nickname for the FinancialAccount.
+         */
+        nickname?: string | null;
+
         /**
          * The array of paths to pending Features in the Features hash.
          */

package/types/Treasury/FinancialAccountsResource.d.ts

@@ -9,6 +9,11 @@ declare module 'stripe' {
          */
         supported_currencies: Array<string>;
 
+        /**
+         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+         */
+        display_name?: Stripe.Emptyable<string>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -24,6 +29,11 @@ declare module 'stripe' {
          */
         metadata?: Stripe.MetadataParam;
 
+        /**
+         * The nickname for the FinancialAccount.
+         */
+        nickname?: Stripe.Emptyable<string>;
+
         /**
          * The set of functionalities that the platform can restrict on the FinancialAccount.
          */
@@ -92,11 +102,20 @@ declare module 'stripe' {
 
           namespace FinancialAddresses {
             interface Aba {
+              /**
+               * Requested bank partner
+               */
+              bank?: Aba.Bank;
+
               /**
                * Whether the FinancialAccount should have the Feature.
                */
               requested: boolean;
             }
+
+            namespace Aba {
+              type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+            }
           }
 
           interface InboundTransfers {
@@ -206,6 +225,11 @@ declare module 'stripe' {
       }
 
       interface FinancialAccountUpdateParams {
+        /**
+         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+         */
+        display_name?: Stripe.Emptyable<string>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -216,11 +240,21 @@ declare module 'stripe' {
          */
         features?: FinancialAccountUpdateParams.Features;
 
+        /**
+         * A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
+         */
+        forwarding_settings?: FinancialAccountUpdateParams.ForwardingSettings;
+
         /**
          * 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`.
          */
         metadata?: Stripe.MetadataParam;
 
+        /**
+         * The nickname for the FinancialAccount.
+         */
+        nickname?: Stripe.Emptyable<string>;
+
         /**
          * The set of functionalities that the platform can restrict on the FinancialAccount.
          */
@@ -289,11 +323,20 @@ declare module 'stripe' {
 
           namespace FinancialAddresses {
             interface Aba {
+              /**
+               * Requested bank partner
+               */
+              bank?: Aba.Bank;
+
               /**
                * Whether the FinancialAccount should have the Feature.
                */
               requested: boolean;
             }
+
+            namespace Aba {
+              type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+            }
           }
 
           interface InboundTransfers {
@@ -376,6 +419,27 @@ declare module 'stripe' {
           }
         }
 
+        interface ForwardingSettings {
+          /**
+           * The financial_account id
+           */
+          financial_account?: string;
+
+          /**
+           * The payment_method or bank account id. This needs to be a verified bank account.
+           */
+          payment_method?: string;
+
+          /**
+           * The type of the bank account provided. This can be either "financial_account" or "payment_method"
+           */
+          type: ForwardingSettings.Type;
+        }
+
+        namespace ForwardingSettings {
+          type Type = 'financial_account' | 'payment_method';
+        }
+
         interface PlatformRestrictions {
           /**
            * Restricts all inbound money movement.
@@ -407,6 +471,41 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      interface FinancialAccountCloseParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
+         */
+        forwarding_settings?: FinancialAccountCloseParams.ForwardingSettings;
+      }
+
+      namespace FinancialAccountCloseParams {
+        interface ForwardingSettings {
+          /**
+           * The financial_account id
+           */
+          financial_account?: string;
+
+          /**
+           * The payment_method or bank account id. This needs to be a verified bank account.
+           */
+          payment_method?: string;
+
+          /**
+           * The type of the bank account provided. This can be either "financial_account" or "payment_method"
+           */
+          type: ForwardingSettings.Type;
+        }
+
+        namespace ForwardingSettings {
+          type Type = 'financial_account' | 'payment_method';
+        }
+      }
+
       interface FinancialAccountRetrieveFeaturesParams {
         /**
          * Specifies which fields in the response should be expanded.
@@ -480,11 +579,20 @@ declare module 'stripe' {
 
         namespace FinancialAddresses {
           interface Aba {
+            /**
+             * Requested bank partner
+             */
+            bank?: Aba.Bank;
+
             /**
              * Whether the FinancialAccount should have the Feature.
              */
             requested: boolean;
           }
+
+          namespace Aba {
+            type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+          }
         }
 
         interface InboundTransfers {
@@ -609,6 +717,19 @@ declare module 'stripe' {
           options?: RequestOptions
         ): ApiListPromise<Stripe.Treasury.FinancialAccount>;
 
+        /**
+         * Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
+         */
+        close(
+          id: string,
+          params?: FinancialAccountCloseParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccount>>;
+        close(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccount>>;
+
         /**
          * Retrieves Features information associated with the FinancialAccount.
          */

package/types/Treasury/OutboundTransfers.d.ts

@@ -78,6 +78,11 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata;
 
+        /**
+         * Details about the network used for the OutboundTransfer.
+         */
+        network_details?: OutboundTransfer.NetworkDetails | null;
+
         /**
          * Details about a returned OutboundTransfer. Only set when the status is `returned`.
          */
@@ -110,10 +115,12 @@ declare module 'stripe' {
         interface DestinationPaymentMethodDetails {
           billing_details: DestinationPaymentMethodDetails.BillingDetails;
 
+          financial_account?: DestinationPaymentMethodDetails.FinancialAccount;
+
           /**
            * The type of the payment method used in the OutboundTransfer.
            */
-          type: 'us_bank_account';
+          type: DestinationPaymentMethodDetails.Type;
 
           us_bank_account?: DestinationPaymentMethodDetails.UsBankAccount;
         }
@@ -133,6 +140,20 @@ declare module 'stripe' {
             name: string | null;
           }
 
+          interface FinancialAccount {
+            /**
+             * Token of the FinancialAccount.
+             */
+            id: string;
+
+            /**
+             * The rails used to send funds.
+             */
+            network: 'stripe';
+          }
+
+          type Type = 'financial_account' | 'us_bank_account';
+
           interface UsBankAccount {
             /**
              * Account holder type: individual or company.
@@ -184,6 +205,27 @@ declare module 'stripe' {
           }
         }
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the OutboundTransfer.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReturnedDetails {
           /**
            * Reason for the return.