PlaidEx.API.Transfer (plaid_ex v1.0.0)

@spec authorize(PlaidEx.Config.t(), map(), keyword()) ::
  {:ok, %{authorization: map(), request_id: String.t() | nil}}
  | {:error, PlaidEx.Error.t()}

Creates a transfer authorization (eligibility check).

cancel(config, transfer_id, opts \\ [])

@spec cancel(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Cancels a transfer (only possible in pending status).

create(config, params, opts \\ [])

@spec create(PlaidEx.Config.t(), map(), keyword()) ::
  {:ok, PlaidEx.Schemas.Transfer.t()} | {:error, PlaidEx.Error.t()}

Creates a transfer using an authorization ID.

get(config, transfer_id, opts \\ [])

@spec get(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, PlaidEx.Schemas.Transfer.t()} | {:error, PlaidEx.Error.t()}

Retrieves a transfer by ID.

get_events(config, opts \\ [])

@spec get_events(
  PlaidEx.Config.t(),
  keyword()
) :: {:ok, map()} | {:error, PlaidEx.Error.t()}

Lists transfer events.

list(config, opts \\ [])

@spec list(
  PlaidEx.Config.t(),
  keyword()
) ::
  {:ok, %{transfers: [PlaidEx.Schemas.Transfer.t()]}}
  | {:error, PlaidEx.Error.t()}

Lists transfers.

sync_events(config, opts \\ [])

@spec sync_events(
  PlaidEx.Config.t(),
  keyword()
) :: {:ok, map()} | {:error, PlaidEx.Error.t()}

Syncs transfer events using cursor-based pagination.