TreasuryPrime.AccountNumberReservation (TreasuryPrime v1.0.0)

Copy Markdown View Source

Reserves an account number / routing number pair ahead of an account being fully opened — useful when you need to give a customer their future account number immediately (e.g. to print on a welcome packet or set up payroll direct deposit) before the underlying TreasuryPrime.AccountApplication has finished processing.

Summary

Types

t()

Functions

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

Reserves a new account number.

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

Fetches a single reservation by id.

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

Lists account number reservations.

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

Types

t()

@type t() :: %TreasuryPrime.AccountNumberReservation{
  account_number: String.t() | nil,
  created_at: String.t() | nil,
  id: String.t() | nil,
  routing_number: 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()}

Reserves a new account number.

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 reservation 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 number reservations.

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

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