Search documentation of stripe_elixir

# StripeElixir.Resources.Treasury.FinancialAccount (stripe_elixir v0.1.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

t()

### Functions

expandable_fields()
object_name()

## Types

# t()

    @type t() :: %StripeElixir.Resources.Treasury.FinancialAccount{
      active_features: [String.t()] | nil,
      balance: String.t() | map(),
      country: String.t(),
      created: integer(),
      features: String.t() | map() | nil,
      financial_addresses: [map()],
      id: String.t(),
      is_default: boolean() | nil,
      livemode: boolean(),
      metadata: map(),
      nickname: String.t() | nil,
      object: String.t(),
      pending_features: [String.t()] | nil,
      platform_restrictions: String.t() | map() | nil,
      restricted_features: [String.t()] | nil,
      status: String.t(),
      status_details: String.t() | map(),
      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()