TreasuryPrime.DepositSweep (TreasuryPrime v1.0.0)

Deposit sweep program enrollment — configures an account to automatically sweep balances above/below target thresholds into a network of partner banks, typically to extend FDIC insurance coverage beyond the standard $250,000 per-bank limit (see also TreasuryPrime.ReserveAccount and the Enhanced FDIC Insurance guide).

Setting up sweep programs is a bank/program-configuration-heavy process; this resource lets you manage an account's enrollment programmatically once your bank partner has the underlying sweep network configured.

Summary

Types

t()

Functions

create(client, params, opts \\ [])

Enrolls an account in a deposit sweep program. Required: account_id.

create!(client, params, opts \\ [])

get(client, id)

Fetches a single deposit sweep enrollment by id.

get!(client, id)

list(client, params \\ %{})

Lists deposit sweep enrollments.

list!(client, params \\ %{})

update(client, id, params)

Updates a deposit sweep enrollment.

update!(client, id, params)

Types

t()

@type t() :: %TreasuryPrime.DepositSweep{
  account_id: String.t() | nil,
  created_at: String.t() | nil,
  id: String.t() | nil,
  org_id: String.t() | nil,
  status: String.t() | nil,
  sweep_program: String.t() | nil,
  updated_at: String.t() | nil,
  userdata: map() | nil
}

Functions

create(client, params, opts \\ [])

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

Enrolls an account in a deposit sweep program. Required: account_id.

create!(client, params, opts \\ [])

@spec create!(TreasuryPrime.Client.t(), map(), keyword()) :: t()

get(client, id)

@spec get(TreasuryPrime.Client.t(), String.t()) ::
  {:ok, t()} | {:error, TreasuryPrime.Error.t()}

Fetches a single deposit sweep enrollment by id.

get!(client, id)

@spec get!(TreasuryPrime.Client.t(), String.t()) :: t()

list(client, params \\ %{})

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

Lists deposit sweep enrollments.

Filterable params

account_id, status.

list!(client, params \\ %{})

@spec list!(TreasuryPrime.Client.t(), map()) :: TreasuryPrime.Page.t()

update(client, id, params)

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

Updates a deposit sweep enrollment.

update!(client, id, params)

@spec update!(TreasuryPrime.Client.t(), String.t(), map()) :: t()