Increase.IntrafiAccountEnrollments (Increase v1.0.0)

Copy Markdown View Source

IntraFi is a network of financial institutions that allows Increase users to sweep funds to multiple banks. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn't affect funds availability.

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

Summary

Functions

Enroll an account in the IntraFi deposit sweep network

List IntraFi Account Enrollments

Functions

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

Enroll an account in the IntraFi deposit sweep network

POST /intrafi_account_enrollments

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

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

List IntraFi Account Enrollments

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

GET /intrafi_account_enrollments

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

Get an IntraFi Account Enrollment

GET /intrafi_account_enrollments/{intrafi_account_enrollment_id}

unenroll(client, intrafi_account_enrollment_id, opts \\ [])

Unenroll an account from IntraFi

POST /intrafi_account_enrollments/{intrafi_account_enrollment_id}/unenroll