Striped v0.1.0

View Source Stripe.Treasury.FinancialAccount (Striped v0.1.0)

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.

Link to this section Summary

Types

t()

The treasury.financial_account type.

Functions

create(client, params \\ %{})

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

list(client, params \\ %{})

Returns a list of FinancialAccounts.

retrieve(client, financial_account, params \\ %{})

Retrieves the details of a FinancialAccount.

retrieve_features(client, financial_account, params \\ %{})

Retrieves Features information associated with the FinancialAccount.

update(client, financial_account, params \\ %{})

Updates the details of a FinancialAccount.

update_features(client, financial_account, params \\ %{})

Updates the Features associated with a FinancialAccount.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Stripe.Treasury.FinancialAccount{
  active_features: term(),
  balance: term(),
  country: binary(),
  created: integer(),
  features: Stripe.Treasury.FinancialAccountFeatures.t(),
  financial_addresses: term(),
  id: binary(),
  livemode: boolean(),
  metadata: term() | nil,
  object: binary(),
  pending_features: term(),
  platform_restrictions: term() | nil,
  restricted_features: term(),
  status: binary(),
  status_details: term(),
  supported_currencies: term()
}

The treasury.financial_account type.

  • active_features The array of paths to active Features in the Features hash.
  • balance
  • country Two-letter country code (ISO 3166-1 alpha-2).
  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • features
  • financial_addresses The set of credentials that resolve to a FinancialAccount.
  • id Unique identifier for the object.
  • 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.
  • object String representing the object's type. Objects of the same type share the same value.
  • 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.
  • restricted_features The array of paths to restricted Features in the Features hash.
  • status The enum specifying what state the account is in.
  • status_details
  • supported_currencies The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.

Link to this section Functions

Link to this function

create(client, params \\ %{})

View Source 
@spec create(client :: term(), params :: map()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

Details

  • Method: post
  • Path: /v1/treasury/financial_accounts
Link to this function

list(client, params \\ %{})

View Source 
@spec list(client :: term(), params :: map()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of FinancialAccounts.

Details

  • Method: get
  • Path: /v1/treasury/financial_accounts

Query parameters

  • :created any of:
    • object with (optional) properties:
      • gt: integer
      • gte: integer
      • lt: integer
      • lte: integer
    • integer
  • :ending_before string
  • :expand array of: string
  • :limit integer
  • :starting_after string
Link to this function

retrieve(client, financial_account, params \\ %{})

View Source 
@spec retrieve(client :: term(), financial_account :: binary(), params :: map()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of a FinancialAccount.

Details

  • Method: get
  • Path: /v1/treasury/financial_accounts/{financial_account}

Query parameters

  • :expand array of: string
Link to this function

retrieve_features(client, financial_account, params \\ %{})

View Source 
@spec retrieve_features(
  client :: term(),
  financial_account :: binary(),
  params :: map()
) ::
  {:ok, Stripe.Treasury.FinancialAccountFeatures.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Retrieves Features information associated with the FinancialAccount.

Details

  • Method: get
  • Path: /v1/treasury/financial_accounts/{financial_account}/features

Query parameters

  • :expand array of: string
Link to this function

update(client, financial_account, params \\ %{})

View Source 
@spec update(client :: term(), financial_account :: binary(), params :: map()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates the details of a FinancialAccount.

Details

  • Method: post
  • Path: /v1/treasury/financial_accounts/{financial_account}
Link to this function

update_features(client, financial_account, params \\ %{})

View Source 
@spec update_features(
  client :: term(),
  financial_account :: binary(),
  params :: map()
) ::
  {:ok, Stripe.Treasury.FinancialAccountFeatures.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Updates the Features associated with a FinancialAccount.

Details

  • Method: post
  • Path: /v1/treasury/financial_accounts/{financial_account}/features