Increase.IntrafiExclusions (Increase v1.0.0)

Copy Markdown View Source

Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.

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

Summary

Functions

archive(client, intrafi_exclusion_id, opts \\ [])

Archive an IntraFi Exclusion

POST /intrafi_exclusions/{intrafi_exclusion_id}/archive

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

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

Create an IntraFi Exclusion

POST /intrafi_exclusions

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

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

List IntraFi Exclusions

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

GET /intrafi_exclusions

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

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

Get an IntraFi Exclusion

GET /intrafi_exclusions/{intrafi_exclusion_id}