Stripe.Resources.Treasury.FinancialAccount (tiger_stripe v0.3.0)

Copy Markdown View Source

TreasuryFinancialAccountsResourceFinancialAccount

Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance. FinancialAccounts serve as the source and destination of Treasury’s money movement APIs.

Summary

Types

financial_addresses()
t()

Functions

expandable_fields()
object_name()

Types

financial_addresses()

@type financial_addresses() :: %{
  optional(:aba) => Stripe.Resources.Aba.t() | nil,
  optional(:supported_networks) => [String.t()] | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • aba
  • supported_networks - The list of networks that the address supports
  • type - The type of financial address Possible values: aba.

t()

@type t() :: %Stripe.Resources.Treasury.FinancialAccount{
  active_features: [String.t()] | nil,
  balance: Stripe.Resources.Balance.t(),
  country: String.t(),
  created: integer(),
  features: Stripe.Resources.Treasury.FinancialAccountFeatures.t() | nil,
  financial_addresses: [financial_addresses()],
  id: String.t(),
  is_default: boolean() | nil,
  livemode: boolean(),
  metadata: %{required(String.t()) => String.t()},
  nickname: String.t() | nil,
  object: String.t(),
  pending_features: [String.t()] | nil,
  platform_restrictions: Stripe.Resources.PlatformRestriction.t() | nil,
  restricted_features: [String.t()] | nil,
  status: String.t(),
  status_details: Stripe.Resources.StatusDetails.t(),
  supported_currencies: [String.t()]
}
  • active_features - The array of paths to active Features in the Features hash.
  • balance - Expandable.
  • country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
  • created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • features - Expandable.
  • financial_addresses - The set of credentials that resolve to a FinancialAccount. Expandable.
  • id - Unique identifier for the object. Max length: 5000.
  • is_default
  • livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • metadata - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Nullable.
  • nickname - The nickname for the FinancialAccount. Max length: 5000. Nullable.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: treasury.financial_account.
  • pending_features - The array of paths to pending Features in the Features hash.
  • platform_restrictions - The set of functionalities that the platform can restrict on the FinancialAccount. Nullable. Expandable.
  • restricted_features - The array of paths to restricted Features in the Features hash.
  • status - Status of this FinancialAccount. Possible values: closed, open.
  • status_details - Expandable.
  • supported_currencies - The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.

Functions

expandable_fields()

object_name()