stripe 22.2.0 → 22.3.0-alpha.2

package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts

@@ -0,0 +1,417 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { V2Amount } from './../V2Amounts.js';
+import { MetadataParam, Metadata } from '../../../shared.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
+import { StatementResource } from './FinancialAccounts/Statements.js';
+import { Stripe } from '../../../stripe.core.js';
+export declare class FinancialAccountResource extends StripeResource {
+    private readonly stripe;
+    statements: StatementResource;
+    constructor(stripe: Stripe);
+    /**
+     * Lists FinancialAccounts in this compartment.
+     */
+    list(params?: V2.MoneyManagement.FinancialAccountListParams, options?: RequestOptions): V2ListPromise<FinancialAccount>;
+    /**
+     * Creates a new FinancialAccount.
+     * @throws Stripe.AlreadyExistsError
+     * @throws Stripe.FeatureNotEnabledError
+     */
+    create(params: V2.MoneyManagement.FinancialAccountCreateParams, options?: RequestOptions): Promise<Response<FinancialAccount>>;
+    /**
+     * Retrieves the details of an existing FinancialAccount.
+     */
+    retrieve(id: string, params?: V2.MoneyManagement.FinancialAccountRetrieveParams, options?: RequestOptions): Promise<Response<FinancialAccount>>;
+    /**
+     * Updates an existing FinancialAccount.
+     */
+    update(id: string, params?: V2.MoneyManagement.FinancialAccountUpdateParams, options?: RequestOptions): Promise<Response<FinancialAccount>>;
+    /**
+     * Closes a FinancialAccount with or without forwarding settings.
+     * @throws Stripe.NonZeroBalanceError
+     */
+    close(id: string, params?: V2.MoneyManagement.FinancialAccountCloseParams, options?: RequestOptions): Promise<Response<FinancialAccount>>;
+}
+export interface FinancialAccount {
+    /**
+     * 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.financial_account';
+    /**
+     * If this is a `accrued_fees` FinancialAccount, this hash include details specific to `accrued_fees` FinancialAccount.
+     */
+    accrued_fees?: V2.MoneyManagement.FinancialAccount.AccruedFees;
+    /**
+     * Multi-currency balance of this FinancialAccount, split by availability state. Each balance is represented as a hash where the key is the three-letter ISO currency code, in lowercase, and the value is the amount for that currency.
+     */
+    balance: V2.MoneyManagement.FinancialAccount.Balance;
+    /**
+     * Open Enum. Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
+     */
+    country: string;
+    /**
+     * Time at which the object was created.
+     */
+    created: string;
+    /**
+     * A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
+     */
+    display_name?: 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;
+    /**
+     * If this is a managed FinancialAccount, `managed_by` indicates the product that created and manages this FinancialAccount. For managed FinancialAccounts,
+     * creation of money management resources can only be orchestrated by the managing product.
+     */
+    managed_by?: V2.MoneyManagement.FinancialAccount.ManagedBy;
+    /**
+     * Metadata associated with the FinancialAccount.
+     */
+    metadata?: Metadata;
+    /**
+     * If this is a `multiprocessor_settlement` FinancialAccount, this hash includes details specific to `multiprocessor_settlement` FinancialAccounts.
+     */
+    multiprocessor_settlement?: V2.MoneyManagement.FinancialAccount.MultiprocessorSettlement;
+    /**
+     * If this is a `other` FinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected in `type`.
+     */
+    other?: V2.MoneyManagement.FinancialAccount.Other;
+    /**
+     * If this is a `payments` FinancialAccount, this hash include details specific to `payments` FinancialAccount.
+     */
+    payments?: V2.MoneyManagement.FinancialAccount.Payments;
+    /**
+     * Closed Enum. An enum representing the status of the FinancialAccount. This indicates whether or not the FinancialAccount can be used for any money movement flows.
+     */
+    status: V2.MoneyManagement.FinancialAccount.Status;
+    /**
+     * Additional details related to the status of the FinancialAccount.
+     */
+    status_details?: V2.MoneyManagement.FinancialAccount.StatusDetails;
+    /**
+     * If this is a `storage` FinancialAccount, this hash includes details specific to `storage` FinancialAccounts.
+     */
+    storage?: V2.MoneyManagement.FinancialAccount.Storage;
+    /**
+     * Type of the FinancialAccount. An additional hash is included on the FinancialAccount with a name matching this value.
+     * It contains additional information specific to the FinancialAccount type.
+     */
+    type: V2.MoneyManagement.FinancialAccount.Type;
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        namespace FinancialAccount {
+            interface AccruedFees {
+                /**
+                 * The currencies enabled for fee accrual on this FinancialAccount.
+                 */
+                currencies: Array<string>;
+                /**
+                 * Direction of fee accrual for this FinancialAccount.
+                 */
+                direction: AccruedFees.Direction;
+            }
+            interface Balance {
+                /**
+                 * Balance that can be used for money movement.
+                 */
+                available: {
+                    [key: string]: V2Amount;
+                };
+                /**
+                 * Balance of inbound funds that will later transition to the `available` balance.
+                 */
+                inbound_pending: {
+                    [key: string]: V2Amount;
+                };
+                /**
+                 * Balance of funds that are being used for a pending outbound money movement.
+                 */
+                outbound_pending: {
+                    [key: string]: V2Amount;
+                };
+            }
+            interface ManagedBy {
+                /**
+                 * Enum describing the Stripe product that is managing this FinancialAccount.
+                 */
+                type: 'multiprocessor_settlement';
+            }
+            interface MultiprocessorSettlement {
+                /**
+                 * Settlement currencies enabled for this FinancialAccount.
+                 */
+                settlement_currencies: Array<string>;
+            }
+            interface Other {
+                /**
+                 * The type of the FinancialAccount, represented as a string. Upgrade your API version to see the type reflected in `financial_account.type`.
+                 */
+                type: string;
+            }
+            interface Payments {
+                /**
+                 * The balance of the `payments` FinancialAccount is a mix of payment processing and stored value funds, and this field
+                 * describes the breakdown between the two. The sum will match the balance of the FinancialAccount.
+                 */
+                balance_by_funds_type?: Payments.BalanceByFundsType;
+                /**
+                 * The currency that non-settlement currency payments will be converted to.
+                 */
+                default_currency: string;
+                /**
+                 * Settlement currencies enabled for this FinancialAccount. Payments in other currencies will be automatically converted to `default_currency`.
+                 */
+                settlement_currencies: Array<string>;
+                /**
+                 * Describes the available balance when it was projected.
+                 */
+                starting_balance?: Payments.StartingBalance;
+            }
+            type Status = 'closed' | 'open' | 'pending';
+            interface StatusDetails {
+                /**
+                 * Details related to the closed state of the FinancialAccount.
+                 */
+                closed?: StatusDetails.Closed;
+            }
+            interface Storage {
+                /**
+                 * The usage type for funds in this FinancialAccount. Can be used to specify that the funds are for Consumer activity.
+                 */
+                funds_usage_type?: Storage.FundsUsageType;
+                /**
+                 * The currencies that this FinancialAccount can hold.
+                 */
+                holds_currencies: Array<string>;
+            }
+            type Type = 'accrued_fees' | 'multiprocessor_settlement' | 'other' | 'payments' | 'storage';
+            namespace AccruedFees {
+                type Direction = 'payable' | 'receivable';
+            }
+            namespace Payments {
+                interface BalanceByFundsType {
+                    /**
+                     * Payment processing funds are those that are received for goods or services and may only be used for payouts to self. These funds may be converted to stored value funds.
+                     */
+                    payment_processing: BalanceByFundsType.PaymentProcessing;
+                    /**
+                     * Stored value funds may be used for either payouts to self or payments to others.
+                     */
+                    stored_value: BalanceByFundsType.StoredValue;
+                }
+                interface StartingBalance {
+                    /**
+                     * When the balance was projected.
+                     */
+                    at: string;
+                    /**
+                     * The available balance at the time when the balance was projected.
+                     */
+                    available: {
+                        [key: string]: V2Amount;
+                    };
+                }
+                namespace BalanceByFundsType {
+                    interface PaymentProcessing {
+                        /**
+                         * Balance that can be used for money movement.
+                         */
+                        available: {
+                            [key: string]: V2Amount;
+                        };
+                        /**
+                         * Balance of inbound funds that will later transition to the `available` balance.
+                         */
+                        inbound_pending: {
+                            [key: string]: V2Amount;
+                        };
+                        /**
+                         * Balance of funds that are being used for a pending outbound money movement.
+                         */
+                        outbound_pending: {
+                            [key: string]: V2Amount;
+                        };
+                    }
+                    interface StoredValue {
+                        /**
+                         * Balance that can be used for money movement.
+                         */
+                        available: {
+                            [key: string]: V2Amount;
+                        };
+                        /**
+                         * Balance of inbound funds that will later transition to the `available` balance.
+                         */
+                        inbound_pending: {
+                            [key: string]: V2Amount;
+                        };
+                        /**
+                         * Balance of funds that are being used for a pending outbound money movement.
+                         */
+                        outbound_pending: {
+                            [key: string]: V2Amount;
+                        };
+                    }
+                }
+            }
+            namespace StatusDetails {
+                interface Closed {
+                    /**
+                     * The forwarding settings for the closed FinancialAccount.
+                     */
+                    forwarding_settings?: Closed.ForwardingSettings;
+                    /**
+                     * The reason the FinancialAccount was closed.
+                     */
+                    reason: Closed.Reason;
+                }
+                namespace Closed {
+                    interface ForwardingSettings {
+                        /**
+                         * The address to send forwarded payments to.
+                         */
+                        payment_method?: string;
+                        /**
+                         * The address to send forwarded payouts to.
+                         */
+                        payout_method?: string;
+                    }
+                    type Reason = 'account_closed' | 'closed_by_platform' | 'other';
+                }
+            }
+            namespace Storage {
+                type FundsUsageType = 'business' | 'consumer';
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface FinancialAccountCreateParams {
+            /**
+             * The type of FinancialAccount to create.
+             */
+            type: 'storage';
+            /**
+             * A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
+             */
+            display_name?: string;
+            /**
+             * Metadata associated with the FinancialAccount.
+             */
+            metadata?: MetadataParam;
+            /**
+             * Parameters specific to creating `storage` type FinancialAccounts.
+             */
+            storage?: FinancialAccountCreateParams.Storage;
+        }
+        namespace FinancialAccountCreateParams {
+            interface Storage {
+                /**
+                 * The usage type for funds in this FinancialAccount. Can be used to specify that the funds are for Consumer activity.
+                 */
+                funds_usage_type?: Storage.FundsUsageType;
+                /**
+                 * The currencies that this FinancialAccount can hold.
+                 */
+                holds_currencies: Array<string>;
+            }
+            namespace Storage {
+                type FundsUsageType = 'business' | 'consumer';
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface FinancialAccountRetrieveParams {
+            /**
+             * Additional fields to include in the response.
+             */
+            include?: Array<'payments.balance_by_funds_type'>;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface FinancialAccountUpdateParams {
+            /**
+             * A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
+             */
+            display_name?: string;
+            /**
+             * Metadata associated with the FinancialAccount.
+             */
+            metadata?: MetadataParam;
+            /**
+             * Parameters for updating storage-specific fields on the FinancialAccount.
+             */
+            storage?: FinancialAccountUpdateParams.Storage;
+        }
+        namespace FinancialAccountUpdateParams {
+            interface Storage {
+                /**
+                 * The currencies that this storage FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.
+                 * Adding currencies requires the corresponding holds_currencies storer capabilities to be enabled.
+                 * Removing currencies is not supported as of March 2026.
+                 */
+                holds_currencies?: Array<string>;
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface FinancialAccountListParams {
+            /**
+             * Additional fields to include in the response.
+             */
+            include?: Array<'payments.balance_by_funds_type'>;
+            /**
+             * The page limit.
+             */
+            limit?: number;
+            /**
+             * The status of the FinancialAccount to filter by. By default, closed FinancialAccounts are not returned.
+             */
+            status?: FinancialAccountListParams.Status;
+            /**
+             * Filter for FinancialAccount `type`. By default, FinancialAccounts of any `type` are returned.
+             */
+            types?: Array<FinancialAccountListParams.Type>;
+        }
+        namespace FinancialAccountListParams {
+            type Status = 'closed' | 'open' | 'pending';
+            type Type = 'accrued_fees' | 'multiprocessor_settlement' | 'payments' | 'storage';
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface FinancialAccountCloseParams {
+            /**
+             * The addresses to forward any incoming transactions to.
+             */
+            forwarding_settings?: FinancialAccountCloseParams.ForwardingSettings;
+        }
+        namespace FinancialAccountCloseParams {
+            interface ForwardingSettings {
+                /**
+                 * The address to send forwarded payments to.
+                 */
+                payment_method?: string;
+                /**
+                 * The address to send forwarded payouts to.
+                 */
+                payout_method?: string;
+            }
+        }
+    }
+}

package/esm/resources/V2/MoneyManagement/FinancialAccounts.js

@@ -0,0 +1,46 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../../StripeResource.js';
+import { StatementResource } from './FinancialAccounts/Statements.js';
+export class FinancialAccountResource extends StripeResource {
+    constructor(stripe) {
+        super(stripe);
+        this.stripe = stripe;
+        this.statements = new StatementResource(stripe);
+    }
+    /**
+     * Lists FinancialAccounts in this compartment.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/money_management/financial_accounts', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Creates a new FinancialAccount.
+     * @throws Stripe.AlreadyExistsError
+     * @throws Stripe.FeatureNotEnabledError
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/money_management/financial_accounts', params, options);
+    }
+    /**
+     * Retrieves the details of an existing FinancialAccount.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/money_management/financial_accounts/${id}`, params, options);
+    }
+    /**
+     * Updates an existing FinancialAccount.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v2/money_management/financial_accounts/${id}`, params, options);
+    }
+    /**
+     * Closes a FinancialAccount with or without forwarding settings.
+     * @throws Stripe.NonZeroBalanceError
+     */
+    close(id, params, options) {
+        return this._makeRequest('POST', `/v2/money_management/financial_accounts/${id}/close`, params, options);
+    }
+}
+//# sourceMappingURL=FinancialAccounts.js.map

package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FinancialAccounts.js","sourceRoot":"","sources":["../../../../src/resources/V2/MoneyManagement/FinancialAccounts.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAI1D,OAAO,EAAC,iBAAiB,EAAC,MAAM,mCAAmC,CAAC;AAEpE,MAAM,OAAO,wBAAyB,SAAQ,cAAc;IAG1D,YAA6B,MAAc;QACzC,KAAK,CAAC,MAAM,CAAC,CAAC;QADa,WAAM,GAAN,MAAM,CAAQ;QAEzC,IAAI,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IACD;;OAEG;IACH,IAAI,CACF,MAAsD,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,yCAAyC,EACzC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,MAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,yCAAyC,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA0D,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,2CAA2C,EAAE,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAwD,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,2CAA2C,EAAE,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,KAAK,CACH,EAAU,EACV,MAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,2CAA2C,EAAE,QAAQ,EACrD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}