TreasuryPrime.AccountProduct (TreasuryPrime v1.0.0)

Account products are bank-configured templates (interest rate tiers, fee schedules, eligibility rules) that TreasuryPrime.Accounts are created under. They're configured by your bank partner / in the Bank Console, so this resource is read-only — use it to look up which products are available to offer when submitting an TreasuryPrime.AccountApplication.

Summary

Types

t()

Functions

get(client, id)

Fetches a single account product by id.

get!(client, id)

list(client, params \\ %{})

Lists account products available to your organization.

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

Types

t()

@type t() :: %TreasuryPrime.AccountProduct{
  account_type: String.t() | nil,
  bank_id: String.t() | nil,
  created_at: String.t() | nil,
  id: String.t() | nil,
  interest_rate: String.t() | nil,
  name: String.t() | nil,
  status: String.t() | nil,
  updated_at: String.t() | nil
}

Functions

get(client, id)

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

Fetches a single account product 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 account products available to your organization.

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

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