stripe 18.5.0 → 18.6.0-alpha.1

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

@@ -0,0 +1,331 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    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?: Stripe.MetadataParam;
+
+          /**
+           * Parameters specific to creating `storage` type FinancialAccounts.
+           */
+          storage?: FinancialAccountCreateParams.Storage;
+        }
+
+        namespace FinancialAccountCreateParams {
+          interface Storage {
+            /**
+             * The currencies that this FinancialAccount can hold.
+             */
+            holds_currencies: Array<Storage.HoldsCurrency>;
+          }
+
+          namespace Storage {
+            type HoldsCurrency =
+              | 'aed'
+              | 'afn'
+              | 'all'
+              | 'amd'
+              | 'ang'
+              | 'aoa'
+              | 'ars'
+              | 'aud'
+              | 'awg'
+              | 'azn'
+              | 'bam'
+              | 'bbd'
+              | 'bdt'
+              | 'bgn'
+              | 'bhd'
+              | 'bif'
+              | 'bmd'
+              | 'bnd'
+              | 'bob'
+              | 'bov'
+              | 'brl'
+              | 'bsd'
+              | 'btn'
+              | 'bwp'
+              | 'byn'
+              | 'byr'
+              | 'bzd'
+              | 'cad'
+              | 'cdf'
+              | 'che'
+              | 'chf'
+              | 'chw'
+              | 'clf'
+              | 'clp'
+              | 'cny'
+              | 'cop'
+              | 'cou'
+              | 'crc'
+              | 'cuc'
+              | 'cup'
+              | 'cve'
+              | 'czk'
+              | 'djf'
+              | 'dkk'
+              | 'dop'
+              | 'dzd'
+              | 'eek'
+              | 'egp'
+              | 'ern'
+              | 'etb'
+              | 'eur'
+              | 'fjd'
+              | 'fkp'
+              | 'gbp'
+              | 'gel'
+              | 'ghc'
+              | 'ghs'
+              | 'gip'
+              | 'gmd'
+              | 'gnf'
+              | 'gtq'
+              | 'gyd'
+              | 'hkd'
+              | 'hnl'
+              | 'hrk'
+              | 'htg'
+              | 'huf'
+              | 'idr'
+              | 'ils'
+              | 'inr'
+              | 'iqd'
+              | 'irr'
+              | 'isk'
+              | 'jmd'
+              | 'jod'
+              | 'jpy'
+              | 'kes'
+              | 'kgs'
+              | 'khr'
+              | 'kmf'
+              | 'kpw'
+              | 'krw'
+              | 'kwd'
+              | 'kyd'
+              | 'kzt'
+              | 'lak'
+              | 'lbp'
+              | 'lkr'
+              | 'lrd'
+              | 'lsl'
+              | 'ltl'
+              | 'lvl'
+              | 'lyd'
+              | 'mad'
+              | 'mdl'
+              | 'mga'
+              | 'mkd'
+              | 'mmk'
+              | 'mnt'
+              | 'mop'
+              | 'mro'
+              | 'mru'
+              | 'mur'
+              | 'mvr'
+              | 'mwk'
+              | 'mxn'
+              | 'mxv'
+              | 'myr'
+              | 'mzn'
+              | 'nad'
+              | 'ngn'
+              | 'nio'
+              | 'nok'
+              | 'npr'
+              | 'nzd'
+              | 'omr'
+              | 'pab'
+              | 'pen'
+              | 'pgk'
+              | 'php'
+              | 'pkr'
+              | 'pln'
+              | 'pyg'
+              | 'qar'
+              | 'ron'
+              | 'rsd'
+              | 'rub'
+              | 'rwf'
+              | 'sar'
+              | 'sbd'
+              | 'scr'
+              | 'sdg'
+              | 'sek'
+              | 'sgd'
+              | 'shp'
+              | 'sle'
+              | 'sll'
+              | 'sos'
+              | 'srd'
+              | 'ssp'
+              | 'std'
+              | 'stn'
+              | 'svc'
+              | 'syp'
+              | 'szl'
+              | 'thb'
+              | 'tjs'
+              | 'tmt'
+              | 'tnd'
+              | 'top'
+              | 'try'
+              | 'ttd'
+              | 'twd'
+              | 'tzs'
+              | 'uah'
+              | 'ugx'
+              | 'usd'
+              | 'usdb'
+              | 'usdc'
+              | 'usn'
+              | 'uyi'
+              | 'uyu'
+              | 'uzs'
+              | 'vef'
+              | 'ves'
+              | 'vnd'
+              | 'vuv'
+              | 'wst'
+              | 'xaf'
+              | 'xcd'
+              | 'xcg'
+              | 'xof'
+              | 'xpf'
+              | 'yer'
+              | 'zar'
+              | 'zmk'
+              | 'zmw'
+              | 'zwd'
+              | 'zwg'
+              | 'zwl';
+          }
+        }
+      }
+
+      namespace MoneyManagement {
+        interface FinancialAccountRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface FinancialAccountListParams {
+          /**
+           * The page limit.
+           */
+          limit?: number;
+
+          /**
+           * The status of the FinancialAccount to filter by. By default, closed FinancialAccounts are not returned.
+           */
+          status?: FinancialAccountListParams.Status;
+        }
+
+        namespace FinancialAccountListParams {
+          type Status = 'closed' | 'open' | 'pending';
+        }
+      }
+
+      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;
+          }
+        }
+      }
+
+      namespace MoneyManagement {
+        class FinancialAccountsResource {
+          /**
+           * Creates a new FinancialAccount.
+           * @throws Stripe.AlreadyExistsError
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          create(
+            params: FinancialAccountCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
+          >;
+
+          /**
+           * Retrieves the details of an existing FinancialAccount.
+           */
+          retrieve(
+            id: string,
+            params?: FinancialAccountRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
+          >;
+
+          /**
+           * Lists FinancialAccounts in this compartment.
+           */
+          list(
+            params?: FinancialAccountListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAccount>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.FinancialAccount>;
+
+          /**
+           * Closes a FinancialAccount with or without forwarding settings.
+           * @throws Stripe.NonZeroBalanceError
+           */
+          close(
+            id: string,
+            params?: FinancialAccountCloseParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
+          >;
+          close(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
+          >;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,314 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * A FinancialAddress contains information needed to transfer money to a Financial Account. A Financial Account can have more than one Financial Address.
+         */
+        interface FinancialAddress {
+          /**
+           * The ID of a FinancialAddress.
+           */
+          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_address';
+
+          /**
+           * The creation timestamp of the FinancialAddress.
+           */
+          created: string;
+
+          /**
+           * Object indicates the type of credentials that have been allocated and attached to the FinancialAddress.
+           * It contains all necessary banking details with which to perform money movements with the FinancialAddress.
+           * This field is only available for FinancialAddresses with an active status.
+           */
+          credentials: FinancialAddress.Credentials | null;
+
+          /**
+           * Open Enum. The currency the FinancialAddress supports.
+           */
+          currency: FinancialAddress.Currency;
+
+          /**
+           * A ID of the FinancialAccount this FinancialAddress corresponds to.
+           */
+          financial_account: 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;
+
+          /**
+           * Closed Enum. An enum representing the status of the FinancialAddress. This indicates whether or not the FinancialAddress can be used for any money movement flows.
+           */
+          status: FinancialAddress.Status;
+        }
+
+        namespace FinancialAddress {
+          interface Credentials {
+            /**
+             * Open Enum. The type of Credentials that are provisioned for the FinancialAddress.
+             */
+            type: Credentials.Type;
+
+            /**
+             * The credentials of the UK Bank Account for the FinancialAddress. This contains unique banking details such as the sort code, account number, etc. of a UK bank account.
+             */
+            gb_bank_account: Credentials.GbBankAccount | null;
+
+            /**
+             * The credentials of the US Bank Account for the FinancialAddress. This contains unique banking details such as the routing number, account number, etc. of a US bank account.
+             */
+            us_bank_account: Credentials.UsBankAccount | null;
+          }
+
+          namespace Credentials {
+            interface GbBankAccount {
+              /**
+               * The account holder name to be used during bank transference.
+               */
+              account_holder_name: string;
+
+              /**
+               * The account number of the UK Bank Account.
+               */
+              account_number: string | null;
+
+              /**
+               * The last four digits of the UK Bank Account number. This will always be returned.
+               * To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+               */
+              last4: string;
+
+              /**
+               * The sort code of the UK Bank Account.
+               */
+              sort_code: string;
+            }
+
+            type Type = 'gb_bank_account' | 'us_bank_account';
+
+            interface UsBankAccount {
+              /**
+               * The account number of the US Bank Account.
+               */
+              account_number: string | null;
+
+              /**
+               * The name of the Bank.
+               */
+              bank_name: string | null;
+
+              /**
+               * The last four digits of the US Bank Account number. This will always be returned.
+               * To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+               */
+              last4: string;
+
+              /**
+               * The routing number of the US Bank Account.
+               */
+              routing_number: string;
+
+              /**
+               * The swift code of the bank or financial institution.
+               */
+              swift_code: string | null;
+            }
+          }
+
+          type Currency =
+            | 'aed'
+            | 'afn'
+            | 'all'
+            | 'amd'
+            | 'ang'
+            | 'aoa'
+            | 'ars'
+            | 'aud'
+            | 'awg'
+            | 'azn'
+            | 'bam'
+            | 'bbd'
+            | 'bdt'
+            | 'bgn'
+            | 'bhd'
+            | 'bif'
+            | 'bmd'
+            | 'bnd'
+            | 'bob'
+            | 'bov'
+            | 'brl'
+            | 'bsd'
+            | 'btn'
+            | 'bwp'
+            | 'byn'
+            | 'byr'
+            | 'bzd'
+            | 'cad'
+            | 'cdf'
+            | 'che'
+            | 'chf'
+            | 'chw'
+            | 'clf'
+            | 'clp'
+            | 'cny'
+            | 'cop'
+            | 'cou'
+            | 'crc'
+            | 'cuc'
+            | 'cup'
+            | 'cve'
+            | 'czk'
+            | 'djf'
+            | 'dkk'
+            | 'dop'
+            | 'dzd'
+            | 'eek'
+            | 'egp'
+            | 'ern'
+            | 'etb'
+            | 'eur'
+            | 'fjd'
+            | 'fkp'
+            | 'gbp'
+            | 'gel'
+            | 'ghc'
+            | 'ghs'
+            | 'gip'
+            | 'gmd'
+            | 'gnf'
+            | 'gtq'
+            | 'gyd'
+            | 'hkd'
+            | 'hnl'
+            | 'hrk'
+            | 'htg'
+            | 'huf'
+            | 'idr'
+            | 'ils'
+            | 'inr'
+            | 'iqd'
+            | 'irr'
+            | 'isk'
+            | 'jmd'
+            | 'jod'
+            | 'jpy'
+            | 'kes'
+            | 'kgs'
+            | 'khr'
+            | 'kmf'
+            | 'kpw'
+            | 'krw'
+            | 'kwd'
+            | 'kyd'
+            | 'kzt'
+            | 'lak'
+            | 'lbp'
+            | 'lkr'
+            | 'lrd'
+            | 'lsl'
+            | 'ltl'
+            | 'lvl'
+            | 'lyd'
+            | 'mad'
+            | 'mdl'
+            | 'mga'
+            | 'mkd'
+            | 'mmk'
+            | 'mnt'
+            | 'mop'
+            | 'mro'
+            | 'mru'
+            | 'mur'
+            | 'mvr'
+            | 'mwk'
+            | 'mxn'
+            | 'mxv'
+            | 'myr'
+            | 'mzn'
+            | 'nad'
+            | 'ngn'
+            | 'nio'
+            | 'nok'
+            | 'npr'
+            | 'nzd'
+            | 'omr'
+            | 'pab'
+            | 'pen'
+            | 'pgk'
+            | 'php'
+            | 'pkr'
+            | 'pln'
+            | 'pyg'
+            | 'qar'
+            | 'ron'
+            | 'rsd'
+            | 'rub'
+            | 'rwf'
+            | 'sar'
+            | 'sbd'
+            | 'scr'
+            | 'sdg'
+            | 'sek'
+            | 'sgd'
+            | 'shp'
+            | 'sle'
+            | 'sll'
+            | 'sos'
+            | 'srd'
+            | 'ssp'
+            | 'std'
+            | 'stn'
+            | 'svc'
+            | 'syp'
+            | 'szl'
+            | 'thb'
+            | 'tjs'
+            | 'tmt'
+            | 'tnd'
+            | 'top'
+            | 'try'
+            | 'ttd'
+            | 'twd'
+            | 'tzs'
+            | 'uah'
+            | 'ugx'
+            | 'usd'
+            | 'usdb'
+            | 'usdc'
+            | 'usn'
+            | 'uyi'
+            | 'uyu'
+            | 'uzs'
+            | 'vef'
+            | 'ves'
+            | 'vnd'
+            | 'vuv'
+            | 'wst'
+            | 'xaf'
+            | 'xcd'
+            | 'xcg'
+            | 'xof'
+            | 'xpf'
+            | 'yer'
+            | 'zar'
+            | 'zmk'
+            | 'zmw'
+            | 'zwd'
+            | 'zwg'
+            | 'zwl';
+
+          type Status = 'active' | 'archived' | 'failed' | 'pending';
+        }
+      }
+    }
+  }
+}