stripe 19.2.0 → 19.3.0-alpha.1

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

@@ -0,0 +1,177 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * Use Transactions to view changes to your FinancialAccount balance over time. Every flow that moves money, such as OutboundPayments or ReceivedCredits, will have one or more Transactions that describes how the flow impacted your balance. Note that while the FinancialAccount balance will always be up to date, be aware that Transactions and TransactionEntries are created shortly after to reflect changes.
+         */
+        interface Transaction {
+          /**
+           * 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.money_management.transaction';
+
+          /**
+           * The amount of the Transaction.
+           */
+          amount: Amount;
+
+          /**
+           * The delta to the FinancialAccount's balance. The balance_impact for the Transaction is equal to sum of its
+           * TransactionEntries that have `effective_at`s in the past.
+           */
+          balance_impact: Transaction.BalanceImpact;
+
+          /**
+           * Open Enum. A descriptive category used to classify the Transaction.
+           */
+          category: Transaction.Category;
+
+          /**
+           * Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          created: string;
+
+          /**
+           * Indicates the FinancialAccount affected by this Transaction.
+           */
+          financial_account: string;
+
+          /**
+           * Details about the Flow object that created the Transaction.
+           */
+          flow: Transaction.Flow;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * Closed Enum. Current status of the Transaction.
+           * A Transaction is `pending` if either `balance_impact.inbound_pending` or `balance_impact.outbound_pending` is non-zero.
+           * A Transaction is `posted` if only `balance_impact.available` is non-zero.
+           * A Transaction is `void` if there is no balance impact.
+           * `posted` and `void` are terminal states, and no additional entries will be added to the Transaction.
+           */
+          status: Transaction.Status;
+
+          /**
+           * Timestamps for when the Transaction transitioned to a particular status.
+           */
+          status_transitions: Transaction.StatusTransitions;
+        }
+
+        namespace Transaction {
+          interface BalanceImpact {
+            /**
+             * Impact to the available balance.
+             */
+            available: Amount;
+
+            /**
+             * Impact to the inbound_pending balance.
+             */
+            inbound_pending: Amount;
+
+            /**
+             * Impact to the outbound_pending balance.
+             */
+            outbound_pending: Amount;
+          }
+
+          type Category =
+            | 'adjustment'
+            | 'currency_conversion'
+            | 'inbound_transfer'
+            | 'outbound_payment'
+            | 'outbound_transfer'
+            | 'received_credit'
+            | 'received_debit'
+            | 'return'
+            | 'stripe_fee';
+
+          interface Flow {
+            /**
+             * Open Enum. Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.
+             */
+            type: Flow.Type;
+
+            /**
+             * If applicable, the ID of the Adjustment that created this Transaction.
+             */
+            adjustment?: string;
+
+            /**
+             * In the future, this will be the ID of the currency conversion that created this Transaction. For now, this field is always null.
+             */
+            currency_conversion?: string;
+
+            /**
+             * If applicable, the ID of the FeeTransaction that created this Transaction.
+             */
+            fee_transaction?: string;
+
+            /**
+             * If applicable, the ID of the InboundTransfer that created this Transaction.
+             */
+            inbound_transfer?: string;
+
+            /**
+             * If applicable, the ID of the OutboundPayment that created this Transaction.
+             */
+            outbound_payment?: string;
+
+            /**
+             * If applicable, the ID of the OutboundTransfer that created this Transaction.
+             */
+            outbound_transfer?: string;
+
+            /**
+             * If applicable, the ID of the ReceivedCredit that created this Transaction.
+             */
+            received_credit?: string;
+
+            /**
+             * If applicable, the ID of the ReceivedDebit that created this Transaction.
+             */
+            received_debit?: string;
+          }
+
+          namespace Flow {
+            type Type =
+              | 'adjustment'
+              | 'currency_conversion'
+              | 'fee_transaction'
+              | 'inbound_transfer'
+              | 'outbound_payment'
+              | 'outbound_transfer'
+              | 'received_credit'
+              | 'received_debit';
+          }
+
+          type Status = 'pending' | 'posted' | 'void';
+
+          interface StatusTransitions {
+            /**
+             * The time at which the Transaction became posted. Only present if status == posted.
+             */
+            posted_at?: string;
+
+            /**
+             * The time at which the Transaction became void. Only present if status == void.
+             */
+            void_at?: string;
+          }
+        }
+      }
+    }
+  }
+}

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,326 @@
+// 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 amount available to be captured.
+           */
+          amount_capturable?: Amount;
+
+          /**
+           * Provides industry-specific information about the amount.
+           */
+          amount_details?: OffSessionPayment.AmountDetails;
+
+          /**
+           * The “presentment amount” to be collected from the customer.
+           */
+          amount_requested: Amount;
+
+          /**
+           * The frequency of the underlying payment.
+           */
+          cadence: OffSessionPayment.Cadence;
+
+          /**
+           * Details about the capture configuration for the OffSessionPayment.
+           */
+          capture?: OffSessionPayment.Capture;
+
+          /**
+           * Whether the OffSessionPayment should be captured automatically or manually.
+           */
+          capture_method?: OffSessionPayment.CaptureMethod;
+
+          /**
+           * 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;
+
+          /**
+           * The payment error encountered in the previous attempt to authorize the payment.
+           */
+          last_authorization_attempt_error?: string;
+
+          /**
+           * Payment attempt record for the latest attempt, if one exists.
+           */
+          latest_payment_attempt_record?: string;
+
+          /**
+           * 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;
+
+          /**
+           * ID of the payment method used in this OffSessionPayment.
+           */
+          payment_method: string;
+
+          /**
+           * Payment record associated with the OffSessionPayment.
+           */
+          payment_record?: string;
+
+          /**
+           * Details about the payments orchestration configuration.
+           */
+          payments_orchestration: OffSessionPayment.PaymentsOrchestration;
+
+          /**
+           * 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;
+
+          /**
+           * 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;
+
+          /**
+           * 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;
+
+          /**
+           * 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;
+        }
+
+        namespace OffSessionPayment {
+          interface AmountDetails {
+            /**
+             * The amount the total transaction was discounted for.
+             */
+            discount_amount?: number;
+
+            /**
+             * A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
+             */
+            line_items: Array<AmountDetails.LineItem>;
+
+            /**
+             * Contains information about the shipping portion of the amount.
+             */
+            shipping?: AmountDetails.Shipping;
+
+            /**
+             * Contains information about the tax portion of the amount.
+             */
+            tax?: AmountDetails.Tax;
+          }
+
+          namespace AmountDetails {
+            interface LineItem {
+              /**
+               * The amount an item was discounted for. Positive integer.
+               */
+              discount_amount?: number;
+
+              /**
+               * Unique identifier of the product. At most 12 characters long.
+               */
+              product_code?: string;
+
+              /**
+               * Name of the product. At most 100 characters long.
+               */
+              product_name: string;
+
+              /**
+               * Number of items of the product. Positive integer.
+               */
+              quantity: number;
+
+              /**
+               * Contains information about the tax on the item.
+               */
+              tax?: LineItem.Tax;
+
+              /**
+               * Cost of the product. Non-negative integer.
+               */
+              unit_cost: number;
+            }
+
+            namespace LineItem {
+              interface Tax {
+                /**
+                 * Total portion of the amount that is for tax.
+                 */
+                total_tax_amount?: number;
+              }
+            }
+
+            interface Shipping {
+              /**
+               * Portion of the amount that is for shipping.
+               */
+              amount?: number;
+
+              /**
+               * The postal code that represents the shipping source.
+               */
+              from_postal_code?: string;
+
+              /**
+               * The postal code that represents the shipping destination.
+               */
+              to_postal_code?: string;
+            }
+
+            interface Tax {
+              /**
+               * Total portion of the amount that is for tax.
+               */
+              total_tax_amount?: number;
+            }
+          }
+
+          type Cadence = 'recurring' | 'unscheduled';
+
+          interface Capture {
+            /**
+             * The timestamp when this payment is no longer eligible to be captured.
+             */
+            capture_before?: string;
+
+            /**
+             * The method to use to capture the payment.
+             */
+            capture_method: Capture.CaptureMethod;
+          }
+
+          namespace Capture {
+            type CaptureMethod = 'automatic' | 'manual';
+          }
+
+          type CaptureMethod = 'automatic' | 'manual';
+
+          type FailureReason =
+            | 'authorization_expired'
+            | 'rejected_by_partner'
+            | 'retries_exhausted';
+
+          interface PaymentsOrchestration {
+            /**
+             * True when you want to enable payments orchestration for this off-session payment. False otherwise.
+             */
+            enabled: boolean;
+          }
+
+          interface RetryDetails {
+            /**
+             * Number of authorization attempts so far.
+             */
+            attempts: number;
+
+            /**
+             * The pre-configured retry policy to use for the payment.
+             */
+            retry_policy?: string;
+
+            /**
+             * Indicates the strategy for how you want Stripe to retry the payment.
+             */
+            retry_strategy: RetryDetails.RetryStrategy;
+          }
+
+          namespace RetryDetails {
+            type RetryStrategy = 'heuristic' | 'none' | 'scheduled' | '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;
+
+            /**
+             * 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;
+          }
+        }
+      }
+    }
+  }
+}