TreasuryPrime.IncomingWire (TreasuryPrime v1.0.0)

Copy Markdown View Source

Read-only visibility into wires sent to you by a third party (the reverse of TreasuryPrime.Wire, which is for wires you send). Funds from an incoming wire post as a TreasuryPrime.Transaction on the recipient's account. This resource is read-only — there's no way to create, update, or return an incoming wire via the API (wires are irrevocable once sent).

Summary

Functions

Fetches a single incoming wire by id.

Lists incoming wires.

Types

t()

@type t() :: %TreasuryPrime.IncomingWire{
  account_id: String.t() | nil,
  amount: String.t() | nil,
  created_at: String.t() | nil,
  id: String.t() | nil,
  imad: map() | nil,
  instructions: String.t() | nil,
  org_id: String.t() | nil,
  originator_account_number: String.t() | nil,
  originator_bank_name: String.t() | nil,
  originator_name: String.t() | nil,
  updated_at: String.t() | nil,
  userdata: map() | nil
}

Functions

get(client, id)

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

Fetches a single incoming wire by id.

get!(client, id)

@spec get!(TreasuryPrime.Client.t(), String.t()) :: t()

list(client, params \\ %{})

@spec list(TreasuryPrime.Client.t(), map()) ::
  {:ok, TreasuryPrime.Page.t()} | {:error, TreasuryPrime.Error.t()}

Lists incoming wires.

Filterable params

account_id.

list!(client, params \\ %{})