Increase.CheckDeposits (Increase v1.0.0)

Copy Markdown View Source

Check Deposits allow you to deposit images of paper checks into your account.

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

Summary

Functions

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

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

Create a Check Deposit

POST /check_deposits

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

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

List Check Deposits

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

GET /check_deposits

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

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

Retrieve a Check Deposit

GET /check_deposits/{check_deposit_id}