stripe 9.0.0 → 9.3.0

package/types/2020-08-27/Treasury/FinancialAccounts.d.ts

@@ -0,0 +1,833 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Treasury {
+      /**
+       * The FinancialAccount object.
+       */
+      interface FinancialAccount {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'treasury.financial_account';
+
+        /**
+         * The array of paths to active Features in the Features hash.
+         */
+        active_features: Array<FinancialAccount.ActiveFeature>;
+
+        /**
+         * Balance information for the FinancialAccount
+         */
+        balance: FinancialAccount.Balance;
+
+        /**
+         * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+         */
+        country: string;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * 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.
+         */
+        features?: Stripe.Treasury.FinancialAccountFeatures;
+
+        /**
+         * The set of credentials that resolve to a FinancialAccount.
+         */
+        financial_addresses: Array<FinancialAccount.FinancialAddress>;
+
+        /**
+         * 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://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.
+         */
+        metadata: Stripe.Metadata | null;
+
+        /**
+         * The array of paths to pending Features in the Features hash.
+         */
+        pending_features: Array<FinancialAccount.PendingFeature>;
+
+        /**
+         * The set of functionalities that the platform can restrict on the FinancialAccount.
+         */
+        platform_restrictions: FinancialAccount.PlatformRestrictions | null;
+
+        /**
+         * The array of paths to restricted Features in the Features hash.
+         */
+        restricted_features: Array<FinancialAccount.RestrictedFeature>;
+
+        /**
+         * The enum specifying what state the account is in.
+         */
+        status: FinancialAccount.Status;
+
+        status_details: FinancialAccount.StatusDetails;
+
+        /**
+         * The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+         */
+        supported_currencies: Array<string>;
+      }
+
+      namespace FinancialAccount {
+        type ActiveFeature =
+          | 'card_issuing'
+          | 'deposit_insurance'
+          | 'financial_addresses.aba'
+          | 'inbound_transfers.ach'
+          | 'intra_stripe_flows'
+          | 'outbound_payments.ach'
+          | 'outbound_payments.us_domestic_wire'
+          | 'outbound_transfers.ach'
+          | 'outbound_transfers.us_domestic_wire'
+          | 'remote_deposit_capture';
+
+        interface Balance {
+          /**
+           * Funds the user can spend right now.
+           */
+          cash: {
+            [key: string]: number;
+          };
+
+          /**
+           * Funds not spendable yet, but will become available at a later time.
+           */
+          inbound_pending: {
+            [key: string]: number;
+          };
+
+          /**
+           * Funds in the account, but not spendable because they are being held for pending outbound flows.
+           */
+          outbound_pending: {
+            [key: string]: number;
+          };
+        }
+
+        interface FinancialAddress {
+          /**
+           * ABA Records contain U.S. bank account details per the ABA format.
+           */
+          aba?: FinancialAddress.Aba;
+
+          /**
+           * The list of networks that the address supports
+           */
+          supported_networks?: Array<FinancialAddress.SupportedNetwork>;
+
+          /**
+           * The type of financial address
+           */
+          type: 'aba';
+        }
+
+        namespace FinancialAddress {
+          interface Aba {
+            /**
+             * The name of the person or business that owns the bank account.
+             */
+            account_holder_name: string;
+
+            /**
+             * The account number.
+             */
+            account_number: string | null;
+
+            /**
+             * The last four characters of the account number.
+             */
+            account_number_last4: string;
+
+            /**
+             * Name of the bank.
+             */
+            bank_name: string;
+
+            /**
+             * Routing number for the account.
+             */
+            routing_number: string;
+          }
+
+          type SupportedNetwork = 'ach' | 'us_domestic_wire';
+        }
+
+        type PendingFeature =
+          | 'card_issuing'
+          | 'deposit_insurance'
+          | 'financial_addresses.aba'
+          | 'inbound_transfers.ach'
+          | 'intra_stripe_flows'
+          | 'outbound_payments.ach'
+          | 'outbound_payments.us_domestic_wire'
+          | 'outbound_transfers.ach'
+          | 'outbound_transfers.us_domestic_wire'
+          | 'remote_deposit_capture';
+
+        interface PlatformRestrictions {
+          /**
+           * Restricts all inbound money movement.
+           */
+          inbound_flows: PlatformRestrictions.InboundFlows | null;
+
+          /**
+           * Restricts all outbound money movement.
+           */
+          outbound_flows: PlatformRestrictions.OutboundFlows | null;
+        }
+
+        namespace PlatformRestrictions {
+          type InboundFlows = 'restricted' | 'unrestricted';
+
+          type OutboundFlows = 'restricted' | 'unrestricted';
+        }
+
+        type RestrictedFeature =
+          | 'card_issuing'
+          | 'deposit_insurance'
+          | 'financial_addresses.aba'
+          | 'inbound_transfers.ach'
+          | 'intra_stripe_flows'
+          | 'outbound_payments.ach'
+          | 'outbound_payments.us_domestic_wire'
+          | 'outbound_transfers.ach'
+          | 'outbound_transfers.us_domestic_wire'
+          | 'remote_deposit_capture';
+
+        type Status = 'closed' | 'open';
+
+        interface StatusDetails {
+          /**
+           * Details related to the closure of this FinancialAccount
+           */
+          closed: StatusDetails.Closed | null;
+        }
+
+        namespace StatusDetails {
+          interface Closed {
+            /**
+             * The array that contains reasons for a FinancialAccount closure.
+             */
+            reasons: Array<Closed.Reason>;
+          }
+
+          namespace Closed {
+            type Reason = 'account_rejected' | 'closed_by_platform' | 'other';
+          }
+        }
+      }
+
+      interface FinancialAccountCreateParams {
+        /**
+         * The currencies the FinancialAccount can hold a balance in.
+         */
+        supported_currencies: Array<string>;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.
+         */
+        features?: FinancialAccountCreateParams.Features;
+
+        /**
+         * 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;
+
+        /**
+         * The set of functionalities that the platform can restrict on the FinancialAccount.
+         */
+        platform_restrictions?: FinancialAccountCreateParams.PlatformRestrictions;
+      }
+
+      namespace FinancialAccountCreateParams {
+        interface Features {
+          /**
+           * Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
+           */
+          deposit_insurance?: Features.DepositInsurance;
+
+          /**
+           * Contains Features that add FinancialAddresses to the FinancialAccount.
+           */
+          financial_addresses?: Features.FinancialAddresses;
+
+          /**
+           * Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
+           */
+          inbound_transfers?: Features.InboundTransfers;
+
+          /**
+           * Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
+           */
+          intra_stripe_flows?: Features.IntraStripeFlows;
+
+          /**
+           * Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
+           */
+          outbound_payments?: Features.OutboundPayments;
+
+          /**
+           * Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
+           */
+          outbound_transfers?: Features.OutboundTransfers;
+        }
+
+        namespace Features {
+          interface DepositInsurance {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+
+          interface FinancialAddresses {
+            /**
+             * Adds an ABA FinancialAddress to the FinancialAccount.
+             */
+            aba?: FinancialAddresses.Aba;
+          }
+
+          namespace FinancialAddresses {
+            interface Aba {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+          }
+
+          interface InboundTransfers {
+            /**
+             * Enables ACH Debits via the InboundTransfers API.
+             */
+            ach?: InboundTransfers.Ach;
+          }
+
+          namespace InboundTransfers {
+            interface Ach {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+          }
+
+          interface IntraStripeFlows {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+
+          interface OutboundPayments {
+            /**
+             * Enables ACH transfers via the OutboundPayments API.
+             */
+            ach?: OutboundPayments.Ach;
+
+            /**
+             * Enables US domestic wire tranfers via the OutboundPayments API.
+             */
+            us_domestic_wire?: OutboundPayments.UsDomesticWire;
+          }
+
+          namespace OutboundPayments {
+            interface Ach {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+
+            interface UsDomesticWire {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+          }
+
+          interface OutboundTransfers {
+            /**
+             * Enables ACH transfers via the OutboundTransfers API.
+             */
+            ach?: OutboundTransfers.Ach;
+
+            /**
+             * Enables US domestic wire tranfers via the OutboundTransfers API.
+             */
+            us_domestic_wire?: OutboundTransfers.UsDomesticWire;
+          }
+
+          namespace OutboundTransfers {
+            interface Ach {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+
+            interface UsDomesticWire {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+          }
+        }
+
+        interface PlatformRestrictions {
+          /**
+           * Restricts all inbound money movement.
+           */
+          inbound_flows?: PlatformRestrictions.InboundFlows;
+
+          /**
+           * Restricts all outbound money movement.
+           */
+          outbound_flows?: PlatformRestrictions.OutboundFlows;
+        }
+
+        namespace PlatformRestrictions {
+          type InboundFlows = 'restricted' | 'unrestricted';
+
+          type OutboundFlows = 'restricted' | 'unrestricted';
+        }
+      }
+
+      interface FinancialAccountRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FinancialAccountUpdateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.
+         */
+        features?: FinancialAccountUpdateParams.Features;
+
+        /**
+         * 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;
+
+        /**
+         * The set of functionalities that the platform can restrict on the FinancialAccount.
+         */
+        platform_restrictions?: FinancialAccountUpdateParams.PlatformRestrictions;
+      }
+
+      namespace FinancialAccountUpdateParams {
+        interface Features {
+          /**
+           * Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
+           */
+          deposit_insurance?: Features.DepositInsurance;
+
+          /**
+           * Contains Features that add FinancialAddresses to the FinancialAccount.
+           */
+          financial_addresses?: Features.FinancialAddresses;
+
+          /**
+           * Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
+           */
+          inbound_transfers?: Features.InboundTransfers;
+
+          /**
+           * Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
+           */
+          intra_stripe_flows?: Features.IntraStripeFlows;
+
+          /**
+           * Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
+           */
+          outbound_payments?: Features.OutboundPayments;
+
+          /**
+           * Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
+           */
+          outbound_transfers?: Features.OutboundTransfers;
+        }
+
+        namespace Features {
+          interface DepositInsurance {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+
+          interface FinancialAddresses {
+            /**
+             * Adds an ABA FinancialAddress to the FinancialAccount.
+             */
+            aba?: FinancialAddresses.Aba;
+          }
+
+          namespace FinancialAddresses {
+            interface Aba {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+          }
+
+          interface InboundTransfers {
+            /**
+             * Enables ACH Debits via the InboundTransfers API.
+             */
+            ach?: InboundTransfers.Ach;
+          }
+
+          namespace InboundTransfers {
+            interface Ach {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+          }
+
+          interface IntraStripeFlows {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+
+          interface OutboundPayments {
+            /**
+             * Enables ACH transfers via the OutboundPayments API.
+             */
+            ach?: OutboundPayments.Ach;
+
+            /**
+             * Enables US domestic wire tranfers via the OutboundPayments API.
+             */
+            us_domestic_wire?: OutboundPayments.UsDomesticWire;
+          }
+
+          namespace OutboundPayments {
+            interface Ach {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+
+            interface UsDomesticWire {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+          }
+
+          interface OutboundTransfers {
+            /**
+             * Enables ACH transfers via the OutboundTransfers API.
+             */
+            ach?: OutboundTransfers.Ach;
+
+            /**
+             * Enables US domestic wire tranfers via the OutboundTransfers API.
+             */
+            us_domestic_wire?: OutboundTransfers.UsDomesticWire;
+          }
+
+          namespace OutboundTransfers {
+            interface Ach {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+
+            interface UsDomesticWire {
+              /**
+               * Whether the FinancialAccount should have the Feature.
+               */
+              requested: boolean;
+            }
+          }
+        }
+
+        interface PlatformRestrictions {
+          /**
+           * Restricts all inbound money movement.
+           */
+          inbound_flows?: PlatformRestrictions.InboundFlows;
+
+          /**
+           * Restricts all outbound money movement.
+           */
+          outbound_flows?: PlatformRestrictions.OutboundFlows;
+        }
+
+        namespace PlatformRestrictions {
+          type InboundFlows = 'restricted' | 'unrestricted';
+
+          type OutboundFlows = 'restricted' | 'unrestricted';
+        }
+      }
+
+      interface FinancialAccountListParams extends PaginationParams {
+        created?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FinancialAccountRetrieveFeaturesParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FinancialAccountUpdateFeaturesParams {
+        /**
+         * Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
+         */
+        deposit_insurance?: FinancialAccountUpdateFeaturesParams.DepositInsurance;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Contains Features that add FinancialAddresses to the FinancialAccount.
+         */
+        financial_addresses?: FinancialAccountUpdateFeaturesParams.FinancialAddresses;
+
+        /**
+         * Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
+         */
+        inbound_transfers?: FinancialAccountUpdateFeaturesParams.InboundTransfers;
+
+        /**
+         * Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
+         */
+        intra_stripe_flows?: FinancialAccountUpdateFeaturesParams.IntraStripeFlows;
+
+        /**
+         * Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
+         */
+        outbound_payments?: FinancialAccountUpdateFeaturesParams.OutboundPayments;
+
+        /**
+         * Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
+         */
+        outbound_transfers?: FinancialAccountUpdateFeaturesParams.OutboundTransfers;
+      }
+
+      namespace FinancialAccountUpdateFeaturesParams {
+        interface DepositInsurance {
+          /**
+           * Whether the FinancialAccount should have the Feature.
+           */
+          requested: boolean;
+        }
+
+        interface FinancialAddresses {
+          /**
+           * Adds an ABA FinancialAddress to the FinancialAccount.
+           */
+          aba?: FinancialAddresses.Aba;
+        }
+
+        namespace FinancialAddresses {
+          interface Aba {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+        }
+
+        interface InboundTransfers {
+          /**
+           * Enables ACH Debits via the InboundTransfers API.
+           */
+          ach?: InboundTransfers.Ach;
+        }
+
+        namespace InboundTransfers {
+          interface Ach {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+        }
+
+        interface IntraStripeFlows {
+          /**
+           * Whether the FinancialAccount should have the Feature.
+           */
+          requested: boolean;
+        }
+
+        interface OutboundPayments {
+          /**
+           * Enables ACH transfers via the OutboundPayments API.
+           */
+          ach?: OutboundPayments.Ach;
+
+          /**
+           * Enables US domestic wire tranfers via the OutboundPayments API.
+           */
+          us_domestic_wire?: OutboundPayments.UsDomesticWire;
+        }
+
+        namespace OutboundPayments {
+          interface Ach {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+
+          interface UsDomesticWire {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+        }
+
+        interface OutboundTransfers {
+          /**
+           * Enables ACH transfers via the OutboundTransfers API.
+           */
+          ach?: OutboundTransfers.Ach;
+
+          /**
+           * Enables US domestic wire tranfers via the OutboundTransfers API.
+           */
+          us_domestic_wire?: OutboundTransfers.UsDomesticWire;
+        }
+
+        namespace OutboundTransfers {
+          interface Ach {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+
+          interface UsDomesticWire {
+            /**
+             * Whether the FinancialAccount should have the Feature.
+             */
+            requested: boolean;
+          }
+        }
+      }
+
+      class FinancialAccountsResource {
+        /**
+         * Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.
+         */
+        create(
+          params: FinancialAccountCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccount>>;
+
+        /**
+         * Retrieves the details of a FinancialAccount.
+         */
+        retrieve(
+          id: string,
+          params?: FinancialAccountRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccount>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccount>>;
+
+        /**
+         * Updates the details of a FinancialAccount.
+         */
+        update(
+          id: string,
+          params?: FinancialAccountUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccount>>;
+
+        /**
+         * Returns a list of FinancialAccounts.
+         */
+        list(
+          params?: FinancialAccountListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Treasury.FinancialAccount>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Treasury.FinancialAccount>;
+
+        /**
+         * Retrieves Features information associated with the FinancialAccount.
+         */
+        retrieveFeatures(
+          id: string,
+          params?: FinancialAccountRetrieveFeaturesParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccountFeatures>>;
+        retrieveFeatures(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccountFeatures>>;
+
+        /**
+         * Updates the Features associated with a FinancialAccount.
+         */
+        updateFeatures(
+          id: string,
+          params?: FinancialAccountUpdateFeaturesParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccountFeatures>>;
+        updateFeatures(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.FinancialAccountFeatures>>;
+      }
+    }
+  }
+}