stripe 18.4.0-beta.2 → 18.5.0-beta.1

package/types/V2/Core/AccountLinksResource.d.ts

@@ -37,9 +37,14 @@ declare module 'stripe' {
           namespace UseCase {
             interface AccountOnboarding {
               /**
-               * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
+               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
                */
-              configurations: Array<'recipient'>;
+              collection_options?: AccountOnboarding.CollectionOptions;
+
+              /**
+               * Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
+               */
+              configurations: Array<AccountOnboarding.Configuration>;
 
               /**
                * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
@@ -52,11 +57,42 @@ declare module 'stripe' {
               return_url?: string;
             }
 
+            namespace AccountOnboarding {
+              interface CollectionOptions {
+                /**
+                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
+                 */
+                fields?: CollectionOptions.Fields;
+
+                /**
+                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
+                 */
+                future_requirements?: CollectionOptions.FutureRequirements;
+              }
+
+              namespace CollectionOptions {
+                type Fields = 'currently_due' | 'eventually_due';
+
+                type FutureRequirements = 'include' | 'omit';
+              }
+
+              type Configuration =
+                | 'customer'
+                | 'merchant'
+                | 'recipient'
+                | 'storer';
+            }
+
             interface AccountUpdate {
+              /**
+               * Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
+               */
+              collection_options?: AccountUpdate.CollectionOptions;
+
               /**
                * Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
                */
-              configurations: Array<'recipient'>;
+              configurations: Array<AccountUpdate.Configuration>;
 
               /**
                * The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
@@ -69,6 +105,32 @@ declare module 'stripe' {
               return_url?: string;
             }
 
+            namespace AccountUpdate {
+              interface CollectionOptions {
+                /**
+                 * Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
+                 */
+                fields?: CollectionOptions.Fields;
+
+                /**
+                 * Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
+                 */
+                future_requirements?: CollectionOptions.FutureRequirements;
+              }
+
+              namespace CollectionOptions {
+                type Fields = 'currently_due' | 'eventually_due';
+
+                type FutureRequirements = 'include' | 'omit';
+              }
+
+              type Configuration =
+                | 'customer'
+                | 'merchant'
+                | 'recipient'
+                | 'storer';
+            }
+
             type Type = 'account_onboarding' | 'account_update';
           }
         }

package/types/V2/Core/Accounts.d.ts

@@ -4990,6 +4990,11 @@ declare module 'stripe' {
                  * Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance).
                  */
                 account: TermsOfService.Account | null;
+
+                /**
+                 * Details on the Account's acceptance of Treasury-specific terms of service.
+                 */
+                storer: TermsOfService.Storer | null;
               }
 
               namespace TermsOfService {
@@ -5009,6 +5014,23 @@ declare module 'stripe' {
                    */
                   user_agent: string | null;
                 }
+
+                interface Storer {
+                  /**
+                   * The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+                   */
+                  date: string | null;
+
+                  /**
+                   * The IP address from which the Account's representative accepted the terms of service.
+                   */
+                  ip: string | null;
+
+                  /**
+                   * The user agent of the browser from which the Account's representative accepted the terms of service.
+                   */
+                  user_agent: string | null;
+                }
               }
             }
 

package/types/V2/Core/AccountsResource.d.ts

@@ -1834,6 +1834,11 @@ declare module 'stripe' {
                  * Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance).
                  */
                 account?: TermsOfService.Account;
+
+                /**
+                 * Details on the Account's acceptance of Treasury-specific terms of service.
+                 */
+                storer?: TermsOfService.Storer;
               }
 
               namespace TermsOfService {
@@ -1853,6 +1858,23 @@ declare module 'stripe' {
                    */
                   user_agent?: string;
                 }
+
+                interface Storer {
+                  /**
+                   * The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+                   */
+                  date: string;
+
+                  /**
+                   * The IP address from which the Account's representative accepted the terms of service.
+                   */
+                  ip: string;
+
+                  /**
+                   * The user agent of the browser from which the Account's representative accepted the terms of service.
+                   */
+                  user_agent?: string;
+                }
               }
             }
 
@@ -7092,6 +7114,11 @@ declare module 'stripe' {
                  * Details on the Account's acceptance of the [Stripe Services Agreement](https://docs.stripe.com/connect/updating-accounts#tos-acceptance).
                  */
                 account?: TermsOfService.Account;
+
+                /**
+                 * Details on the Account's acceptance of Treasury-specific terms of service.
+                 */
+                storer?: TermsOfService.Storer;
               }
 
               namespace TermsOfService {
@@ -7111,6 +7138,23 @@ declare module 'stripe' {
                    */
                   user_agent?: string;
                 }
+
+                interface Storer {
+                  /**
+                   * The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+                   */
+                  date?: string;
+
+                  /**
+                   * The IP address from which the Account's representative accepted the terms of service.
+                   */
+                  ip?: string;
+
+                  /**
+                   * The user agent of the browser from which the Account's representative accepted the terms of service.
+                   */
+                  user_agent?: string;
+                }
               }
             }
 

package/types/V2/EventTypes.d.ts

@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe.V2 {
     export type Event =
       | Stripe.Events.V2CoreAccountIncludingRequirementsUpdatedEvent
-      | Stripe.Events.V2CoreAccountLinkCompletedEvent
+      | Stripe.Events.V2CoreAccountLinkReturnedEvent
       | Stripe.Events.V2CoreAccountClosedEvent
       | Stripe.Events.V2CoreAccountCreatedEvent
       | Stripe.Events.V2CoreAccountUpdatedEvent
@@ -35,7 +35,6 @@ declare module 'stripe' {
       | Stripe.Events.V2MoneyManagementInboundTransferBankDebitReturnedEvent
       | Stripe.Events.V2MoneyManagementInboundTransferBankDebitSucceededEvent
       | Stripe.Events.V2CoreEventDestinationPingEvent
-      | Stripe.Events.V2OffSessionPaymentRequiresCaptureEvent
       | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
       | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
       | Stripe.Events.V2PaymentsOffSessionPaymentCanceledEvent
@@ -54,6 +53,7 @@ declare module 'stripe' {
       | Stripe.Events.V2MoneyManagementOutboundTransferPostedEvent
       | Stripe.Events.V2MoneyManagementOutboundTransferReturnedEvent
       | Stripe.Events.V2MoneyManagementOutboundTransferUpdatedEvent
+      | Stripe.Events.V2MoneyManagementPayoutMethodUpdatedEvent
       | Stripe.Events.V2MoneyManagementReceivedCreditAvailableEvent
       | Stripe.Events.V2MoneyManagementReceivedCreditFailedEvent
       | Stripe.Events.V2MoneyManagementReceivedCreditReturnedEvent
@@ -83,13 +83,13 @@ declare module 'stripe' {
     /**
      * Occurs when the generated AccountLink is completed.
      */
-    export interface V2CoreAccountLinkCompletedEvent extends V2.EventBase {
-      type: 'v2.core.account_link.completed';
+    export interface V2CoreAccountLinkReturnedEvent extends V2.EventBase {
+      type: 'v2.core.account_link.returned';
       // Retrieves data specific to this event.
-      data: V2CoreAccountLinkCompletedEvent.Data;
+      data: V2CoreAccountLinkReturnedEvent.Data;
     }
 
-    namespace V2CoreAccountLinkCompletedEvent {
+    namespace V2CoreAccountLinkReturnedEvent {
       export interface Data {
         /**
          * The ID of the v2 account.
@@ -99,7 +99,7 @@ declare module 'stripe' {
         /**
          * Configurations on the Account that was onboarded via the account link.
          */
-        configurations: Array<'recipient'>;
+        configurations: Array<Data.Configuration>;
 
         /**
          * Open Enum. The use case type of the account link that has been completed.
@@ -108,6 +108,12 @@ declare module 'stripe' {
       }
 
       namespace Data {
+        export type Configuration =
+          | 'customer'
+          | 'merchant'
+          | 'recipient'
+          | 'storer';
+
         export type UseCase = 'account_onboarding' | 'account_update';
       }
     }
@@ -808,19 +814,7 @@ declare module 'stripe' {
     }
 
     /**
-     * Off session payment requires capture event definition.
-     */
-    export interface V2OffSessionPaymentRequiresCaptureEvent
-      extends V2.EventBase {
-      type: 'v2.off_session_payment.requires_capture';
-      // Object containing the reference to API resource relevant to the event.
-      related_object: Event.RelatedObject;
-      // Retrieves the object associated with the event.
-      fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
-    }
-
-    /**
-     * Off session payment authorization attempt failed event definition.
+     * Sent after a failed authorization if there are still retries available on the OffSessionPayment.
      */
     export interface V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
       extends V2.EventBase {
@@ -832,7 +826,8 @@ declare module 'stripe' {
     }
 
     /**
-     * Off session payment authorization attempt started event definition.
+     * Sent when our internal scheduling system kicks off an attempt at authorization, whether it's a
+     * retry or an initial authorization.
      */
     export interface V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
       extends V2.EventBase {
@@ -844,7 +839,7 @@ declare module 'stripe' {
     }
 
     /**
-     * Off session payment canceled event definition.
+     * Sent immediately following a user's call to the Off-Session Payments cancel endpoint.
      */
     export interface V2PaymentsOffSessionPaymentCanceledEvent
       extends V2.EventBase {
@@ -856,7 +851,7 @@ declare module 'stripe' {
     }
 
     /**
-     * Off session payment created event definition.
+     * Sent immediately following a user's call to the Off-Session Payments create endpoint.
      */
     export interface V2PaymentsOffSessionPaymentCreatedEvent
       extends V2.EventBase {
@@ -868,7 +863,7 @@ declare module 'stripe' {
     }
 
     /**
-     * Off session payment failed event definition.
+     * Sent after a failed authorization if there are no retries remaining, or if the failure is unretryable.
      */
     export interface V2PaymentsOffSessionPaymentFailedEvent
       extends V2.EventBase {
@@ -880,7 +875,7 @@ declare module 'stripe' {
     }
 
     /**
-     * Off session payment succeeded event definition.
+     * Sent immediately after a successful authorization.
      */
     export interface V2PaymentsOffSessionPaymentSucceededEvent
       extends V2.EventBase {
@@ -1035,6 +1030,18 @@ declare module 'stripe' {
       fetchRelatedObject(): Promise<V2.MoneyManagement.OutboundTransfer>;
     }
 
+    /**
+     * Occurs when a PayoutMethod is updated.
+     */
+    export interface V2MoneyManagementPayoutMethodUpdatedEvent
+      extends V2.EventBase {
+      type: 'v2.money_management.payout_method.updated';
+      // Object containing the reference to API resource relevant to the event.
+      related_object: Event.RelatedObject;
+      // Retrieves the object associated with the event.
+      fetchRelatedObject(): Promise<V2.MoneyManagement.PayoutMethod>;
+    }
+
     /**
      * Occurs when a ReceivedCredit's funds are received and are available in your balance.
      */

package/types/V2/MoneyManagement/PayoutMethods.d.ts

@@ -70,6 +70,11 @@ declare module 'stripe' {
              */
             archived: boolean;
 
+            /**
+             * The type of bank account (checking or savings).
+             */
+            bank_account_type: BankAccount.BankAccountType;
+
             /**
              * The name of the bank this bank account is in. This field is populated automatically by Stripe.
              */
@@ -101,6 +106,10 @@ declare module 'stripe' {
             supported_currencies: Array<string>;
           }
 
+          namespace BankAccount {
+            type BankAccountType = 'checking' | 'savings';
+          }
+
           interface Card {
             /**
              * Whether the PayoutMethodCard object was archived. PayoutMethodCard objects can be archived through

package/types/V2/Payments/OffSessionPayments.d.ts

@@ -5,11 +5,11 @@ declare module 'stripe' {
     namespace V2 {
       namespace Payments {
         /**
-         * Off-session payment resource.
+         * OffSessionPayment resource.
          */
         interface OffSessionPayment {
           /**
-           * ID of the OSP.
+           * Unique identifier for the object..
            */
           id: string;
 
@@ -19,37 +19,38 @@ declare module 'stripe' {
           object: 'v2.payments.off_session_payment';
 
           /**
-           * The amount you requested to be collected on the OSP upon creation.
+           * The “presentment amount” to be collected from the customer.
            */
           amount_requested: Amount;
 
           /**
-           * The frequency of the underlying payment that this OSP represents.
+           * The frequency of the underlying payment.
            */
           cadence: OffSessionPayment.Cadence;
 
           /**
-           * ID of owning compartment.
+           * ID of the owning compartment.
            */
           compartment_id: string;
 
           /**
-           * Timestamp of creation.
+           * Creation time of the OffSessionPayment. Represented as a RFC 3339 date & time UTC
+           * value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
            */
           created: string;
 
           /**
-           * Customer owning the supplied payment method.
+           * ID of the Customer to which this OffSessionPayment belongs.
            */
           customer: string;
 
           /**
-           * Reason why the OSP failed.
+           * The reason why the OffSessionPayment failed.
            */
           failure_reason: OffSessionPayment.FailureReason | null;
 
           /**
-           * Last error returned by the financial partner for a failed authorization.
+           * The payment error encountered in the previous attempt to authorize the payment.
            */
           last_authorization_attempt_error: string | null;
 
@@ -59,57 +60,66 @@ declare module 'stripe' {
           latest_payment_attempt_record: string | null;
 
           /**
-           * True if the txn is livemode, false otherwise.
+           * Has the value true if the object exists in live mode or the value false if the object exists in test mode.
            */
           livemode: boolean;
 
           /**
-           * Metadata you provided.
+           * Set of [key-value pairs](https://docs.corp.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. Learn more about
+           * [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
            */
           metadata: Stripe.Metadata;
 
           /**
-           * OBO, same as on the PI.
+           * The account (if any) for which the funds of the OffSessionPayment are intended.
            */
           on_behalf_of: string | null;
 
           /**
-           * ID of payment method.
+           * ID of the payment method used in this OffSessionPayment.
            */
           payment_method: string;
 
           /**
-           * Payment record associated with the OSP. consistent across attempts.
+           * Payment record associated with the OffSessionPayment.
            */
           payment_record: string | null;
 
           /**
-           * Details about the OSP retries.
+           * Details about the OffSessionPayment retries.
            */
           retry_details: OffSessionPayment.RetryDetails;
 
           /**
-           * Statement descriptor you provided.
+           * Text that appears on the customer's statement as the statement descriptor for a
+           * non-card charge. This value overrides the account's default statement descriptor.
+           * For information about requirements, including the 22-character limit, see the
+           * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
            */
           statement_descriptor: string | null;
 
           /**
-           * Statement descriptor suffix you provided, similar to that on the PI.
+           * Provides information about a card charge. Concatenated to the account's
+           * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+           * to form the complete statement descriptor that appears on the customer's statement.
            */
           statement_descriptor_suffix: string | null;
 
           /**
-           * Status of the OSP.
+           * Status of this OffSessionPayment, one of `pending`, `pending_retry`, `processing`,
+           * `failed`, `canceled`, `requires_capture`, or `succeeded`.
            */
           status: OffSessionPayment.Status;
 
           /**
-           * Test clock to be used to advance the retry attempts.
+           * Test clock that can be used to advance the retry attempts in a sandbox.
            */
           test_clock: string | null;
 
           /**
-           * Instructions for the transfer to be made with this OSP after successful money movement.
+           * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
            */
           transfer_data: OffSessionPayment.TransferData | null;
         }
@@ -126,7 +136,7 @@ declare module 'stripe' {
             attempts: number;
 
             /**
-             * How you want Stripe to retry the payment.
+             * Indicates the strategy for how you want Stripe to retry the payment.
              */
             retry_strategy: RetryDetails.RetryStrategy;
           }
@@ -146,12 +156,19 @@ declare module 'stripe' {
 
           interface TransferData {
             /**
-             * Amount in minor units that you want to transfer.
+             * The amount transferred to the destination account. This transfer will occur
+             * automatically after the payment succeeds. If no amount is specified, by default
+             * the entire payment amount is transferred to the destination account. The amount
+             * must be less than or equal to the
+             * [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
+             * and must be a positive integer representing how much to transfer in the smallest
+             * currency unit (e.g., 100 cents to charge $1.00).
              */
             amount: number | null;
 
             /**
-             * ID of the connected account where you want money to go.
+             * The account (if any) that the payment is attributed to for tax reporting, and
+             * where funds from the payment are transferred to after payment success.
              */
             destination: string;
           }