Solaris.Lending.Overdraft (Solaris v1.0.0)

Copy Markdown View Source

Overdraft credit facilities on current accounts.

Overdraft allows customers to go into negative balance up to an approved limit.

Summary

Functions

activate(person_id, account_id, opts \\ [])

Activates a granted overdraft on an account.

create_application(person_id, attrs, opts \\ [])

Creates an overdraft application for a person.

get(person_id, account_id, opts \\ [])

Retrieves the current overdraft for a person's account.

get_application(person_id, application_id, opts \\ [])

Retrieves an overdraft application.

list_applications(person_id, opts \\ [])

Lists overdraft applications for a person.

Functions

activate(person_id, account_id, opts \\ [])

@spec activate(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Solaris.Error.t()}

Activates a granted overdraft on an account.

create_application(person_id, attrs, opts \\ [])

@spec create_application(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Solaris.Error.t()}

Creates an overdraft application for a person.

get(person_id, account_id, opts \\ [])

@spec get(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Solaris.Error.t()}

Retrieves the current overdraft for a person's account.

get_application(person_id, application_id, opts \\ [])

@spec get_application(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Solaris.Error.t()}

Retrieves an overdraft application.

list_applications(person_id, opts \\ [])

@spec list_applications(
  String.t(),
  keyword()
) :: {:ok, [map()]} | {:error, Solaris.Error.t()}

Lists overdraft applications for a person.