Increase.FednowTransfers (Increase v1.0.0)

FedNow transfers move funds, within seconds, between your Increase account and any other account supporting FedNow.

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

Summary

Functions

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

Approve a FedNow Transfer

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

Cancel a pending FedNow Transfer

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

Create a FedNow Transfer

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

List FedNow Transfers

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

Retrieve a FedNow Transfer

Functions

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

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

Approve a FedNow Transfer

POST /fednow_transfers/{fednow_transfer_id}/approve

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

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

Cancel a pending FedNow Transfer

POST /fednow_transfers/{fednow_transfer_id}/cancel

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

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

Create a FedNow Transfer

POST /fednow_transfers

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

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

List FedNow Transfers

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

GET /fednow_transfers

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

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

Retrieve a FedNow Transfer

GET /fednow_transfers/{fednow_transfer_id}