stripe 18.5.0 → 18.6.0-beta.1

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

@@ -0,0 +1,83 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface TransactionRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface TransactionListParams {
+          /**
+           * Filter for Transactions created at an exact time.
+           */
+          created?: string;
+
+          /**
+           * Filter for Transactions created after the specified timestamp.
+           */
+          created_gt?: string;
+
+          /**
+           * Filter for Transactions created at or after the specified timestamp.
+           */
+          created_gte?: string;
+
+          /**
+           * Filter for Transactions created before the specified timestamp.
+           */
+          created_lt?: string;
+
+          /**
+           * Filter for Transactions created at or before the specified timestamp.
+           */
+          created_lte?: string;
+
+          /**
+           * Filter for Transactions belonging to a FinancialAccount.
+           */
+          financial_account?: string;
+
+          /**
+           * Filter for Transactions corresponding to a Flow.
+           */
+          flow?: string;
+
+          /**
+           * The page limit.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace MoneyManagement {
+        class TransactionsResource {
+          /**
+           * Retrieves the details of a Transaction by ID.
+           */
+          retrieve(
+            id: string,
+            params?: TransactionRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.Transaction>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.Transaction>>;
+
+          /**
+           * Returns a list of Transactions that match the provided filters.
+           */
+          list(
+            params?: TransactionListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.Transaction>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.Transaction>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,179 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Payments {
+        /**
+         * OffSessionPayment resource.
+         */
+        interface OffSessionPayment {
+          /**
+           * Unique identifier for the object..
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.payments.off_session_payment';
+
+          /**
+           * The “presentment amount” to be collected from the customer.
+           */
+          amount_requested: Amount;
+
+          /**
+           * The frequency of the underlying payment.
+           */
+          cadence: OffSessionPayment.Cadence;
+
+          /**
+           * ID of the owning compartment.
+           */
+          compartment_id: string;
+
+          /**
+           * 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;
+
+          /**
+           * ID of the Customer to which this OffSessionPayment belongs.
+           */
+          customer: string;
+
+          /**
+           * The reason why the OffSessionPayment failed.
+           */
+          failure_reason: OffSessionPayment.FailureReason | null;
+
+          /**
+           * The payment error encountered in the previous attempt to authorize the payment.
+           */
+          last_authorization_attempt_error: string | null;
+
+          /**
+           * Payment attempt record for the latest attempt, if one exists.
+           */
+          latest_payment_attempt_record: string | null;
+
+          /**
+           * Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * 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;
+
+          /**
+           * The account (if any) for which the funds of the OffSessionPayment are intended.
+           */
+          on_behalf_of: string | null;
+
+          /**
+           * ID of the payment method used in this OffSessionPayment.
+           */
+          payment_method: string;
+
+          /**
+           * Payment record associated with the OffSessionPayment.
+           */
+          payment_record: string | null;
+
+          /**
+           * Details about the OffSessionPayment retries.
+           */
+          retry_details: OffSessionPayment.RetryDetails;
+
+          /**
+           * 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;
+
+          /**
+           * 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 this OffSessionPayment, one of `pending`, `pending_retry`, `processing`,
+           * `failed`, `canceled`, `requires_capture`, or `succeeded`.
+           */
+          status: OffSessionPayment.Status;
+
+          /**
+           * Test clock that can be used to advance the retry attempts in a sandbox.
+           */
+          test_clock: string | null;
+
+          /**
+           * 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;
+        }
+
+        namespace OffSessionPayment {
+          type Cadence = 'recurring' | 'unscheduled';
+
+          type FailureReason = 'rejected_by_partner' | 'retries_exhausted';
+
+          interface RetryDetails {
+            /**
+             * Number of authorization attempts so far.
+             */
+            attempts: number;
+
+            /**
+             * Indicates the strategy for how you want Stripe to retry the payment.
+             */
+            retry_strategy: RetryDetails.RetryStrategy;
+          }
+
+          namespace RetryDetails {
+            type RetryStrategy = 'none' | 'smart';
+          }
+
+          type Status =
+            | 'canceled'
+            | 'failed'
+            | 'pending'
+            | 'pending_retry'
+            | 'processing'
+            | 'requires_capture'
+            | 'succeeded';
+
+          interface TransferData {
+            /**
+             * 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;
+
+            /**
+             * 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;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,174 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Payments {
+        interface OffSessionPaymentCreateParams {
+          /**
+           * The “presentment amount” to be collected from the customer.
+           */
+          amount: Amount;
+
+          /**
+           * The frequency of the underlying payment.
+           */
+          cadence: OffSessionPaymentCreateParams.Cadence;
+
+          /**
+           * ID of the Customer to which this OffSessionPayment belongs.
+           */
+          customer: string;
+
+          /**
+           * 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.MetadataParam;
+
+          /**
+           * ID of the payment method used in this OffSessionPayment.
+           */
+          payment_method: string;
+
+          /**
+           * The account (if any) for which the funds of the OffSessionPayment are intended.
+           */
+          on_behalf_of?: string;
+
+          /**
+           * Details about the OffSessionPayment retries.
+           */
+          retry_details?: OffSessionPaymentCreateParams.RetryDetails;
+
+          /**
+           * 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;
+
+          /**
+           * 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;
+
+          /**
+           * Test clock that can be used to advance the retry attempts in a sandbox.
+           */
+          test_clock?: string;
+
+          /**
+           * 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?: OffSessionPaymentCreateParams.TransferData;
+        }
+
+        namespace OffSessionPaymentCreateParams {
+          type Cadence = 'recurring' | 'unscheduled';
+
+          interface RetryDetails {
+            /**
+             * Indicates the strategy for how you want Stripe to retry the payment.
+             */
+            retry_strategy: RetryDetails.RetryStrategy;
+          }
+
+          namespace RetryDetails {
+            type RetryStrategy = 'none' | 'smart';
+          }
+
+          interface TransferData {
+            /**
+             * 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;
+
+            /**
+             * 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;
+          }
+        }
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentRetrieveParams {}
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentListParams {
+          /**
+           * The page size limit. If not provided, the default is 20.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentCancelParams {}
+      }
+
+      namespace Payments {
+        class OffSessionPaymentsResource {
+          /**
+           * Creates an OffSessionPayment object.
+           */
+          create(
+            params: OffSessionPaymentCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+
+          /**
+           * Retrieves the details of an OffSessionPayment that has previously been created.
+           */
+          retrieve(
+            id: string,
+            params?: OffSessionPaymentRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+
+          /**
+           * Returns a list of OffSessionPayments matching a filter.
+           */
+          list(
+            params?: OffSessionPaymentListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
+
+          /**
+           * Cancel an OffSessionPayment that has previously been created.
+           */
+          cancel(
+            id: string,
+            params?: OffSessionPaymentCancelParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+          cancel(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/TestHelpers/FinancialAddressesResource.d.ts

@@ -0,0 +1,68 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace TestHelpers {
+        interface FinancialAddressCreditParams {
+          /**
+           * Object containing the amount value and currency to credit.
+           */
+          amount: Amount;
+
+          /**
+           * Open Enum. The network to use in simulating the funds flow. This will be the reflected in the resulting ReceivedCredit.
+           */
+          network: FinancialAddressCreditParams.Network;
+
+          /**
+           * String explaining funds flow. Use this field to populate the statement descriptor of the ReceivedCredit created as an eventual result of this simulation.
+           */
+          statement_descriptor?: string;
+        }
+
+        namespace FinancialAddressCreditParams {
+          type Network = 'ach' | 'fps' | 'rtp' | 'wire';
+        }
+      }
+
+      namespace TestHelpers {
+        interface FinancialAddressGenerateMicrodepositsParams {}
+      }
+
+      namespace TestHelpers {
+        class FinancialAddressesResource {
+          /**
+           * Simulate crediting a FinancialAddress in a Sandbox environment. This can be used to add virtual funds and increase your balance for testing.
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          credit(
+            id: string,
+            params: FinancialAddressCreditParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressCreditSimulation>
+          >;
+
+          /**
+           * Generates microdeposits for a FinancialAddress in a Sandbox environment.
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          generateMicrodeposits(
+            id: string,
+            params?: FinancialAddressGenerateMicrodepositsParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressGeneratedMicrodeposits>
+          >;
+          generateMicrodeposits(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressGeneratedMicrodeposits>
+          >;
+        }
+      }
+    }
+  }
+}