Increase.InboundFednowTransfers (Increase v1.0.0)

Copy Markdown View Source

An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to your account.

See https://increase.com/documentation/api/inbound-fednow-transfers for the full API reference for this resource.

Summary

Functions

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

List Inbound FedNow Transfers

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

Retrieve an Inbound FedNow Transfer

Functions

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

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

List Inbound FedNow Transfers

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

GET /inbound_fednow_transfers

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

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

Retrieve an Inbound FedNow Transfer

GET /inbound_fednow_transfers/{inbound_fednow_transfer_id}