stripe 16.7.0 → 16.8.0-beta.1

package/types/Terminal/ReadersResource.d.ts

@@ -104,6 +104,187 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      interface ReaderCollectInputsParams {
+        /**
+         * List of inputs to be collected using the Reader
+         */
+        inputs: Array<ReaderCollectInputsParams.Input>;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * 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;
+      }
+
+      namespace ReaderCollectInputsParams {
+        interface Input {
+          /**
+           * Customize the text which will be displayed while collecting this input
+           */
+          custom_text: Input.CustomText;
+
+          /**
+           * Indicate that this input is required, disabling the skip button
+           */
+          required?: boolean;
+
+          /**
+           * Options for the `selection` input
+           */
+          selection?: Input.Selection;
+
+          /**
+           * List of toggles to be displayed and customization for the toggles
+           */
+          toggles?: Array<Input.Toggle>;
+
+          /**
+           * The type of input to collect
+           */
+          type: Input.Type;
+        }
+
+        namespace Input {
+          interface CustomText {
+            /**
+             * The description which will be displayed when collecting this input
+             */
+            description?: string;
+
+            /**
+             * The skip button text
+             */
+            skip_button?: string;
+
+            /**
+             * The submit button text
+             */
+            submit_button?: string;
+
+            /**
+             * The title which will be displayed when collecting this input
+             */
+            title: string;
+          }
+
+          interface Selection {
+            /**
+             * List of choices for the `selection` input
+             */
+            choices: Array<Selection.Choice>;
+          }
+
+          namespace Selection {
+            interface Choice {
+              /**
+               * The style of the button which will be shown for this choice
+               */
+              style?: Choice.Style;
+
+              /**
+               * The text which will be shown on the button for this choice
+               */
+              value: string;
+            }
+
+            namespace Choice {
+              type Style = 'primary' | 'secondary';
+            }
+          }
+
+          interface Toggle {
+            /**
+             * The default value of the toggle
+             */
+            default_value?: Toggle.DefaultValue;
+
+            /**
+             * The description which will be displayed for the toggle
+             */
+            description?: string;
+
+            /**
+             * The title which will be displayed for the toggle
+             */
+            title?: string;
+          }
+
+          namespace Toggle {
+            type DefaultValue = 'disabled' | 'enabled';
+          }
+
+          type Type =
+            | 'email'
+            | 'numeric'
+            | 'phone'
+            | 'selection'
+            | 'signature'
+            | 'text';
+        }
+      }
+
+      interface ReaderCollectPaymentMethodParams {
+        /**
+         * PaymentIntent ID
+         */
+        payment_intent: string;
+
+        /**
+         * Configuration overrides
+         */
+        collect_config?: ReaderCollectPaymentMethodParams.CollectConfig;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace ReaderCollectPaymentMethodParams {
+        interface CollectConfig {
+          /**
+           * Enables cancel button on transaction screens.
+           */
+          enable_customer_cancellation?: boolean;
+
+          /**
+           * Override showing a tipping selection screen on this transaction.
+           */
+          skip_tipping?: boolean;
+
+          /**
+           * Tipping configuration for this transaction.
+           */
+          tipping?: CollectConfig.Tipping;
+        }
+
+        namespace CollectConfig {
+          interface Tipping {
+            /**
+             * Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
+             */
+            amount_eligible?: number;
+          }
+        }
+      }
+
+      interface ReaderConfirmPaymentIntentParams {
+        /**
+         * PaymentIntent ID
+         */
+        payment_intent: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
       interface ReaderProcessPaymentIntentParams {
         /**
          * PaymentIntent ID
@@ -369,6 +550,33 @@ declare module 'stripe' {
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
+        /**
+         * Initiates an input collection flow on a Reader.
+         */
+        collectInputs(
+          id: string,
+          params: ReaderCollectInputsParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+        /**
+         * Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+         */
+        collectPaymentMethod(
+          id: string,
+          params: ReaderCollectPaymentMethodParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+        /**
+         * Finalizes a payment on a Reader.
+         */
+        confirmPaymentIntent(
+          id: string,
+          params: ReaderConfirmPaymentIntentParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
         /**
          * Initiates a payment flow on a Reader.
          */

package/types/TestHelpers/ConfirmationTokensResource.d.ts

@@ -189,6 +189,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.
            */
@@ -204,6 +209,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.
            */
@@ -528,6 +538,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 {}
@@ -539,6 +566,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 {
@@ -590,8 +643,10 @@ declare module 'stripe' {
             | 'p24'
             | 'paynow'
             | 'paypal'
+            | 'payto'
             | 'pix'
             | 'promptpay'
+            | 'rechnung'
             | 'revolut_pay'
             | 'sepa_debit'
             | 'sofort'

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

@@ -45,6 +45,11 @@ declare module 'stripe' {
             type Type = 'ach' | 'us_domestic_wire';
 
             interface UsDomesticWire {
+              /**
+               * CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
+               */
+              chips?: string;
+
               /**
                * IMAD for funds sent over the `us_domestic_wire` network.
                */

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

@@ -45,6 +45,11 @@ declare module 'stripe' {
             type Type = 'ach' | 'us_domestic_wire';
 
             interface UsDomesticWire {
+              /**
+               * CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
+               */
+              chips?: string;
+
               /**
                * IMAD for funds sent over the `us_domestic_wire` network.
                */

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/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.

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.
          */
@@ -206,6 +211,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.
          */

package/types/Treasury/OutboundPayments.d.ts

@@ -300,10 +300,15 @@ declare module 'stripe' {
           type Type = 'ach' | 'us_domestic_wire';
 
           interface UsDomesticWire {
+            /**
+             * CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.
+             */
+            chips: string | null;
+
             /**
              * IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.
              */
-            imad: string;
+            imad: string | null;
 
             /**
              * OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.

package/types/Treasury/OutboundTransfers.d.ts

@@ -76,6 +76,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`.
          */
@@ -182,6 +187,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.
@@ -259,10 +285,15 @@ declare module 'stripe' {
           type Type = 'ach' | 'us_domestic_wire';
 
           interface UsDomesticWire {
+            /**
+             * CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
+             */
+            chips: string | null;
+
             /**
              * IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
              */
-            imad: string;
+            imad: string | null;
 
             /**
              * OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.

package/types/Treasury/OutboundTransfersResource.d.ts

@@ -44,6 +44,11 @@ declare module 'stripe' {
          */
         metadata?: Stripe.MetadataParam;
 
+        /**
+         * Details about the network used for the OutboundTransfer.
+         */
+        network_details?: OutboundTransferCreateParams.NetworkDetails;
+
         /**
          * Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
          */
@@ -72,6 +77,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 OutboundTransfer.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * Addenda record data associated with this OutboundTransfer.
+             */
+            addenda?: string;
+          }
+        }
       }
 
       interface OutboundTransferRetrieveParams {

package/types/Treasury/ReceivedCredits.d.ts

@@ -66,6 +66,11 @@ declare module 'stripe' {
          */
         network: ReceivedCredit.Network;
 
+        /**
+         * Details specific to the money movement rails.
+         */
+        network_details?: ReceivedCredit.NetworkDetails | null;
+
         /**
          * Details describing when a ReceivedCredit may be reversed.
          */
@@ -235,6 +240,27 @@ declare module 'stripe' {
 
         type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the ReceivedCredit.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReversalDetails {
           /**
            * Time before which a ReceivedCredit can be reversed.

package/types/Treasury/ReceivedDebits.d.ts

@@ -66,6 +66,11 @@ declare module 'stripe' {
          */
         network: ReceivedDebit.Network;
 
+        /**
+         * Details specific to the money movement rails.
+         */
+        network_details?: ReceivedDebit.NetworkDetails | null;
+
         /**
          * Details describing when a ReceivedDebit might be reversed.
          */
@@ -189,10 +194,36 @@ declare module 'stripe' {
            * Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
            */
           payout: string | null;
+
+          /**
+           * The ReceivedCredit that Capital withheld from
+           */
+          received_credit_capital_withholding?: string | null;
         }
 
         type Network = 'ach' | 'card' | 'stripe';
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the ReceivedDebit.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReversalDetails {
           /**
            * Time before which a ReceivedDebit can be reversed.