TreasuryPrime.ReserveAccount (TreasuryPrime v1.0.0)

Reserve accounts are special-purpose accounts (e.g. holding loss reserves, prefunding, or program collateral) that you manage on behalf of your program with your bank partner. Unlike TreasuryPrime.Account, reserve accounts support delete/2.

Summary

Types

t()

Functions

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

Creates a reserve account.

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

delete(client, id)

Deletes a reserve account.

delete!(client, id)

get(client, id)

Fetches a single reserve account by id.

get!(client, id)

list(client, params \\ %{})

Lists reserve accounts.

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

update(client, id, params)

Updates a reserve account.

update!(client, id, params)

Types

t()

@type t() :: %TreasuryPrime.ReserveAccount{
  account_id: String.t() | nil,
  bank_id: String.t() | nil,
  created_at: String.t() | nil,
  id: String.t() | nil,
  name: String.t() | nil,
  org_id: String.t() | nil,
  status: 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()}

Creates a reserve account.

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

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

delete(client, id)

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

Deletes a reserve account.

delete!(client, id)

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

get(client, id)

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

Fetches a single reserve account 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 reserve accounts.

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 reserve account.

update!(client, id, params)

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