MoneyHub.Beneficiaries (MoneyHub v1.0.0)

Copy Markdown View Source

Beneficiaries: payees the user has previously sent money to from a connected account, as detected from open banking data (distinct from MoneyHub.Payees, which are payees you create for initiating payments).

Reading the postal address and other extended fields requires the optional beneficiaries_detail:read scope in addition to beneficiaries:read.

See Beneficiaries and Sensitive Information.

Summary

Functions

Fetches a single beneficiary by id.

Lists beneficiaries for the user identified by token.

Types

beneficiary()

@type beneficiary() :: map()

Functions

get(config, token, beneficiary_id)

@spec get(MoneyHub.Config.t(), String.t(), String.t()) ::
  {:ok, beneficiary()} | {:error, MoneyHub.Error.t()}

Fetches a single beneficiary by id.

list(config, token)

@spec list(MoneyHub.Config.t(), String.t()) ::
  {:ok, [beneficiary()]} | {:error, MoneyHub.Error.t()}

Lists beneficiaries for the user identified by token.