TreasuryPrime.Deposit (TreasuryPrime v1.0.0)

Copy Markdown View Source

An initial funding deposit for a new account, created during account opening and referenced via deposit_id on a TreasuryPrime.AccountApplication. Once the account application is approved, the deposit is processed and funds become the account's opening balance.

Creating one

{:ok, deposit} =
  TreasuryPrime.Deposit.create(client, %{
    amount: "100.00",
    ach: %{
      account_number: "12345678",
      routing_number: "87654321",
      account_type: "checking",
      name_on_account: "George Washington"
    }
  })

{:ok, account_app} =
  TreasuryPrime.AccountApplication.create(client, %{
    deposit_id: deposit.id,
    person_applications: [%{id: person_app.id, roles: ["owner", "signer"]}],
    primary_person_application_id: person_app.id,
    account_product_id: "apt_..."
  })

Summary

Types

t()

Functions

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

Creates an initial funding deposit. Required: amount, plus funding-source details (e.g. ach).

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

Fetches a single deposit by id.

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

Lists deposits.

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

Types

t()

@type t() :: %TreasuryPrime.Deposit{
  ach: map() | nil,
  amount: String.t() | nil,
  created_at: String.t() | nil,
  error: String.t() | nil,
  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 an initial funding deposit. Required: amount, plus funding-source details (e.g. ach).

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 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 deposits.

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

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