Increase.ExternalAccounts (Increase v1.0.0)

Copy Markdown View Source

External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.

See https://increase.com/documentation/api/external-accounts for the full API reference for this resource.

Summary

Functions

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

Create an External Account

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

List External Accounts

retrieve(client, external_account_id, opts \\ [])

Retrieve an External Account

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

Update an External Account

Functions

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

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.ExternalAccounts.ExternalAccount.t()}
  | {:error, Increase.Error.t()}

Create an External Account

POST /external_accounts

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

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List External Accounts

Returns a %Increase.Page{} whose data is a list of %__MODULE__. ExternalAccount{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /external_accounts

retrieve(client, external_account_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.ExternalAccounts.ExternalAccount.t()}
  | {:error, Increase.Error.t()}

Retrieve an External Account

GET /external_accounts/{external_account_id}

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

@spec update(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.ExternalAccounts.ExternalAccount.t()}
  | {:error, Increase.Error.t()}

Update an External Account

PATCH /external_accounts/{external_account_id}