ClearBank.Schemas.Customer (ClearBank v1.0.0)

Copy Markdown View Source

Typed struct for an Embedded Banking customer.

Summary

Types

customer_type()

@type customer_type() :: :retail | :sole_trader | :legal_entity

kyc_status()

@type kyc_status() ::
  :pending | :in_progress | :approved | :rejected | :requires_action

t()

@type t() :: %ClearBank.Schemas.Customer{
  company_name: String.t() | nil,
  created_at: String.t() | nil,
  email: String.t() | nil,
  external_customer_id: String.t() | nil,
  first_name: String.t() | nil,
  id: String.t(),
  kyc_status: kyc_status() | nil,
  last_name: String.t() | nil,
  phone: String.t() | nil,
  type: customer_type()
}

Functions

from_map(m)

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