Search documentation of stripe_elixir

# StripeElixir.Services.AccountExternalAccountService (stripe_elixir v0.1.0)

Copy Markdown View Source

AccountExternalAccount API operations.

## Summary

### Functions

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

Create an external account

delete(client, account, id, params \\ %{}, opts \\ [])

Delete an external account

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

List all external accounts

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

Retrieve an external account

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

Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.

## Functions

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

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

Create an external account

Create an external account for a given account.

# delete(client, account, id, params \\ %{}, opts \\ [])

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

Delete an external account

Delete a specified external account for a given account.

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

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

List all external accounts

List external accounts for an account.

# retrieve(client, account, id, params \\ %{}, opts \\ [])

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

Retrieve an external account

Retrieve a specified external account for a given account.

# update(client, account, id, params \\ %{}, opts \\ [])

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

Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can only update bank accounts when account.controller.requirement_collection is `application`, which includes Custom accounts.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.