Zazu.Beneficiaries (zazu v0.2.1)

Copy Markdown View Source

Read-only directory of saved transfer recipients, managed in the Zazu dashboard.

Each beneficiary embeds its bank accounts ("external_accounts"); the one flagged default is used when a transfer names only the beneficiary_id. The API cannot create, update, or delete beneficiaries — they are created and managed in the dashboard.

Summary

Functions

Calls GET /api/beneficiaries/:id.

Calls GET /api/beneficiaries.

Functions

get(client, id)

@spec get(Zazu.Client.t(), String.t()) ::
  {:ok, Zazu.Response.t()} | {:error, Exception.t()}

Calls GET /api/beneficiaries/:id.

Beneficiaries are a read-only directory managed in the Zazu dashboard.

list(client, opts \\ [])

@spec list(
  Zazu.Client.t(),
  keyword()
) :: {:ok, Zazu.Page.t()} | {:error, Exception.t()}

Calls GET /api/beneficiaries.

Beneficiaries are a read-only directory managed in the Zazu dashboard — the API only lists and reads them.

Options

  • :limit — page size (1..100, default 100).
  • :cursor — pagination cursor.