View Source Stripe.ExternalAccount (Striped v0.2.0)
Link to this section Summary
Functions
Create an external account for a given account.
Delete a specified external account for a given account.
List external accounts for an account.
Retrieve a specified external account for a given account.
Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
Link to this section Types
@type t() :: %Stripe.ExternalAccount{}
The external_account
type.
Link to this section Functions
@spec create( client :: term(), account :: binary(), params :: %{ optional(:default_for_currency) => :boolean, optional(:expand) => [:string], external_account: :string, metadata: :object } ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Create an external account for a given account.
Details
- Method:
post
- Path:
/v1/accounts/{account}/external_accounts
@spec delete(client :: term(), account :: binary(), id :: binary()) :: {:ok, Stripe.DeletedExternalAccount.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Delete a specified external account for a given account.
Details
- Method:
delete
- Path:
/v1/accounts/{account}/external_accounts/{id}
@spec list( client :: term(), account :: binary(), params :: %{ optional(:ending_before) => :string, optional(:expand) => [:string], optional(:limit) => :integer, optional(:starting_after) => :string } ) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
List external accounts for an account.
Details
- Method:
get
- Path:
/v1/accounts/{account}/external_accounts
@spec retrieve( client :: term(), account :: binary(), id :: binary(), params :: %{optional(:expand) => [:string]} ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Retrieve a specified external account for a given account.
Details
- Method:
get
- Path:
/v1/accounts/{account}/external_accounts/{id}
@spec update( client :: term(), account :: binary(), id :: binary(), params :: %{ optional(:account_holder_name) => :string, optional(:account_holder_type) => :company | :individual, optional(:account_type) => :checking | :futsu | :savings | :toza, optional(:address_city) => :string, optional(:address_country) => :string, optional(:address_line1) => :string, optional(:address_line2) => :string, optional(:address_state) => :string, optional(:address_zip) => :string, optional(:default_for_currency) => :boolean, optional(:exp_month) => :string, optional(:exp_year) => :string, optional(:expand) => [:string], optional(:metadata) => :object | :string, optional(:name) => :string } ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
Details
- Method:
post
- Path:
/v1/accounts/{account}/external_accounts/{id}