StripeElixir.Services.Treasury.FinancialAccountService (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

Functions

close(client, financial_account, params \\ %{}, opts \\ [])

Close a FinancialAccount

create(client, params \\ %{}, opts \\ [])

Create a FinancialAccount

list(client, params \\ %{}, opts \\ [])

List all FinancialAccounts

retrieve(client, financial_account, params \\ %{}, opts \\ [])

Retrieve a FinancialAccount

update(client, financial_account, params \\ %{}, opts \\ [])

Update a FinancialAccount

Functions

close(client, financial_account, params \\ %{}, opts \\ [])

@spec close(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Close a FinancialAccount

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

create(client, params \\ %{}, opts \\ [])

@spec create(StripeElixir.Client.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Create a FinancialAccount

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

list(client, params \\ %{}, opts \\ [])

@spec list(StripeElixir.Client.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

List all FinancialAccounts

Returns a list of FinancialAccounts.

retrieve(client, financial_account, params \\ %{}, opts \\ [])

@spec retrieve(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Retrieve a FinancialAccount

Retrieves the details of a FinancialAccount.

update(client, financial_account, params \\ %{}, opts \\ [])

@spec update(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Update a FinancialAccount

Updates the details of a FinancialAccount.