ClearBank.Schemas.Account (ClearBank v1.0.0)

Copy Markdown View Source

Typed struct for a GBP real account.

Summary

Types

account_type()

@type account_type() ::
  :your_funds
  | :client_money_pooled
  | :client_money_designated
  | :segregated_pooled
  | :segregated_designated
  | :safeguarded_pooled
  | :safeguarded_designated
  | :client_suspense

status()

@type status() :: :active | :suspended | :closed

t()

@type t() :: %ClearBank.Schemas.Account{
  account_number: String.t() | nil,
  available_balance: String.t() | nil,
  balance: String.t() | nil,
  cop_enabled: boolean(),
  created_at: String.t() | nil,
  currency: String.t(),
  iban: String.t() | nil,
  id: String.t(),
  name: String.t(),
  sort_code: String.t() | nil,
  status: status(),
  type: account_type()
}

Functions

from_map(m)

@spec from_map(map()) :: t()