Increase.WireTransfers (Increase v1.0.0)

Copy Markdown View Source

Wire transfers move funds between your Increase account and any other account accessible by Fedwire.

Summary

Functions

approve(client, wire_transfer_id, opts \\ [])

@spec approve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.WireTransfers.WireTransfer.t()} | {:error, Increase.Error.t()}

Approve a Wire Transfer

POST /wire_transfers/{wire_transfer_id}/approve

cancel(client, wire_transfer_id, opts \\ [])

@spec cancel(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.WireTransfers.WireTransfer.t()} | {:error, Increase.Error.t()}

Cancel a pending Wire Transfer

POST /wire_transfers/{wire_transfer_id}/cancel

create(client, params \\ %{}, opts \\ [])

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

Create a Wire Transfer

POST /wire_transfers

list(client, params \\ %{}, opts \\ [])

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

List Wire Transfers

Returns a %Increase.Page{} whose data is a list of %__MODULE__. WireTransfer{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /wire_transfers

retrieve(client, wire_transfer_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.WireTransfers.WireTransfer.t()} | {:error, Increase.Error.t()}

Retrieve a Wire Transfer

GET /wire_transfers/{wire_transfer_id}