StarlingBank.Payees (StarlingBank v1.0.0)

Copy Markdown View Source

Payees — saved recipients for payments, including their bank account details and optional profile images.

Required scopes: payee:read, payee:create, payee:edit, payee:delete, payee-image:read.

Summary

Types

t()

Functions

create(attrs, client \\ nil)

Creates a new payee. attrs should match Starling's payee creation schema.

delete(payee_uid, client \\ nil)

Deletes a payee.

image(payee_uid, client \\ nil)

Fetches a payee's profile image as binary image data.

list(client \\ nil)

Lists all saved payees.

Types

t()

@type t() :: %StarlingBank.Payees{
  business_name: String.t() | nil,
  date_last_paid: DateTime.t() | nil,
  first_name: String.t() | nil,
  last_name: String.t() | nil,
  middle_name: String.t() | nil,
  payee_name: String.t(),
  payee_type: String.t(),
  payee_uid: String.t(),
  phone_number: String.t() | nil
}

Functions

create(attrs, client \\ nil)

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

Creates a new payee. attrs should match Starling's payee creation schema.

delete(payee_uid, client \\ nil)

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

Deletes a payee.

image(payee_uid, client \\ nil)

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

Fetches a payee's profile image as binary image data.

list(client \\ nil)

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

Lists all saved payees.