StarlingBank.DirectDebits (StarlingBank v1.0.0)

Copy Markdown View Source

Direct Debit mandates — list and cancel Direct Debit instructions set up against an account.

Required scopes: mandate:read, mandate:delete.

Summary

Types

t()

Functions

delete(mandate_uid, client \\ nil)

Cancels a Direct Debit mandate.

get(mandate_uid, client \\ nil)

Fetches a single mandate by UID.

list(client \\ nil)

Lists all Direct Debit mandates on the default/given account.

Types

t()

@type t() :: %StarlingBank.DirectDebits{
  created: DateTime.t() | nil,
  mandate_uid: String.t(),
  originator_name: String.t() | nil,
  reference: String.t() | nil,
  source: String.t() | nil,
  status: String.t()
}

Functions

delete(mandate_uid, client \\ nil)

@spec delete(String.t(), StarlingBank.Client.t() | keyword() | nil) ::
  {:ok, nil} | {:error, StarlingBank.Error.t()}

Cancels a Direct Debit mandate.

get(mandate_uid, client \\ nil)

@spec get(String.t(), StarlingBank.Client.t() | keyword() | nil) ::
  {:ok, t()} | {:error, StarlingBank.Error.t()}

Fetches a single mandate by UID.

list(client \\ nil)

@spec list(StarlingBank.Client.t() | keyword() | nil) ::
  {:ok, [t()]} | {:error, StarlingBank.Error.t()}

Lists all Direct Debit mandates on the default/given account.